com.knowgate.mail

Class MailSessionHandler

java.lang.Object

com.knowgate.mail.MailSessionHandler

public class MailSessionHandler
extends Object

A wrapper around javax.mail.Store and javax.mail.Transport

Version:

8.0

Author:

Sergio Montoro Ten

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bIncomingSSL
protected boolean	bIsStoreConnected
protected boolean	bIsTransportConnected
protected boolean	bOutgoingSSL
protected int	iOutPortNum
protected javax.mail.Session	oMailSession
protected javax.mail.Store	oMailStore
protected javax.mail.Transport	oMailTransport
protected Map<String,String>	oProps
protected javax.mail.Session	oSmtpSession
protected javax.mail.URLName	oURLSession
protected String	sInAccountName
protected String	sInAuthStr
protected String	sInHostName
protected String	sMBoxDir
protected String	sOutAccountName
protected String	sOutAuthStr
protected String	sOutHostName

Constructor Summary

Constructors

Constructor and Description
MailSessionHandler() Default constructor
MailSessionHandler(Map<String,String> oMailProperties) Create session using given Properties

Method Summary

Modifier and Type	Method and Description
boolean	checkPorts() Checks to see if ports are available.
void	close()
String	getAccountName() Get column incoming_account of k_user_mail
String	getAuthStr() Get column incoming_password of k_user_mail
javax.mail.Folder	getFolder(String sFolderName) Get folder from current mail store
String	getHostName() Get column incoming_server of k_user_mail
String	getMBoxDirectory()
Map<String,String>	getProperties()
javax.mail.Session	getSession() Get incoming mail server Session
javax.mail.Session	getSmtpSession() Get outgoing mail server Session
javax.mail.Store	getStore() Get Store
javax.mail.Transport	getTransport() Get Transport
boolean	isStoreConnected()
boolean	isTransportConnected()
MailHeadersHelper[]	listFolderMailMessagesHeaders(String sFolderName) Get a list of headers for all folder messages which are not deleted
String[]	listFolderMessages(String sFolderName) Get a list of all folder messages which are not deleted
String[]	listRecentMessages(String sFolderName, int iMaxMsgs) Get a list of most recent folder messages which are not deleted, answered or marked as spam
void	sendMessage(javax.mail.Message oMsg)
void	sendMessage(javax.mail.Message oMsg, javax.mail.Address[] aAddrs)
void	sendMessage(javax.mail.Message oMsg, javax.mail.Address[] aAdrFrom, javax.mail.Address[] aAdrReply, javax.mail.Address[] aAdrTo, javax.mail.Address[] aAdrCc, javax.mail.Address[] aAdrBcc)
int	sendMessage(String sSubject, String sFromPersonal, String sFromAddr, String sReplyAddr, String[] aRecipients, javax.mail.Message.RecipientType[] aRecType, String sTextBody, String sHtmlBody, String sEncoding, String sId, String[] aAttachmentsPath, String sUserDir, boolean bInlineImages, PrintStream oOut) Send e-mail message
int	sendMessage(String sSubject, String sFromPersonal, String sFromAddr, String sReplyAddr, String[] aRecipients, javax.mail.Message.RecipientType[] aRecType, String sTextBody, String sHtmlBody, String sEncoding, String sId, String[] aAttachmentsPath, String sUserDir, PrintStream oOut) Send e-mail message
int	sendMessage(String sSubject, String sFromPersonal, String sFromAddr, String sReplyAddr, String[] aRecipients, javax.mail.Message.RecipientType oRecType, String sTextBody, String sHtmlBody, String sEncoding, String sId, String[] aAttachmentsPath, String sUserDir, PrintStream oOut)
void	setAccountName(String aAccName) Set incoming mail account name
void	setAuthStr(String aAutStr) Set incoming mail password
void	setHostName(String sName) Set incoming mail host name or IP address
void	setMBoxDirectory(String sDir)
void	setProperties(Map<String,String> oPropties)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sInAccountName

protected String sInAccountName

