atg.service.email

Interface EmailSender

All Known Implementing Classes:

EmailListenerQueue, SMTPEmailSender

public interface EmailSender

An interface that describes a mechanism for managing sending email events.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Methods

Modifier and Type	Method and Description
void	sendEmailMessage(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody) Sends a message with the given parameters
void	sendEmailMessage(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody, java.lang.String pExtraHeader) Sends a message with the given parameters
void	sendEmailMessage(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody, java.lang.String[] pExtraHeaders) Sends a message with the given parameters
void	sendEmailMessage(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody) Sends a message with the given parameters
void	sendEmailMessage(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody, java.lang.String pExtraHeader) Sends a message with the given parameters
void	sendEmailMessage(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody, java.lang.String[] pExtraHeaders) Sends a message with the given parameters

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

sendEmailMessage

void sendEmailMessage(java.lang.String pFrom,
                    java.lang.String pRecipient,
                    java.lang.String pSubject,
                    java.lang.String pBody)
                      throws EmailException

Sends a message with the given parameters

Parameters:

pFrom - Whom the mail is coming from

pRecipient - The recipient that should receive the message

pSubject - Subject line of the email message

pBody - The message content

Throws:

EmailException - if there is any problem while sending mail

sendEmailMessage

void sendEmailMessage(java.lang.String pFrom,
                    java.lang.String[] pRecipients,
                    java.lang.String pSubject,
                    java.lang.String pBody)
                      throws EmailException

Sends a message with the given parameters

Parameters:

pFrom - Whom the mail is coming from

pRecipients - The list of recipients that should receive email

pSubject - Subject line of the email message

pBody - The message content

Throws:

EmailException - if there is any problem while sending mail

sendEmailMessage

void sendEmailMessage(java.lang.String pFrom,
                    java.lang.String pRecipient,
                    java.lang.String pSubject,
                    java.lang.String pBody,
                    java.lang.String pExtraHeader)
                      throws EmailException

Sends a message with the given parameters

Parameters:

pFrom - Whom the mail is coming from

pRecipient - The recipient that should receive the message

pSubject - Subject line of the email message

pBody - The message content

pExtraHeader - An extra headers that should be used in the email (e.g. "X-URL: http://foo.bar.com/")

Throws:

EmailException - if there is any problem while sending mail

sendEmailMessage

void sendEmailMessage(java.lang.String pFrom,
                    java.lang.String pRecipient,
                    java.lang.String pSubject,
                    java.lang.String pBody,
                    java.lang.String[] pExtraHeaders)
                      throws EmailException

Sends a message with the given parameters

Parameters:

pFrom - Whom the mail is coming from

pRecipient - The recipient that should receive the message

pSubject - Subject line of the email message

pBody - The message content

pExtraHeaders - The list of extra headers that should be used in the email (e.g. "X-URL: http://foo.bar.com/")

Throws:

EmailException - if there is any problem while sending mail

sendEmailMessage

void sendEmailMessage(java.lang.String pFrom,
                    java.lang.String[] pRecipients,
                    java.lang.String pSubject,
                    java.lang.String pBody,
                    java.lang.String pExtraHeader)
                      throws EmailException

Sends a message with the given parameters

Parameters:

pFrom - Whom the mail is coming from

pRecipients - The list of recipients that should receive email

pSubject - Subject line of the email message

pBody - The message content

pExtraHeader - An extra headers that should be used in the email (e.g. "X-URL: http://foo.bar.com/")

Throws:

EmailException - if there is any problem while sending mail

sendEmailMessage

void sendEmailMessage(java.lang.String pFrom,
                    java.lang.String[] pRecipients,
                    java.lang.String pSubject,
                    java.lang.String pBody,
                    java.lang.String[] pExtraHeaders)
                      throws EmailException

Sends a message with the given parameters

Parameters:

pFrom - Whom the mail is coming from

pRecipients - The list of recipients that should receive email

pSubject - Subject line of the email message

pBody - The message content

pExtraHeaders - The list of extra headers that should be used in the email (e.g. "X-URL: http://foo.bar.com/")

Throws:

EmailException - if there is any problem while sending mail