toolbox.mail
Interface MailManager

All Known Implementing Classes:

MailManagerImpl

public interface MailManager

Interface defining a generic mail manager to manage the various Toolbox Mail API components.

Method Summary

void	destroy() Destroy this manager.
javax.mail.Session	getSession() Return a JavaMail Session instance.
SMTPMailer	getSMTPMailer() Return a SMTPMailer instance.
void	init(java.lang.String name, XMLProperties xmlProps) Initialise this manager instance.

Method Detail

init

void init(java.lang.String name,
          XMLProperties xmlProps)
          throws MailException

Initialise this manager instance.

Parameters:

name - String containing a name to identify this manager.

xmlProps - XML configuration properties.

Throws:

MailException - if the manager cannot be initialised.

getSMTPMailer

SMTPMailer getSMTPMailer()
                         throws MailException

Return a SMTPMailer instance.

Returns:

SMTPMailer instance.

Throws:

MailException

getSession

javax.mail.Session getSession()
                              throws MailException

Return a JavaMail Session instance.

Returns:

Session instance.

Throws:

MailException

destroy

void destroy()
             throws MailException

Destroy this manager.

Throws:

MailException