sInAuthStr

protected String sInAuthStr

sOutAccountName

protected String sOutAccountName

sOutAuthStr

protected String sOutAuthStr

sInHostName

protected String sInHostName

sOutHostName

protected String sOutHostName

iOutPortNum

protected int iOutPortNum

sMBoxDir

protected String sMBoxDir

oProps

protected Map<String,String> oProps

oURLSession

protected javax.mail.URLName oURLSession

oMailSession

protected javax.mail.Session oMailSession

oSmtpSession

protected javax.mail.Session oSmtpSession

oMailStore

protected javax.mail.Store oMailStore

oMailTransport

protected javax.mail.Transport oMailTransport

bIsStoreConnected

protected boolean bIsStoreConnected

bIsTransportConnected

protected boolean bIsTransportConnected

bIncomingSSL

protected boolean bIncomingSSL

bOutgoingSSL

protected boolean bOutgoingSSL

Constructor Detail

MailSessionHandler

public MailSessionHandler()

Default constructor

MailSessionHandler

public MailSessionHandler(Map<String,String> oMailProperties)
                   throws NullPointerException

Create session using given Properties

Parameters:

oMailProperties - Properties
Store and transport password

Property	Description>	Default value
mail.user	Store and transport user
mail.password
mail.store.protocol		pop3
mail.transport.protocol		smtp
mail.storeprotocol.host	For example: pop.mailserver.com
mail.storeprotocol.socketFactory.class	Only if using SSL set this value to javax.net.ssl.SSLSocketFactory
mail.storeprotocol.socketFactory.port	Only if using SSL
mail.transportprotocol.host	For example: smtp.mailserver.com
mail.transportprotocol.port	For example: 587
mail.transportprotocol.socketFactory.class	Only if using SSL set this value to javax.net.ssl.SSLSocketFactory
mail.transportprotocol.socketFactory.port	Only if using SSL
proxySet	Use proxy	false
socksProxyHost	Proxy IP address
socksProxyPort	Proxy Port
mail.smtp.debug	JavaMail Debug Mode	true or false (default)

Throws:

NullPointerException - if oMailProperties is null

Since:

3.1

Method Detail

getAccountName

public String getAccountName()

Get column incoming_account of k_user_mail

Returns:

String account name or null if this instance has not been initialized from a MailAccount object

setAccountName

public void setAccountName(String aAccName)

Set incoming mail account name

getAuthStr

public String getAuthStr()

Get column incoming_password of k_user_mail

Returns:

String password or null if this instance has not been initialized from a MailAccount object

setAuthStr

public void setAuthStr(String aAutStr)

Set incoming mail password

getHostName

public String getHostName()

Get column incoming_server of k_user_mail

Returns:

String

setHostName

public void setHostName(String sName)

Set incoming mail host name or IP address

getMBoxDirectory

public String getMBoxDirectory()

setMBoxDirectory

public void setMBoxDirectory(String sDir)

getProperties

public Map<String,String> getProperties()

setProperties

public void setProperties(Map<String,String> oPropties)

getSession

public javax.mail.Session getSession()
                              throws IllegalStateException

Get incoming mail server Session

This method calls JavaMail Session.getInstance() method if neccesary, using properties currently set at this instance and SilentAuthenticator as Authenticator subclass

Returns:

javax.mail.Session

Throws:

IllegalStateException

NullPointerException

getSmtpSession

public javax.mail.Session getSmtpSession()
                                  throws IllegalStateException

Get outgoing mail server Session

This method calls JavaMail Session.getInstance() method if neccesary, using properties currently set at this instance and SilentAuthenticator as Authenticator subclass

Returns:

javax.mail.Session

Throws:

IllegalStateException

NullPointerException

getStore

public javax.mail.Store getStore()
                          throws javax.mail.NoSuchProviderException,
                                 javax.mail.MessagingException

Get Store

This method calls Session.getStore() and Store.connect() if neccesary.

Returns:

javax.mail.Store

Throws:

