toolbox.mail
Interface SMTPMailer

All Known Implementing Classes:

SMTPMailerImpl

public interface SMTPMailer

Interface defining a generic SMTP based mailer.

Method Summary

void	destroy() Destroy this mailer.
void	init(MailManager manager) Initialise this mailer with the manager that created it.
void	send(java.util.List to, java.util.List cc, java.util.List bcc, java.lang.String from, java.util.List replyTo, java.lang.String subject, java.lang.String body, java.util.List attach, boolean singleMsg) Send an e-mail message to a List of recipients.
void	send(java.util.List to, java.util.List cc, java.util.List bcc, java.lang.String from, java.util.List replyTo, java.lang.String subject, java.lang.String body, java.util.List attach, java.lang.String contentType, boolean singleMsg) Send an e-mail message to a List of recipients.
void	send(java.util.List to, java.lang.String from, java.util.List replyTo, java.lang.String subject, java.lang.String body, java.util.List attach, boolean singleMsg) Send an e-mail message to a List of recipients.
void	send(java.util.List to, java.lang.String from, java.util.List replyTo, java.lang.String subject, java.lang.String body, java.util.List attach, java.lang.String contentType, boolean singleMsg) Send an e-mail message to a List of recipients.
void	send(java.lang.String to, java.lang.String from, java.util.List replyTo, java.lang.String subject, java.lang.String body, java.util.List attach) Send an e-mail message to a single recipient.
void	send(java.lang.String to, java.lang.String from, java.util.List replyTo, java.lang.String subject, java.lang.String body, java.util.List attach, java.lang.String contentType) Send an e-mail message to a single recipient.
void	send(java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String from, java.util.List replyTo, java.lang.String subject, java.lang.String body, java.util.List attach) Send an e-mail message to a single recipient.
void	send(java.lang.String to, java.lang.String cc, java.lang.String bcc, java.lang.String from, java.util.List replyTo, java.lang.String subject, java.lang.String body, java.util.List attach, java.lang.String contentType) Send an e-mail message to a single recipient.

Method Detail

init

void init(MailManager manager)
          throws MailException

Initialise this mailer with the manager that created it.

Parameters:

manager - MailManager that created this mailer.

Throws:

MailException - if the mailer cannot be initialised.

send

void send(java.util.List to,
          java.lang.String from,
          java.util.List replyTo,
          java.lang.String subject,
          java.lang.String body,
          java.util.List attach,
          boolean singleMsg)
          throws MailException

Send an e-mail message to a List of recipients.

Parameters:

to - List of e-mail addresses as String instances.

from - String containing the from e-mail address.

replyTo - List containing the replyTo e-mail address.

subject - String containing the subject line.

body - String containing the message body.

attach - List of URL's indicating the message attachments.

singleMsg - Boolean indicating whether the message must be sent to all recipients in a single delivery or separate deliveries.

Throws:

MailException - if the message cannot be delivered.

send

void send(java.util.List to,
          java.util.List cc,
          java.util.List bcc,
          java.lang.String from,
          java.util.List replyTo,
          java.lang.String subject,
          java.lang.String body,
          java.util.List attach,
          boolean singleMsg)
          throws MailException

Send an e-mail message to a List of recipients.

Parameters:

to - List of e-mail addresses as String instances.

cc - List of e-mail addresses as String instances.

bcc - List of e-mail addresses as String instances.

from - String containing the from e-mail address.

replyTo - List containing the replyTo e-mail address.

subject - String containing the subject line.

body - String containing the message body.

attach - List of URL's indicating the message attachments.

singleMsg - Boolean indicating whether the message must be sent to all recipients in a single delivery or separate deliveries.

Throws:

MailException - if the message cannot be delivered.

send

void send(java.util.List to,
          java.lang.String from,
          java.util.List replyTo,
          java.lang.String subject,
          java.lang.String body,
          java.util.List attach,
          java.lang.String contentType,
          boolean singleMsg)
          throws MailException

Send an e-mail message to a List of recipients.

Parameters:

to - List of e-mail addresses as String instances.

from - String containing the from e-mail address.

replyTo - List containing the replyTo e-mail address.

subject - String containing the subject line.

body - String containing the message body.

attach - List of URL's indicating the message attachments.

contentType - String indicating the content type.

singleMsg - Boolean indicating whether the message must be sent to all recipients in a single delivery or separate deliveries.

Throws:

MailException - if the message cannot be delivered.

send

void send(java.util.List to,
          java.util.List cc,
          java.util.List bcc,
          java.lang.String from,
          java.util.List replyTo,
          java.lang.String subject,
          java.lang.String body,
          java.util.List attach,
          java.lang.String contentType,
          boolean singleMsg)
          throws MailException

Send an e-mail message to a List of recipients.

Parameters:

to - List of e-mail addresses as String instances.

cc - List of e-mail addresses as String instances.

bcc - List of e-mail addresses as String instances.

from - String containing the from e-mail address.

replyTo - List containing the replyTo e-mail address.

subject - String containing the subject line.

body - String containing the message body.

attach - List of URL's indicating the message attachments.

contentType - String indicating the content type.

singleMsg - Boolean indicating whether the message must be sent to all recipients in a single delivery or separate deliveries.

Throws:

MailException - if the message cannot be delivered.

send

void send(java.lang.String to,
          java.lang.String from,
          java.util.List replyTo,
          java.lang.String subject,
          java.lang.String body,
          java.util.List attach)
          throws MailException

Send an e-mail message to a single recipient.

Parameters:

to - String containing the recipient address.

from - String containing the from address.

replyTo - List containing the replyTo e-mail address.

subject - String containing the subject line.

body - String containing the message body.

attach - List of URL's indicating the message attachments.

Throws:

MailException - if the message cannot be delivered.

send

void send(java.lang.String to,
          java.lang.String cc,
          java.lang.String bcc,
          java.lang.String from,
          java.util.List replyTo,
          java.lang.String subject,
          java.lang.String body,
          java.util.List attach)
          throws MailException

Send an e-mail message to a single recipient.

Parameters:

to - String containing the recipient address.

cc - String containing the cc address.

bcc - String containing the bcc address.

from - String containing the from address.

replyTo - List containing the replyTo e-mail address.

subject - String containing the subject line.

body - String containing the message body.

attach - List of URL's indicating the message attachments.

Throws:

MailException - if the message cannot be delivered.

send

void send(java.lang.String to,
          java.lang.String from,
          java.util.List replyTo,
          java.lang.String subject,
          java.lang.String body,
          java.util.List attach,
          java.lang.String contentType)
          throws MailException

Send an e-mail message to a single recipient.

Parameters:

to - String containing the recipient address.

from - String containing the from address.

replyTo - List containing the replyTo e-mail address.

subject - String containing the subject line.

body - String containing the message body.

attach - List of URL's indicating the message attachments.

contentType - String indicating the content type.

Throws:

MailException - if the message cannot be delivered.

send

void send(java.lang.String to,
          java.lang.String cc,
          java.lang.String bcc,
          java.lang.String from,
          java.util.List replyTo,
          java.lang.String subject,
          java.lang.String body,
          java.util.List attach,
          java.lang.String contentType)
          throws MailException

Send an e-mail message to a single recipient.

Parameters:

to - String containing the recipient address.

cc - String containing the cc address.

bcc - String containing the bcc address.

from - String containing the from address.

replyTo - List containing the replyTo e-mail address.

subject - String containing the subject line.

body - String containing the message body.

attach - List of URL's indicating the message attachments.

contentType - String indicating the content type.

Throws:

MailException - if the message cannot be delivered.

destroy

void destroy()

Destroy this mailer.