/*
Copyright (C) 2005 Know Gate S.L. All rights reserved.
C/Oña, 107 1ยบ2 28050 Madrid (Spain)
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. The end-user documentation included with the redistribution,
if any, must include the following acknowledgment:
"This product includes software parts from hipergate
(http://www.hipergate.org/)."
Alternately, this acknowledgment may appear in the software itself,
if and wherever such third-party acknowledgments normally appear.
3. The name hipergate must not be used to endorse or promote products
derived from this software without prior written permission.
Products derived from this software may not be called hipergate,
nor may hipergate appear in their name, without prior written
permission.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
You should have received a copy of hipergate License with this code;
if not, visit http://www.hipergate.org or mail to info@hipergate.org
*/
package com.knowgate.hipermail;
import java.util.Arrays;
import java.util.LinkedList;
import java.util.HashMap;
import java.util.Properties;
import java.util.Iterator;
import java.io.File;
import java.io.IOException;
import java.io.PrintStream;
import java.net.URL;
import java.nio.charset.Charset;
import java.security.Security;
import javax.activation.DataHandler;
import javax.activation.FileDataSource;
import javax.mail.BodyPart;
import javax.mail.AuthenticationFailedException;
import javax.mail.NoSuchProviderException;
import javax.mail.MessagingException;
import javax.mail.SendFailedException;
import javax.mail.URLName;
import javax.mail.Session;
import javax.mail.Address;
import javax.mail.Message;
import javax.mail.Message.RecipientType;
import javax.mail.Store;
import javax.mail.Transport;
import javax.mail.Folder;
import javax.mail.Flags;
import javax.mail.FetchProfile;
import javax.mail.FetchProfile.Item;
import javax.mail.internet.MimeBodyPart;
import javax.mail.internet.MimeMessage;
import javax.mail.internet.MimeMultipart;
import javax.mail.internet.ParseException;
import javax.mail.internet.InternetAddress;
import org.apache.oro.text.regex.MalformedPatternException;
import org.apache.oro.text.regex.Pattern;
import org.apache.oro.text.regex.PatternCompiler;
import org.apache.oro.text.regex.PatternMatcher;
import org.apache.oro.text.regex.Perl5Compiler;
import org.apache.oro.text.regex.Perl5Matcher;
import org.apache.oro.text.regex.StringSubstitution;
import org.apache.oro.text.regex.Util;
import org.htmlparser.Parser;
import org.htmlparser.beans.StringBean;
import org.htmlparser.filters.TagNameFilter;
import org.htmlparser.tags.ImageTag;
import org.htmlparser.util.NodeIterator;
import org.htmlparser.util.NodeList;
import org.htmlparser.util.ParserException;
import com.sun.mail.smtp.SMTPMessage;
import com.sun.net.ssl.internal.ssl.Provider;
import com.knowgate.debug.Chronometer;
import com.knowgate.debug.DebugFile;
import com.knowgate.dfs.ByteArrayDataSource;
import com.knowgate.dfs.FileSystem;
import com.knowgate.dataobjs.DB;
import com.knowgate.misc.Gadgets;
import com.knowgate.misc.Hosts;
import com.knowgate.dataxslt.FastStreamReplacer;
/**
* <p>A wrapper around javax.mail.Store and javax.mail.Transport</p>
* @author Sergio Montoro Ten
* @version 1.0
*/
public class SessionHandler {
private String sInAccountName;
private String sInAuthStr;
private String sOutAccountName;
private String sOutAuthStr;
private String sInHostName;
private String sOutHostName;
private String sMBoxDir;
private Properties oProps;
private URLName oURLSession;
private Session oMailSession;
private Session oSmtpSession;
private Store oMailStore;
private Transport oMailTransport;
private boolean bIsStoreConnected;
private boolean bIsTransportConnected;
private boolean bIncomingSSL;
private boolean bOutgoingSSL;
// ---------------------------------------------------------------------------
/**
* Default constructor
*/
public SessionHandler() {
bIsStoreConnected = bIsTransportConnected = false;
oMailTransport = null;
oMailStore = null;
oProps = null;
sOutAccountName = sOutAuthStr = sInAccountName = sInAuthStr = sInHostName = sOutHostName = sMBoxDir = null;
oMailSession = null;
bOutgoingSSL = bIncomingSSL=false;
}
/**
* Create session using given Properties
* @param oMailProperties Properties<br>
* <table><tr><th>Property</th><th>Description></th><th>Default value</th></tr>
* <tr><td>mail.user</td><td>Store and transport user</td><td></td></tr>
* <tr><td>mail.password</td><td></td>Store and transport password<td></td></tr>
* <tr><td>mail.store.protocol</td><td></td><td>pop3</td></tr>
* <tr><td>mail.transport.protocol</td><td></td><td>smtp</td></tr>
* <tr><td>mail.<i>storeprotocol</i>.host</td><td>For example: pop.mailserver.com</td><td></td></tr>
* <tr><td>mail.<i>storeprotocol</i>.socketFactory.class</td><td>Only if using SSL set this value to javax.net.ssl.SSLSocketFactory</td><td></td></tr>
* <tr><td>mail.<i>storeprotocol</i>.socketFactory.port</td><td>Only if using SSL</td><td></td></tr>
* <tr><td>mail.<i>transportprotocol</i>.host</td><td>For example: smtp.mailserver.com</td><td></td></tr>
* <tr><td>mail.<i>transportprotocol</i>.socketFactory.class</td><td>Only if using SSL set this value to javax.net.ssl.SSLSocketFactory</td><td></td></tr>
* <tr><td>mail.<i>transportprotocol</i>.socketFactory.port</td><td>Only if using SSL</td><td></td></tr>
* <tr><td>proxySet</td><td>Use proxy</td><td>false</td></tr>
* <tr><td>socksProxyHost</td><td>Proxy IP address</td><td></td></tr>
* <tr><td>socksProxyPort</td><td>Proxy Port</td><td></td></tr>
* </table>
* @throws NullPointerException if oMailProperties is null
* @since 3.1
*/
public SessionHandler(Properties oMailProperties)
throws NullPointerException {
oProps = oMailProperties;
sOutAccountName = sInAccountName = oProps.getProperty("mail.user");
sOutAuthStr = sInAuthStr = oProps.getProperty("mail.password");
bIsStoreConnected = bIsTransportConnected = false;
oMailTransport = null;
oMailStore = null;
sMBoxDir = null;
oMailSession = null;
String sStoreProtocol = oProps.getProperty("mail.store.protocol", "pop3");
sInHostName = oProps.getProperty("mail."+sStoreProtocol+".host");
bIncomingSSL = oProps.getProperty("mail."+sStoreProtocol+".socketFactory.class", "").equals("javax.net.ssl.SSLSocketFactory");
if (sInAuthStr!=null) {
oProps.put("mail."+sStoreProtocol+".auth", "true");
}
if (bIncomingSSL) {
oProps.setProperty("mail."+sStoreProtocol+".socketFactory.port", oMailProperties.getProperty("mail."+sStoreProtocol+".port"));
oProps.setProperty("mail."+sStoreProtocol+".socketFactory.fallback", "false");
}
String sTransportProtocol = oProps.getProperty("mail.transport.protocol", "smtp");
sOutHostName = oProps.getProperty("mail."+sTransportProtocol+".host");
bOutgoingSSL = oProps.getProperty("mail."+sTransportProtocol+".socketFactory.class", "").equals("javax.net.ssl.SSLSocketFactory");
if (sOutAuthStr!=null) {
oProps.put("mail."+sTransportProtocol+".auth", "true");
}
if (bOutgoingSSL) {
oProps.setProperty("mail."+sTransportProtocol+".socketFactory.port", oMailProperties.getProperty("mail."+sTransportProtocol+".port"));
oProps.setProperty("mail."+sTransportProtocol+".socketFactory.fallback", "false");
oProps.put("mail."+sTransportProtocol+".starttls.enable","true");
}
if (bIncomingSSL || bOutgoingSSL) {
Security.addProvider(new Provider());
}
}
// ---------------------------------------------------------------------------
/**
* <p>Create instance taking data from a MailAccount</p>
* The data of MailAccount stored at k_user_mail table is used for initializing
* the connection properties
* @param oAccount MailAccount
*/
public SessionHandler(MailAccount oAccount) {
String sProtocol;
oMailStore = null;
oMailTransport = null;
bIsStoreConnected = bIsTransportConnected = false;
sInAccountName=oAccount.getStringNull(DB.incoming_account,null);
sInAuthStr=oAccount.getStringNull(DB.incoming_password,null);
sOutAccountName=oAccount.getStringNull(DB.outgoing_account,null);
sOutAuthStr=oAccount.getStringNull(DB.outgoing_password,null);
sInHostName=oAccount.getStringNull(DB.incoming_server,null);
sOutHostName=oAccount.getStringNull(DB.outgoing_server,null);
if (!oAccount.isNull(DB.incoming_ssl))
bIncomingSSL = (oAccount.getShort(DB.incoming_ssl)==(short)1);
if (!oAccount.isNull(DB.outgoing_ssl))
bOutgoingSSL = (oAccount.getShort(DB.outgoing_ssl)==(short)1);
oProps = new Properties();
sProtocol = oAccount.getStringNull(DB.incoming_protocol,"pop3");
oProps.put("mail.store.protocol", sProtocol);
oProps.put("mail."+sProtocol+".host", oAccount.getStringNull(DB.incoming_server,"localhost"));
if (oAccount.isNull(DB.incoming_port))
oProps.put("mail."+sProtocol+".port", (bIncomingSSL ? "995" : "110"));
else
oProps.put("mail."+sProtocol+".port", String.valueOf(oAccount.getShort(DB.incoming_port)));
if (bIncomingSSL) {
oProps.setProperty( "mail."+sProtocol+".socketFactory.class", "javax.net.ssl.SSLSocketFactory");
oProps.setProperty("mail."+sProtocol+".socketFactory.port", oProps.getProperty("mail."+sProtocol+".port"));
oProps.setProperty("mail."+sProtocol+".socketFactory.fallback", "false");
}
sProtocol = oAccount.getStringNull(DB.outgoing_protocol,"smtp");
oProps.put("mail.transport.protocol", sProtocol);
oProps.put("mail."+sProtocol+".host", oAccount.getStringNull(DB.outgoing_server,"localhost"));
if (oAccount.isNull(DB.outgoing_port))
oProps.put("mail."+sProtocol+".port", (bOutgoingSSL ? "465" : "25"));
else
oProps.put("mail."+sProtocol+".port", String.valueOf(oAccount.getShort(DB.outgoing_port)));
if (bOutgoingSSL) {
oProps.setProperty("mail."+sProtocol+".socketFactory.class", "javax.net.ssl.SSLSocketFactory");
oProps.setProperty("mail."+sProtocol+".socketFactory.port", oProps.getProperty("mail."+sProtocol+".port"));
oProps.setProperty("mail."+sProtocol+".socketFactory.fallback", "false");
}
if (!oAccount.isNull(DB.outgoing_account) && !oAccount.isNull(DB.outgoing_password)) {
oProps.put("mail."+sProtocol+".auth", "true");
}
if (bIncomingSSL || bOutgoingSSL) {
Security.addProvider(new Provider());
if (bOutgoingSSL)
oProps.put("mail."+oAccount.getStringNull(DB.outgoing_protocol,"smtp")+".starttls.enable","true");
}
if (DebugFile.trace) {
DebugFile.writeln("new SessionHandler(oAccount="+oAccount.getStringNull(DB.gu_account,"null")+")");
DebugFile.incIdent();
Iterator oIter = oProps.keySet().iterator();
while (oIter.hasNext()) {
String sKey = (String) oIter.next();
DebugFile.writeln(sKey+"="+oProps.getProperty(sKey));
} // wend
DebugFile.decIdent();
}
}
// ---------------------------------------------------------------------------
/**
* <p>Create instance taking data from a MailAccount and set local directory for MBOX files</p>
* @param oAccount MailAccount
* @param sMBoxDirectory String
*/
public SessionHandler(MailAccount oAccount, String sMBoxDirectory) {
this(oAccount);
sMBoxDir = sMBoxDirectory;
}
// ---------------------------------------------------------------------------
/**
* <p>Get column incoming_account of k_user_mail</p>
* @return String account name or <b>null</b> if this instance has not been
* initialized from a MailAccount object
*/
public String getAccountName() {
return sInAccountName;
}
// ---------------------------------------------------------------------------
/**
* Set incoming mail account name
*/
public void setAccountName(String aAccName) {
sInAccountName=aAccName;
}
// ---------------------------------------------------------------------------
/**
* <p>Get column incoming_password of k_user_mail</p>
* @return String password or <b>null</b> if this instance has not been
* initialized from a MailAccount object
*/
public String getAuthStr() {
return sInAuthStr;
}
// ---------------------------------------------------------------------------
/**
* Set incoming mail password
*/
public void setAuthStr(String aAutStr) {
sInAuthStr=aAutStr;
}
// ---------------------------------------------------------------------------
/**
* <p>Get column incoming_server of k_user_mail</p>
* @return String
*/
public String getHostName() {
return sInHostName;
}
// ---------------------------------------------------------------------------
/**
* Set incoming mail host name or IP address
*/
public void setHostName(String sName) {
sInHostName=sName;
}
// ---------------------------------------------------------------------------
public String getMBoxDirectory() {
return sMBoxDir;
}
// ---------------------------------------------------------------------------
public void setMBoxDirectory(String sDir) {
sMBoxDir=sDir;
}
// ---------------------------------------------------------------------------
public Properties getProperties() {
return oProps;
}
// ---------------------------------------------------------------------------
public void setProperties(Properties oPropties) {
oProps=oPropties;
}
// ---------------------------------------------------------------------------
/**
* <p>Get incoming mail server Session</p>
* This method calls JavaMail Session.getInstance() method if neccesary,
* using properties currently set at this instance and SilentAuthenticator as
* Authenticator subclass
* @return javax.mail.Session
* @throws IllegalStateException
* @throws NullPointerException
*/
public Session getSession() throws IllegalStateException {
if (DebugFile.trace) {
DebugFile.writeln("Begin SessionHandler.getSession()");
DebugFile.incIdent();
}
if (null==oMailSession) {
if (null==oProps) {
if (DebugFile.trace) DebugFile.decIdent();
throw new IllegalStateException("SessionHandler properties not set");
}
if (null==sInAccountName) {
if (DebugFile.trace) DebugFile.decIdent();
throw new NullPointerException("SessionHandler account name not set");
}
if (DebugFile.trace) DebugFile.writeln("new SilentAuthenticator("+sInAccountName+", ...)");
SilentAuthenticator oAuth = new SilentAuthenticator(sInAccountName, sInAuthStr);
if (DebugFile.trace) DebugFile.writeln("Session.getInstance([Properties],[SilentAuthenticator])");
oMailSession = Session.getInstance(oProps, oAuth);
}
if (DebugFile.trace) {
DebugFile.decIdent();
DebugFile.writeln("End SessionHandler.getSession() : " + oMailSession);
}
return oMailSession;
} // getSession
// ---------------------------------------------------------------------------
/**
* <p>Get outgoing mail server Session</p>
* This method calls JavaMail Session.getInstance() method if neccesary,
* using properties currently set at this instance and SilentAuthenticator as
* Authenticator subclass
* @return javax.mail.Session
* @throws IllegalStateException
* @throws NullPointerException
*/
public Session getSmtpSession() throws IllegalStateException {
if (DebugFile.trace) {
DebugFile.writeln("Begin SessionHandler.getSmtpSession()");
DebugFile.incIdent();
}
if (null==oSmtpSession) {
if (null==oProps) {
if (DebugFile.trace) DebugFile.decIdent();
throw new IllegalStateException("SessionHandler.getSmtpSession() properties not set");
}
if (null==sOutAccountName) {
sOutAccountName = "";
// if (DebugFile.trace) DebugFile.decIdent();
if (DebugFile.trace) DebugFile.writeln("SessionHandler.getSmtpSession() smtp account name not set");
}
if (sOutAccountName.trim().length()==0) {
if (DebugFile.trace) DebugFile.writeln("Session.getInstance([Properties])");
oSmtpSession = Session.getInstance(oProps);
} else {
if (DebugFile.trace) DebugFile.writeln("new SilentAuthenticator("+sOutAccountName+", ...)");
SilentAuthenticator oAuth = new SilentAuthenticator(sOutAccountName, sOutAuthStr);
if (DebugFile.trace) DebugFile.writeln("Session.getInstance([Properties],[SilentAuthenticator])");
oSmtpSession = Session.getInstance(oProps, oAuth);
} // fi
}
if (DebugFile.trace) {
DebugFile.decIdent();
DebugFile.writeln("End SessionHandler.getSmtpSession() : " + oSmtpSession);
}
return oSmtpSession;
} // getSmtpSession
// ---------------------------------------------------------------------------
/**
* <p>Get Store</p>
* This method calls Session.getStore() and Store.connect() if neccesary.
* @return javax.mail.Store
* @throws NoSuchProviderException
* @throws MessagingException
*/
public Store getStore() throws NoSuchProviderException, MessagingException {
if (DebugFile.trace) {
DebugFile.writeln("Begin SessionHandler.getStore()");
DebugFile.incIdent();
}
if (null==oMailStore) {
if (null==sInHostName) {
if (DebugFile.trace) DebugFile.decIdent();
throw new NullPointerException("SessionHandler host name not set");
}
if (DebugFile.trace) DebugFile.writeln("Session.getStore()");
oMailStore = getSession().getStore();
if (DebugFile.trace) DebugFile.writeln("Store.connect("+sInHostName+","+sInAccountName+", ...)");
getStore().connect(sInHostName, sInAccountName, sInAuthStr);
bIsStoreConnected = true;
}
if (DebugFile.trace) {
DebugFile.decIdent();
DebugFile.writeln("End SessionHandler.getStore() : " + oMailStore);
}
return oMailStore;
} // getStore()
// ---------------------------------------------------------------------------
/**
* <p>Get Transport</p>
* This method calls Session.getTransport() and Transport.connect() if neccesary
* @return javax.mail.Transport
* @throws NoSuchProviderException
* @throws MessagingException
*/
public Transport getTransport()
throws NoSuchProviderException,MessagingException {
if (DebugFile.trace) {
DebugFile.writeln("Begin SessionHandler.getTransport()");
DebugFile.incIdent();
}
if (null==oMailTransport) {
if (DebugFile.trace) DebugFile.writeln("Session.getTransport()");
oMailTransport = getSmtpSession().getTransport();
oMailTransport.connect();
}
if (DebugFile.trace) {
DebugFile.decIdent();
DebugFile.writeln("End SessionHandler.getTransport() : " + oMailTransport);
}
return oMailTransport;
} // getTransport
// ---------------------------------------------------------------------------
/**
* Get folder from current mail store
* @return javax.mail.Folder
* @throws NoSuchProviderException
* @throws MessagingException
*/
public Folder getFolder(String sFolderName)
throws NoSuchProviderException,MessagingException {
getStore();
if (null==oMailStore)
return null;
else {
return oMailStore.getFolder(sFolderName);
}
} // getFolder
// ---------------------------------------------------------------------------
public URLName getURL() {
if (null==oURLSession) {
if (DebugFile.trace) DebugFile.writeln("new URLName(jdbc://, "+sInHostName+", -1, "+sMBoxDir+", "+sInAccountName+", ...)");
oURLSession = new URLName("jdbc://", sInHostName, -1, sMBoxDir, sInAccountName, sInAuthStr);
}
return oURLSession;
}
// ---------------------------------------------------------------------------
public boolean isStoreConnected() {
return bIsStoreConnected;
}
// ---------------------------------------------------------------------------
public boolean isTransportConnected() {
return bIsTransportConnected;
}
// ---------------------------------------------------------------------------
public void sendMessage(Message oMsg)
throws NoSuchProviderException,SendFailedException,ParseException,
MessagingException,NullPointerException,IllegalStateException {
if (DebugFile.trace) {
DebugFile.writeln("Begin SessionHandler.sendMessage([Message])");
DebugFile.incIdent();
}
oMsg.setSentDate(new java.util.Date());
if (DebugFile.trace) {
DebugFile.writeln("Transport.send(Message)");
try {
java.io.ByteArrayOutputStream baOut = new java.io.ByteArrayOutputStream();
((javax.mail.internet.MimeMessage) oMsg).saveChanges();
((javax.mail.internet.MimeMessage) oMsg).writeTo(baOut);
DebugFile.writeln(baOut.toString());
baOut.close();
} catch (IOException ioe) { DebugFile.writeln("IOException "+ioe.getMessage()); }
}
Transport.send(oMsg);
if (DebugFile.trace) {
DebugFile.decIdent();
DebugFile.writeln("End SessionHandler.sendMessage()");
}
} // sendMessage
// ---------------------------------------------------------------------------
/**
* <p>Get a list of all folder messages which are not deleted</p>
* Messages are returned in ascending date order, oldest messages are returned first
* @param sFolderName Folder Name, for example: "INBOX"
* @return An array of strings with format
* <msg>
* <num>[1..n]</num>
* <id>message unique identifier</id>
* <type>message content-type</type>
* <disposition>message content-disposition</disposition>
* <len>message length in bytes</len>
* <priority>X-Priority header</priority>
* <spam>X-Spam-Flag header</spam>
* <subject><![CDATA[message subject]]></subject>
* <sent>yyy-mm-dd hh:mi:ss</sent>
* <received>yyy-mm-dd hh:mi:ss</received>
* <from><![CDATA[personal name of sender]]></from>
* <to><![CDATA[personal name or e-mail of receiver]]></to>
* <size>integer size in kilobytes</size>
* <err>error description (if any)</err>
* </msg>
* @throws AuthenticationFailedException
* @throws NoSuchProviderException
* @throws MessagingException
* @since 4.0
*/
public String[] listFolderMessages(String sFolderName)
throws AuthenticationFailedException,NoSuchProviderException,MessagingException {
Chronometer oChMeter = null;
if (DebugFile.trace) {
DebugFile.writeln("Begin SessionHandler.listFolderMessages("+sFolderName+")");
DebugFile.incIdent();
oChMeter = new Chronometer();
}
HeadersHelper oHlpr = new HeadersHelper();
String [] aMsgsXml = null;
Folder oFldr = getFolder(sFolderName);
oFldr.open (Folder.READ_ONLY);
int iDeleted = 0;
int iTotalCount = oFldr.getMessageCount();
if (iTotalCount>0) {
if (DebugFile.trace) DebugFile.writeln("Folder.getMessages("+String.valueOf(iTotalCount)+")");
Message[] aMsgsObj = oFldr.getMessages();
FetchProfile oFtchPrfl = new FetchProfile();
oFtchPrfl.add(FetchProfile.Item.ENVELOPE);
oFtchPrfl.add(FetchProfile.Item.CONTENT_INFO);
oFtchPrfl.add(FetchProfile.Item.FLAGS);
oFtchPrfl.add("X-Priority");
oFtchPrfl.add("X-Spam-Flag");
if (DebugFile.trace) {
DebugFile.writeln("Folder.fetch(Message[], ENVELOPE & CONTENT_INFO & FLAGS)");
oChMeter.start();
}
oFldr.fetch(aMsgsObj, oFtchPrfl);
if (DebugFile.trace) {
DebugFile.writeln(String.valueOf(iTotalCount)+" headers fetched in "+String.valueOf(oChMeter.stop()/1000l)+" seconds");
oChMeter.start();
}
aMsgsXml = new String[iTotalCount];
for (int m=0; m<iTotalCount; m++) {
if (aMsgsObj[m].isSet(Flags.Flag.DELETED)) {
iDeleted++;
} else {
oHlpr.setMessage((MimeMessage) aMsgsObj[m]);
aMsgsXml[m-iDeleted] = oHlpr.toXML();
} // fi
} // next (m)
aMsgsObj = null;
if (iDeleted>0) aMsgsXml = Arrays.copyOfRange(aMsgsXml, 0, iTotalCount-iDeleted);
if (DebugFile.trace) {
DebugFile.writeln(String.valueOf(iTotalCount-iDeleted)+" messages to XML in "+String.valueOf(oChMeter.stop())+" ms");
}
} // fi (iTotalCount>0)
oFldr.close(false);
if (DebugFile.trace) {
DebugFile.decIdent();
if (null==aMsgsXml)
DebugFile.writeln("End SessionHandler.listFolderMessages() : 0");
else
DebugFile.writeln("End SessionHandler.listFolderMessages() : " + String.valueOf(aMsgsXml.length));
}
return aMsgsXml;
} // listFolderMessages
// ---------------------------------------------------------------------------
/**
* <p>Get a list of most recent folder messages which are not deleted, answered or marked as spam</p>
* Messages are returned in descending date order, most recent messages are returned first
* @param sFolderName Folder Name, for example: "INBOX"
* @param iMaxMsgs Maximum number of messages to get [1..2^31-1]
* @return An array of strings with format
* <msg>
* <num>[1..n]</num>
* <id>message unique identifier</id>
* <type>message content type</type>
* <disposition>message content-disposition</disposition>
* <len>message length in bytes</len>
* <priority>X-Priority header</priority>
* <spam></spam>
* <subject><![CDATA[message subject]]></subject>
* <sent>yyy-mm-dd hh:mi:ss</sent>
* <received>yyy-mm-dd hh:mi:ss</received>
* <from><![CDATA[personal name of sender]]></from>
* <to><![CDATA[personal name or e-mail of receiver]]></to>
* <size>integer size in kilobytes</size>
* <err>error description (if any)</err>
* </msg>
* @throws AuthenticationFailedException
* @throws NoSuchProviderException
* @throws MessagingException
* @since 4.0
*/
public String[] listRecentMessages(String sFolderName, int iMaxMsgs)
throws AuthenticationFailedException,NoSuchProviderException,MessagingException,
IllegalArgumentException {
if (iMaxMsgs<0 || iMaxMsgs>2147483647) throw new IllegalArgumentException("SessionHandler.listRecentMessages() Max messages must be between 0 and 2147483647");
if (DebugFile.trace) {
DebugFile.writeln("Begin SessionHandler.listFolderMessages("+sFolderName+","+String.valueOf(iMaxMsgs)+")");
DebugFile.incIdent();
}
HeadersHelper oHlpr = new HeadersHelper();
String [] aMsgsXml = null;
Folder oFldr = getFolder(sFolderName);
oFldr.open (Folder.READ_ONLY);
int iTotalCount = oFldr.getMessageCount();
if (DebugFile.trace) DebugFile.writeln(String.valueOf(iTotalCount)+" messages found at "+sFolderName);
if (iTotalCount>0) {
LinkedList<String> oList = new LinkedList<String>();
int iLowerBound = iTotalCount-iMaxMsgs;
if (iLowerBound<0) iLowerBound = 0;
for (int m=iTotalCount-1; m>=iLowerBound && oList.size()<iMaxMsgs; m--) {
if (DebugFile.trace) DebugFile.writeln("getting message "+String.valueOf(m));
try {
Message oMsgObj = oFldr.getMessage(m);
if (!oMsgObj.isSet(Flags.Flag.DELETED) && !oMsgObj.isSet(Flags.Flag.ANSWERED)) {
String sSpamFlag = ((MimeMessage) oMsgObj).getHeader("X-Spam-Flag","");
if (sSpamFlag==null) sSpamFlag = "";
if (!sSpamFlag.equalsIgnoreCase("YES")) {
oHlpr.setMessage((MimeMessage) oMsgObj);
String sMsgXML = oHlpr.toXML();
oList.add(sMsgXML);
}
} // fi
} catch (ArrayIndexOutOfBoundsException aiob) {
if (DebugFile.trace) DebugFile.writeln("Folder.getMessage("+String.valueOf(m)+") ArrayIndexOutOfBoundsException");
}
} // next (m)
if (oList.size()>0) {
aMsgsXml = new String [oList.size()];
aMsgsXml = oList.toArray(aMsgsXml);
}
} // fi (iTotalCount>0)
oFldr.close(false);
if (DebugFile.trace) {
DebugFile.decIdent();
if (null==aMsgsXml)
DebugFile.writeln("End SessionHandler.listFolderMessages() : 0");
else
DebugFile.writeln("End SessionHandler.listFolderMessages() : " + String.valueOf(aMsgsXml.length));
}
return aMsgsXml;
} // listFolderMessages
// ---------------------------------------------------------------------------
public void sendMessage(Message oMsg, Address[] aAddrs)
throws NoSuchProviderException,SendFailedException,ParseException,
MessagingException,NullPointerException {
if (DebugFile.trace) {
DebugFile.writeln("Begin SessionHandler.sendMessage([Message],Address[])");
DebugFile.incIdent();
}
oMsg.setSentDate(new java.util.Date());
if (DebugFile.trace) DebugFile.writeln("Transport.send(Message,Address[])");
Transport.send(oMsg,aAddrs);
if (DebugFile.trace) {
DebugFile.decIdent();
DebugFile.writeln("End SessionHandler.sendMessage()");
}
} // sendMessage
// ---------------------------------------------------------------------------
public void sendMessage (Message oMsg,
Address[] aAdrFrom, Address[] aAdrReply,
Address[] aAdrTo, Address[] aAdrCc, Address[] aAdrBcc)
throws NoSuchProviderException,SendFailedException,ParseException,
MessagingException,NullPointerException {
SendFailedException s = null;
if (DebugFile.trace) {
DebugFile.writeln("Begin SessionHandler.sendMessage([Message],Address[],Address[],Address[],Address[],Address[])");
DebugFile.incIdent();
if (aAdrFrom!=null)
for (int f=0; f<aAdrFrom.length; f++) DebugFile.writeln("from "+aAdrFrom[f].toString());
if (aAdrReply!=null)
for (int r=0; r<aAdrReply.length; r++) DebugFile.writeln("reply "+aAdrReply[r].toString());
if (aAdrTo!=null)
for (int t=0; t<aAdrTo.length; t++) DebugFile.writeln("to "+aAdrTo[t].toString());
if (aAdrCc!=null)
for (int c=0; c<aAdrCc.length; c++) DebugFile.writeln("cc "+aAdrCc[c].toString());
if (aAdrBcc!=null)
for (int b=0; b<aAdrBcc.length; b++) DebugFile.writeln("bcc "+aAdrBcc[b].toString());
}
oMsg.addFrom(aAdrFrom);
if (null==aAdrReply)
oMsg.setReplyTo(aAdrReply);
else
oMsg.setReplyTo(aAdrFrom);
if (aAdrTo!=null) oMsg.addRecipients(javax.mail.Message.RecipientType.TO, aAdrTo);
if (aAdrCc!=null) oMsg.addRecipients(javax.mail.Message.RecipientType.CC, aAdrCc);
if (aAdrBcc!=null) oMsg.addRecipients(javax.mail.Message.RecipientType.BCC, aAdrBcc);
oMsg.setSentDate(new java.util.Date());
if (DebugFile.trace) DebugFile.writeln("Transport.send(Message)");
Transport.send(oMsg);
if (DebugFile.trace) {
DebugFile.decIdent();
DebugFile.writeln("End SessionHandler.sendMessage()");
}
} // sendMessage
// ---------------------------------------------------------------------------
public void close()
throws MessagingException {
if (DebugFile.trace) {
DebugFile.writeln("Begin SessionHandler.close()");
DebugFile.incIdent();
}
if (null!=oMailStore) {
if (isStoreConnected()) {
if (DebugFile.trace) DebugFile.writeln("Store.close()");
oMailStore.close();
}
oMailStore = null;
}
if (null!=oMailTransport) {
if (isTransportConnected()) {
if (DebugFile.trace) DebugFile.writeln("Transport.close()");
oMailTransport.close();
}
oMailTransport=null;
}
oMailSession=null;
oSmtpSession=null;
if (DebugFile.trace) {
DebugFile.decIdent();
DebugFile.writeln("End SessionHandler.close()");
}
} // close
// ---------------------------------------------------------------------------
private SMTPMessage composeMessage(String sSubject, String sEncoding,
String sTextBody, String sHtmlBody,
String sId, String [] aAttachmentsPath,
String sBasePath)
throws IOException,MessagingException,IllegalArgumentException,SecurityException {
PatternCompiler oCompiler = new Perl5Compiler();
PatternMatcher oMatcher = new Perl5Matcher();
String sContentType = (sHtmlBody==null ? "plain" : "html");
if (DebugFile.trace) {
DebugFile.writeln("Begin SessionHandler.composeMessage("+sSubject+","+sEncoding+",...,"+sId+","+sContentType+")");
DebugFile.incIdent();
}
if (sEncoding==null) sEncoding = "ASCII";
String sCharEnc = Charset.forName(sEncoding).name();
SMTPMessage oSentMessage = new SMTPMessage(getSmtpSession());
MimeBodyPart oMsgPlainText = new MimeBodyPart();
MimeMultipart oSentMsgParts = new MimeMultipart("mixed");
if (sContentType.equalsIgnoreCase("html")) {
MimeMultipart oHtmlRelated = new MimeMultipart("related");
MimeMultipart oTextHtmlAlt = new MimeMultipart("alternative");
// ************************************************************************
// Replace image CIDs
HashMap oDocumentImages = new HashMap(23);
StringSubstitution oSrcSubs = new StringSubstitution();
Parser oPrsr = Parser.createParser(sHtmlBody, sEncoding);
String sCid, sSrc;
try {
if (sTextBody==null) {
// ****************************
// Extract plain text from HTML
if (DebugFile.trace) DebugFile.writeln("new StringBean()");
StringBean oStrBn = new StringBean();
try {
oPrsr.visitAllNodesWith (oStrBn);
} catch (ParserException pe) {
throw new MessagingException(pe.getMessage(), pe);
}
sTextBody = oStrBn.getStrings();
oStrBn = null;
} // fi (sTextBody==null)
// *******************************
// Set plain text alternative part
oMsgPlainText.setDisposition("inline");
oMsgPlainText.setText(sTextBody, sCharEnc, "plain");
// oMsgPlainText.setContent(sTextBody, "text/plain; charset="+sCharEnc);
if (DebugFile.trace) DebugFile.writeln("MimeBodyPart(multipart/alternative).addBodyPart(text/plain)");
oTextHtmlAlt.addBodyPart(oMsgPlainText);
// *****************************************
// Iterate images from HTML and replace CIDs
NodeList oCollectionList = new NodeList();
TagNameFilter oImgFilter = new TagNameFilter ("IMG");
for (NodeIterator e = oPrsr.elements(); e.hasMoreNodes();)
e.nextNode().collectInto(oCollectionList, oImgFilter);
final int nImgs = oCollectionList.size();
if (DebugFile.trace) DebugFile.writeln("NodeList.size() = " + String.valueOf(nImgs));
for (int i=0; i<nImgs; i++) {
sSrc = ((ImageTag) oCollectionList.elementAt(i)).extractImageLocn();
// Keep a reference to every related image name so that the same image is not included twice in the message
if (!oDocumentImages.containsKey(sSrc)) {
// Find last slash from image url
int iSlash = sSrc.lastIndexOf('/');
// Take image name
if (iSlash>=0) {
while (sSrc.charAt(iSlash)=='/') { if (++iSlash==sSrc.length()) break; }
sCid = sSrc.substring(iSlash);
}
else {
sCid = sSrc;
}
//String sUid = Gadgets.generateUUID();
//sCid = sUid.substring(0,12)+"$"+sUid.substring(12,20)+"$"+sUid.substring(20,28)+"@hipergate.org";
if (DebugFile.trace) DebugFile.writeln("HashMap.put("+sSrc+","+sCid+")");
oDocumentImages.put(sSrc, sCid);
} // fi (!oDocumentImages.containsKey(sSrc))
try {
Pattern oPattern = oCompiler.compile(sSrc, Perl5Compiler.SINGLELINE_MASK);
oSrcSubs.setSubstitution("cid:"+oDocumentImages.get(sSrc));
if (DebugFile.trace) DebugFile.writeln("Util.substitute([PatternMatcher],"+ sSrc + ",cid:"+oDocumentImages.get(sSrc)+",...)");
sHtmlBody = Util.substitute(oMatcher, oPattern, oSrcSubs, sHtmlBody);
} catch (MalformedPatternException neverthrown) { }
} // next
}
catch (ParserException pe) {
if (DebugFile.trace) {
DebugFile.writeln("org.htmlparser.util.ParserException " + pe.getMessage());
}
}
// End replace image CIDs
// ************************************************************************
// ************************************************************************
// Add HTML related images
if (oDocumentImages.isEmpty()) {
// Set HTML part
MimeBodyPart oMsgHtml = new MimeBodyPart();
oMsgHtml.setDisposition("inline");
oMsgHtml.setText(sHtmlBody, sCharEnc, "html");
// oMsgHtml.setContent(sHtmlBody, "text/html; charset="+sCharEnc);
oTextHtmlAlt.addBodyPart(oMsgHtml);
} else {
// Set HTML text related part
MimeBodyPart oMsgHtmlText = new MimeBodyPart();
oMsgHtmlText.setDisposition("inline");
oMsgHtmlText.setText(sHtmlBody, sCharEnc, "html");
// oMsgHtmlText.setContent(sHtmlBody, "text/html; charset="+sCharEnc);
if (DebugFile.trace) DebugFile.writeln("MimeBodyPart(multipart/related).addBodyPart(text/html)");
oHtmlRelated.addBodyPart(oMsgHtmlText);
// Set HTML text related inline images
Iterator oImgs = oDocumentImages.keySet().iterator();
while (oImgs.hasNext()) {
BodyPart oImgBodyPart = new MimeBodyPart();
sSrc = (String) oImgs.next();
sCid = (String) oDocumentImages.get(sSrc);
if (sSrc.startsWith("www."))
sSrc = "http://" + sSrc;
if (sSrc.startsWith("http://") || sSrc.startsWith("https://")) {
oImgBodyPart.setDataHandler(new DataHandler(new URL(Hosts.resolve(sSrc))));
}
else {
oImgBodyPart.setDataHandler(new DataHandler(new FileDataSource((sBasePath==null ? "" : sBasePath)+sSrc)));
}
oImgBodyPart.setDisposition("inline");
oImgBodyPart.setHeader("Content-ID", sCid);
oImgBodyPart.setFileName(sCid);
// Add image to multi-part
if (DebugFile.trace) DebugFile.writeln("MimeBodyPart(multipart/related).addBodyPart("+sCid+")");
oHtmlRelated.addBodyPart(oImgBodyPart);
} // wend
// Set html text alternative part (html text + inline images)
MimeBodyPart oTextHtmlRelated = new MimeBodyPart();
oTextHtmlRelated.setContent(oHtmlRelated);
if (DebugFile.trace) DebugFile.writeln("MimeBodyPart(multipart/alternative).addBodyPart(multipart/related)");
oTextHtmlAlt.addBodyPart(oTextHtmlRelated);
}
// ************************************************************************
// Create message to be sent and add main text body to it
if (aAttachmentsPath==null) {
oSentMessage.setContent(oTextHtmlAlt);
} else {
MimeBodyPart oMixedPart = new MimeBodyPart();
oMixedPart.setContent(oTextHtmlAlt);
oSentMsgParts.addBodyPart(oMixedPart);
}
} else { // (sContentType=="plain")
// *************************************************
// If this is a plain text message just add the text
if (aAttachmentsPath==null) {
oSentMessage.setText(sTextBody, sCharEnc);
} else {
oMsgPlainText.setDisposition("inline");
oMsgPlainText.setText(sTextBody, sCharEnc, "plain");
//oMsgPlainText.setContent(sTextBody, "text/plain; charset="+sCharEnc);
if (DebugFile.trace) DebugFile.writeln("MimeBodyPart(multipart/mixed).addBodyPart(text/plain)");
oSentMsgParts.addBodyPart(oMsgPlainText);
}
}
// fi (sContentType=="html")
// ************************************************************************
// Add attachments to message to be sent
if (aAttachmentsPath!=null) {
final int nAttachments = aAttachmentsPath.length;
FileSystem oFS = new FileSystem();
for (int p=0; p<nAttachments; p++) {
String sFilePath = aAttachmentsPath[p];
if (sBasePath!=null) {
if (!sFilePath.startsWith(sBasePath))
sFilePath = sBasePath + sFilePath;
}
File oFile = new File(sFilePath);
MimeBodyPart oAttachment = new MimeBodyPart();
oAttachment.setDisposition("attachment");
oAttachment.setFileName(oFile.getName());
oAttachment.setHeader("Content-Transfer-Encoding", "base64");
ByteArrayDataSource oDataSrc;
try {
oDataSrc = new ByteArrayDataSource(oFS.readfilebin(sFilePath), "application/octet-stream");
} catch (com.enterprisedt.net.ftp.FTPException ftpe) {
throw new IOException(ftpe.getMessage());
}
oAttachment.setDataHandler(new DataHandler(oDataSrc));
oSentMsgParts.addBodyPart(oAttachment);
} // next
oSentMessage.setContent(oSentMsgParts);
} // fi (iDraftParts>0)
if (null!=sSubject) oSentMessage.setSubject(sSubject);
if (sId!=null)
if (sId.trim().length()>0)
oSentMessage.setContentID(sId);
if (DebugFile.trace) {
DebugFile.decIdent();
DebugFile.writeln("End SessionHandler.composeMessage()");
}
return oSentMessage;
} // composeMessage
// ---------------------------------------------------------------------------
/**
* <p>Send e-mail message</p>
* @param sSubject String e-mail Subject
* @param sFromPersonal String Sender display name
* @param sFromAddr String Sender e-mail address
* @param sReplyAddr String Reply-To e-mail address
* @param aRecipients Array of recipients e-mail addresses
* @param aRecType Array of types for each recipient {to, cc, bcc}
* @param sTextBody String Plain Text Message Body
* @param sHtmlBody String HTML Text Message Body
* @param sEncoding Character Encoding to be used
* @param sId String Message Unique Id. Optional, may be null.
* @param aAttachmentsPath Array of relative paths to files to be attached
* @param sUserDir Base path for attached files
* @param oOut PrintStream Output stream for messages verbose
* @throws NullPointerException
* @throws IOException
* @throws MessagingException
* @throws IllegalArgumentException
* @throws SecurityException
*/
public int sendMessage(String sSubject, String sFromPersonal, String sFromAddr, String sReplyAddr,
String[] aRecipients, RecipientType[] aRecType,
String sTextBody, String sHtmlBody, String sEncoding, String sId,
String [] aAttachmentsPath, String sUserDir, PrintStream oOut )
throws NullPointerException,IOException,MessagingException,IllegalArgumentException,SecurityException {
if (sFromAddr==null) throw new NullPointerException("SessionHandler.sendMessage sender address cannot be null");
if (aRecipients==null) throw new NullPointerException("SessionHandler.sendMessage repients list cannot be null");
if (DebugFile.trace) {
String sRecipientsList = "{"+Gadgets.join(aRecipients, ";")+"}";
String sAttachementsList;
if (aAttachmentsPath==null)
sAttachementsList = "";
else
sAttachementsList = "{"+Gadgets.join(aAttachmentsPath, ";")+"}";
DebugFile.writeln("SessionHandler.sendMessage("+sSubject+","+sFromPersonal+","+sFromAddr+","+sReplyAddr+","+sRecipientsList+",...,...,...,"+sEncoding+","+sId+","+sAttachementsList+","+sUserDir+",[PrintStream])");
DebugFile.incIdent();
}
boolean bHasReplacements = false;
if (null!=sTextBody) bHasReplacements |= (Gadgets.indexOfIgnoreCase(sTextBody, "{#Message.id}")>=0);
if (null!=sHtmlBody) bHasReplacements |= (Gadgets.indexOfIgnoreCase(sHtmlBody, "{#Message.id}")>=0);
final int nRecipients = aRecipients.length;
if (DebugFile.trace) DebugFile.writeln("recipients count is "+String.valueOf(nRecipients));
int nSend = 0;
if (bHasReplacements) {
HashMap oMap = new HashMap(13);
oMap.put("Message.id", sId);
StringBuffer oTextBody = new StringBuffer(sTextBody);
StringBuffer oHtmlBody = new StringBuffer(sHtmlBody);
FastStreamReplacer oRpl = new FastStreamReplacer();
for (int r=0; r<nRecipients; r++) {
String sRecipientAddr = Gadgets.removeChars(aRecipients[r], " \t\r\n");
if (sRecipientAddr.length()>0) {
try {
String sUniqueId = sId+"."+String.valueOf(r+1);
oMap.remove("Message.id");
oMap.put("Message.id", sUniqueId);
SMTPMessage oCurrentMsg = composeMessage(sSubject, sEncoding, oRpl.replace(oTextBody, oMap), oRpl.replace(oHtmlBody, oMap), sUniqueId, aAttachmentsPath, sUserDir);
oCurrentMsg.setFrom(new InternetAddress(sFromAddr, null==sFromPersonal ? sFromAddr : sFromPersonal));
if (null!=sReplyAddr) oCurrentMsg.setReplyTo(new Address[]{new InternetAddress(sReplyAddr)});
if (DebugFile.trace) DebugFile.writeln("SMTPMessage.setRecipient("+aRecType[r]+","+sRecipientAddr+")");
oCurrentMsg.setRecipient(aRecType[r], new InternetAddress(sRecipientAddr));
sendMessage(oCurrentMsg);
oOut.println("OK "+sRecipientAddr);
nSend++;
} catch (Exception xcpt) {
if (oOut==null) {
if (DebugFile.trace) DebugFile.writeln("ERROR "+aRecipients[r]+" "+xcpt.getClass().getName()+" "+xcpt.getMessage());
} else {
oOut.println("ERROR at SessionHandler.sendMessage() "+aRecipients[r]+" "+xcpt.getClass().getName()+" "+xcpt.getMessage());
} // fi (oOut)
}
} // fi (sRecipientAddr!="")
} // next
} else {
for (int r=0; r<nRecipients; r++) {
String sRecipientAddr = Gadgets.removeChars(aRecipients[r], " \t\r\n");
if (sRecipientAddr.length()>0) {
SMTPMessage oMasterMsg = composeMessage(sSubject, sEncoding, sTextBody, sHtmlBody, null, aAttachmentsPath, sUserDir);
oMasterMsg.setFrom(new InternetAddress(sFromAddr, null==sFromPersonal ? sFromAddr : sFromPersonal));
if (null!=sReplyAddr) oMasterMsg.setReplyTo(new Address[]{new InternetAddress(sReplyAddr)});
try {
if (DebugFile.trace) DebugFile.writeln("new SMTPMessage()");
SMTPMessage oCurrentMsg = new SMTPMessage (oMasterMsg);
if (DebugFile.trace) DebugFile.writeln("SMTPMessage.setContentID("+sId+"."+String.valueOf(r+1)+")");
oCurrentMsg.setContentID(sId+"."+String.valueOf(r+1));
if (DebugFile.trace) DebugFile.writeln("SMTPMessage.setRecipient("+aRecType[r]+","+sRecipientAddr+")");
oCurrentMsg.setRecipient(aRecType[r], new InternetAddress(sRecipientAddr));
sendMessage(oCurrentMsg);
oOut.println("OK "+sRecipientAddr);
nSend++;
}
catch (Exception xcpt) {
String sCause = "";
if (xcpt.getCause()!=null)
sCause = " cause "+xcpt.getCause().getClass().getName()+" "+xcpt.getCause().getMessage();
if (oOut==null) {
if (DebugFile.trace) DebugFile.writeln("ERROR "+aRecipients[r]+" "+xcpt.getClass().getName()+" "+xcpt.getMessage()+sCause);
} else {
oOut.println("ERROR "+aRecipients[r]+" "+xcpt.getClass().getName()+" "+xcpt.getMessage()+sCause);
}
}
} // fi (sRecipientAddr!="")
} // next
} // fi
if (nSend==nRecipients) {
oOut.println("Process successfully completed. "+String.valueOf(nSend)+" messages sent");
} else {
oOut.println("Process finished with errors. "+String.valueOf(nSend)+" messages successfully sent, "+String.valueOf(nRecipients-nSend)+" messages failed");
}
if (DebugFile.trace) {
DebugFile.decIdent();
DebugFile.writeln("End SessionHandler.sendMessage() : "+String.valueOf(nSend));
}
return nSend;
} // sendMessage
// -------------------------------------------------------------------
public int sendMessage(String sSubject, String sFromPersonal, String sFromAddr, String sReplyAddr,
String[] aRecipients, RecipientType oRecType,
String sTextBody, String sHtmlBody, String sEncoding, String sId,
String [] aAttachmentsPath, String sUserDir, PrintStream oOut )
throws NullPointerException,IOException,MessagingException,IllegalArgumentException,SecurityException {
if (oRecType==null) oRecType = RecipientType.TO;
RecipientType[] aRecTypes = new RecipientType[aRecipients.length];
Arrays.fill(aRecTypes,oRecType);
return sendMessage(sSubject, sFromPersonal, sFromAddr, sReplyAddr,
aRecipients, aRecTypes,
sTextBody, sHtmlBody, sEncoding, sId,
aAttachmentsPath, sUserDir, oOut);
}
} // SessionHandler