javax.mail.NoSuchProviderException

javax.mail.MessagingException

getTransport

public javax.mail.Transport getTransport()
                                  throws javax.mail.NoSuchProviderException,
                                         javax.mail.MessagingException

Get Transport

This method calls Session.getTransport() and Transport.connect() if neccesary

Returns:

javax.mail.Transport

Throws:

javax.mail.NoSuchProviderException

javax.mail.MessagingException

getFolder

public javax.mail.Folder getFolder(String sFolderName)
                            throws javax.mail.NoSuchProviderException,
                                   javax.mail.MessagingException

Get folder from current mail store

Returns:

javax.mail.Folder

Throws:

javax.mail.NoSuchProviderException

javax.mail.MessagingException

isStoreConnected

public boolean isStoreConnected()

isTransportConnected

public boolean isTransportConnected()

sendMessage

public void sendMessage(javax.mail.Message oMsg)
                 throws javax.mail.NoSuchProviderException,
                        javax.mail.SendFailedException,
                        javax.mail.internet.ParseException,
                        javax.mail.MessagingException,
                        NullPointerException,
                        IllegalStateException

Throws:

javax.mail.NoSuchProviderException

javax.mail.SendFailedException

javax.mail.internet.ParseException

javax.mail.MessagingException

NullPointerException

IllegalStateException

listFolderMessages

public String[] listFolderMessages(String sFolderName)
                            throws javax.mail.AuthenticationFailedException,
                                   javax.mail.NoSuchProviderException,
                                   javax.mail.MessagingException

Get a list of all folder messages which are not deleted

Messages are returned in ascending date order, oldest messages are returned first

Parameters:

sFolderName - Folder Name, for example: "INBOX"

Returns:

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:

javax.mail.AuthenticationFailedException

javax.mail.NoSuchProviderException

javax.mail.MessagingException

Since:

4.0

listFolderMailMessagesHeaders

public MailHeadersHelper[] listFolderMailMessagesHeaders(String sFolderName)
                                                  throws javax.mail.AuthenticationFailedException,
                                                         javax.mail.NoSuchProviderException,
                                                         javax.mail.MessagingException

Get a list of headers for all folder messages which are not deleted

Messages are returned in ascending date order, oldest messages are returned first

Parameters:

sFolderName - Folder Name, for example: "INBOX"

Returns:

An array of HeadersHelper objetcs

Throws:

javax.mail.AuthenticationFailedException

javax.mail.NoSuchProviderException

javax.mail.MessagingException

Since:

7.0

listRecentMessages

public String[] listRecentMessages(String sFolderName,
                                   int iMaxMsgs)
                            throws javax.mail.AuthenticationFailedException,
                                   javax.mail.NoSuchProviderException,
                                   javax.mail.MessagingException,
                                   IllegalArgumentException

Get a list of most recent folder messages which are not deleted, answered or marked as spam

Messages are returned in descending date order, most recent messages are returned first

Parameters:

sFolderName - Folder Name, for example: "INBOX"

iMaxMsgs - Maximum number of messages to get [1..2^31-1]

Returns:

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:

javax.mail.AuthenticationFailedException

javax.mail.NoSuchProviderException

javax.mail.MessagingException

IllegalArgumentException

Since:

4.0

sendMessage

public void sendMessage(javax.mail.Message oMsg,
                        javax.mail.Address[] aAddrs)
                 throws javax.mail.NoSuchProviderException,
                        javax.mail.SendFailedException,
                        javax.mail.internet.ParseException,
                        javax.mail.MessagingException,
                        NullPointerException

Throws:

javax.mail.NoSuchProviderException

javax.mail.SendFailedException

javax.mail.internet.ParseException

javax.mail.MessagingException

NullPointerException

sendMessage

