public class EmailEvent
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Constructor and Description |
---|
EmailEvent() |
EmailEvent(javax.mail.Message pMessage) |
EmailEvent(java.lang.String pFrom,
java.lang.String[] pRecipients,
java.lang.String pSubject,
java.lang.String pBody) |
EmailEvent(java.lang.String pFrom,
java.lang.String[] pRecipients,
java.lang.String pSubject,
java.lang.String pBody,
java.lang.String pExtraHeader) |
EmailEvent(java.lang.String pFrom,
java.lang.String[] pRecipients,
java.lang.String pSubject,
java.lang.String pBody,
java.lang.String[] pExtraHeaders) |
EmailEvent(java.lang.String pFrom,
java.lang.String[] pRecipients,
java.lang.String pSubject,
java.lang.String pBody,
java.lang.String[] pExtraHeaders,
java.util.Map pTrackingData) |
EmailEvent(java.lang.String pFrom,
java.lang.String pRecipient,
java.lang.String pSubject,
java.lang.String pBody) |
EmailEvent(java.lang.String pFrom,
java.lang.String pRecipient,
java.lang.String pSubject,
java.lang.String pBody,
java.lang.String pExtraHeader) |
EmailEvent(java.lang.String pFrom,
java.lang.String pRecipient,
java.lang.String pSubject,
java.lang.String pBody,
java.lang.String[] pExtraHeaders) |
EmailEvent(java.lang.String pFrom,
java.lang.String pRecipient,
java.lang.String pSubject,
java.lang.String pBody,
java.lang.String[] pExtraHeaders,
java.util.Map pTrackingData) |
Modifier and Type | Method and Description |
---|---|
protected javax.mail.Message |
createMessage(javax.mail.Session pSession,
atg.service.email.EmailTrackingTools pTools)
Creates a new Message from the given EmailEvent's parameters
(from, subject, recipients, body, etc.).
|
java.lang.String |
getBcc()
Returns the sender (Bcc:) field.
|
java.lang.String |
getBody()
Returns the message body.
|
java.lang.String |
getCc()
Returns the sender (Cc:) field.
|
java.lang.String |
getCharSet()
Returns the character set.
|
java.lang.String[] |
getExtraHeaders()
Returns the list of extra headers that should be used in the email
(e.g.
|
java.lang.String |
getFrom()
Returns the sender (From:) field.
|
javax.mail.Message |
getMessage()
Returns the Message to be sent.
|
javax.mail.Message |
getMessage(javax.mail.Session pSession)
Returns the Message to be sent.
|
javax.mail.Message |
getMessage(javax.mail.Session pSession,
atg.service.email.EmailTrackingTools pTools)
Returns the Message to be sent.
|
java.lang.String |
getRecipient()
Returns the recipient that should receive email
|
java.lang.String[] |
getRecipientList()
Returns the list of recipients that should receive email
|
java.lang.String |
getSubject()
Returns the subject field.
|
java.util.Map |
getTrackingData()
Gets the NV pair data to associate with the out-bound email.
|
void |
setBcc(java.lang.String pBcc)
Sets the sender (Bcc:) field.
|
void |
setBody(java.lang.String pBody)
Sets the message body.
|
void |
setCc(java.lang.String pCc)
Sets the sender (Cc:) field.
|
void |
setCharSet(java.lang.String pCharSet)
Sets the character set.
|
void |
setExtraHeaders(java.lang.String[] pExtraHeaders)
Sets the list of extra headers that should be used in the email
(e.g.
|
void |
setFrom(java.lang.String pFrom)
Sets the sender (Cc:) field.
|
void |
setMessage(javax.mail.Message pMessage)
Sets the Message to be sent.
|
void |
setRecipient(java.lang.String pRecipient)
Sets the recipient that should receive email
|
void |
setRecipientList(java.lang.String[] pRecipients)
Sets the list of recipients that should receive email
|
void |
setSubject(java.lang.String pSubject)
Sets the subject field.
|
void |
setTrackingData(java.util.Map pTrackingData)
Sets the NV pair data to associate with the out-bound email.
|
public EmailEvent()
public EmailEvent(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody)
public EmailEvent(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody)
public EmailEvent(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody, java.lang.String pExtraHeader)
public EmailEvent(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody, java.lang.String[] pExtraHeaders)
public EmailEvent(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody, java.lang.String pExtraHeader)
public EmailEvent(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody, java.lang.String[] pExtraHeaders)
public EmailEvent(java.lang.String pFrom, java.lang.String pRecipient, java.lang.String pSubject, java.lang.String pBody, java.lang.String[] pExtraHeaders, java.util.Map pTrackingData)
public EmailEvent(java.lang.String pFrom, java.lang.String[] pRecipients, java.lang.String pSubject, java.lang.String pBody, java.lang.String[] pExtraHeaders, java.util.Map pTrackingData)
public EmailEvent(javax.mail.Message pMessage)
public java.lang.String[] getRecipientList()
public void setRecipientList(java.lang.String[] pRecipients)
public java.lang.String getRecipient()
public void setRecipient(java.lang.String pRecipient)
public java.lang.String getCharSet()
public void setCharSet(java.lang.String pCharSet)
public java.lang.String getFrom()
public void setFrom(java.lang.String pFrom)
public java.lang.String getCc()
public void setCc(java.lang.String pCc)
public java.lang.String getBcc()
public void setBcc(java.lang.String pBcc)
public java.lang.String getSubject()
public void setSubject(java.lang.String pSubject)
public java.lang.String[] getExtraHeaders()
"X-URL: http://foo.bar.com/"
)public void setExtraHeaders(java.lang.String[] pExtraHeaders)
"X-URL: http://foo.bar.com/"
)public java.util.Map getTrackingData()
public void setTrackingData(java.util.Map pTrackingData)
public java.lang.String getBody()
public void setBody(java.lang.String pBody)
public javax.mail.Message getMessage() throws EmailException
EmailException
- if an error occurs while creating
the MessageMessage
public javax.mail.Message getMessage(javax.mail.Session pSession) throws EmailException
EmailException
- if an error occurs while creating
the MessageMessage
public javax.mail.Message getMessage(javax.mail.Session pSession, atg.service.email.EmailTrackingTools pTools) throws EmailException
EmailException
- if an error occurs while creating
the MessageMessage
public void setMessage(javax.mail.Message pMessage)
This property should be used if the other EmailEvent properties are not sufficient to describe the message headers and/or content: for example, if you wish to send a message with an attachment, or a multipart message.
Message
protected javax.mail.Message createMessage(javax.mail.Session pSession, atg.service.email.EmailTrackingTools pTools) throws EmailException
EmailException
- if the Message could not be created
from the given event parameters