public void sendMessage(javax.mail.Message oMsg,
                        javax.mail.Address[] aAdrFrom,
                        javax.mail.Address[] aAdrReply,
                        javax.mail.Address[] aAdrTo,
                        javax.mail.Address[] aAdrCc,
                        javax.mail.Address[] aAdrBcc)
                 throws javax.mail.NoSuchProviderException,
                        javax.mail.SendFailedException,
                        javax.mail.internet.ParseException,
                        javax.mail.MessagingException,
                        NullPointerException

Throws:

javax.mail.NoSuchProviderException

javax.mail.SendFailedException

javax.mail.internet.ParseException

javax.mail.MessagingException

NullPointerException

close

public void close()
           throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

sendMessage

public int sendMessage(String sSubject,
                       String sFromPersonal,
                       String sFromAddr,
                       String sReplyAddr,
                       String[] aRecipients,
                       javax.mail.Message.RecipientType[] aRecType,
                       String sTextBody,
                       String sHtmlBody,
                       String sEncoding,
                       String sId,
                       String[] aAttachmentsPath,
                       String sUserDir,
                       boolean bInlineImages,
                       PrintStream oOut)
                throws NullPointerException,
                       IOException,
                       javax.mail.MessagingException,
                       IllegalArgumentException,
                       SecurityException

Send e-mail message

Parameters:

sSubject - String e-mail Subject

sFromPersonal - String Sender display name

sFromAddr - String Sender e-mail address

sReplyAddr - String Reply-To e-mail address

aRecipients - Array of recipients e-mail addresses

aRecType - Array of types for each recipient {to, cc, bcc}

sTextBody - String Plain Text Message Body

sHtmlBody - String HTML Text Message Body

sEncoding - Character Encoding to be used

sId - String Message Unique Id. Optional, may be null.

aAttachmentsPath - Array of relative paths to files to be attached

sUserDir - Base path for attached files

bInlineImages - true is images will be inlined as attachments, false if they will be downloaded upon message opening

oOut - PrintStream Output stream for messages verbose

Throws:

NullPointerException

IOException

javax.mail.MessagingException

IllegalArgumentException

SecurityException

Since:

8.0

sendMessage

public int sendMessage(String sSubject,
                       String sFromPersonal,
                       String sFromAddr,
                       String sReplyAddr,
                       String[] aRecipients,
                       javax.mail.Message.RecipientType[] aRecType,
                       String sTextBody,
                       String sHtmlBody,
                       String sEncoding,
                       String sId,
                       String[] aAttachmentsPath,
                       String sUserDir,
                       PrintStream oOut)
                throws NullPointerException,
                       IOException,
                       javax.mail.MessagingException,
                       IllegalArgumentException,
                       SecurityException

Send e-mail message

Parameters:

sSubject - String e-mail Subject

sFromPersonal - String Sender display name

sFromAddr - String Sender e-mail address

sReplyAddr - String Reply-To e-mail address

aRecipients - Array of recipients e-mail addresses

aRecType - Array of types for each recipient {to, cc, bcc}

sTextBody - String Plain Text Message Body

sHtmlBody - String HTML Text Message Body

sEncoding - Character Encoding to be used

sId - String Message Unique Id. Optional, may be null.

aAttachmentsPath - Array of relative paths to files to be attached

sUserDir - Base path for attached files

oOut - PrintStream Output stream for messages verbose

Throws:

NullPointerException

IOException

javax.mail.MessagingException

IllegalArgumentException

SecurityException

sendMessage

public int sendMessage(String sSubject,
                       String sFromPersonal,
                       String sFromAddr,
                       String sReplyAddr,
                       String[] aRecipients,
                       javax.mail.Message.RecipientType oRecType,
                       String sTextBody,
                       String sHtmlBody,
                       String sEncoding,
                       String sId,
                       String[] aAttachmentsPath,
                       String sUserDir,
                       PrintStream oOut)
                throws NullPointerException,
                       IOException,
                       javax.mail.MessagingException,
                       IllegalArgumentException,
                       SecurityException

Throws:

NullPointerException

IOException

javax.mail.MessagingException

IllegalArgumentException

SecurityException

checkPorts

public boolean checkPorts()

Checks to see if ports are available.