|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.userprofiling.email.TemplateEmailInfo atg.userprofiling.email.TemplateEmailInfoImpl
public class TemplateEmailInfoImpl
A concrete extension of the TemplateEmailInfo class that
contains the standard email message attributes as properties
(messageFrom
, messageSubject
, etc.)
and uses them to construct Message objects.
TemplateEmailInfo
,
MessageContentProcessor
,
Message
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.String |
PROFILE_ID_TRACKING_DATA_KEY
The key used to store the profileId in the outgoing email tracking data |
Constructor Summary | |
---|---|
TemplateEmailInfoImpl()
|
Method Summary | |
---|---|
protected void |
appendProperties(java.lang.StringBuffer pBuffer)
Append any properties for debugging. |
TemplateEmailInfo |
copy()
Returns a copy of this TemplateEmailInfo. |
void |
copyPropertiesTo(TemplateEmailInfo pCopy)
Copy known properties to pCopy. |
javax.mail.Message |
createMessage(java.lang.String pRecipient,
java.lang.String[] pContents,
java.lang.String[] pContentTypes)
Creates and returns a Message object with the given email recipient and content. |
javax.mail.Message |
createMessage(java.lang.String pRecipient,
java.lang.String pContent,
java.lang.String pContentType)
Creates and returns a Message object with the given email recipient and content. |
MessageContentProcessor |
getContentProcessor()
Returns the MessageContentProcessor object used to process the message text and set the content of the email message. |
java.lang.String |
getMailingName()
Returns the MailingName field for the email. |
java.lang.String |
getMessageBcc()
Returns the Bcc field for the email. |
java.lang.String |
getMessageCc()
Returns the CC field for the email. |
java.lang.String |
getMessageFrom()
Returns the From field for the email. |
java.lang.String |
getMessageReplyTo()
Returns the ReplyTo field for the email. |
java.lang.String |
getMessageSubject()
Returns the Subject field for the email. |
java.lang.String |
getMessageTo()
Returns the To field for the email. |
java.lang.String |
getProfileId()
Gets the profile id associated with the email. |
java.util.Map |
getTrackingData()
Returns the tracking data to associate with the email. |
atg.userprofiling.email.TemplateEmailTransitoryInfo |
getTransitoryInfo()
Get the transitory info. |
void |
setContentProcessor(MessageContentProcessor pContentProcessor)
Sets the MessageContentProcessor object used to process the message text and set the content of the email message. |
void |
setMailingName(java.lang.String pMailingName)
Sets the MailingName field for the email. |
void |
setMessageBcc(java.lang.String pMessageBcc)
Sets the Bcc field for the email. |
void |
setMessageCc(java.lang.String pMessageCc)
Sets the CC field for the email. |
void |
setMessageFrom(java.lang.String pMessageFrom)
Sets the From field for the email. |
void |
setMessageReplyTo(java.lang.String pMessageReplyTo)
Sets the ReplyTo field for the email. |
void |
setMessageSubject(java.lang.String pMessageSubject)
Sets the Subject field for the email. |
void |
setMessageTo(java.lang.String pMessageTo)
Sets the To field for the email. |
void |
setProfileId(java.lang.String pProfileId)
Sets the profile id associated with the email. |
void |
setTrackingData(java.util.Map pTrackingData)
Sets the tracking data to associate with the email. |
void |
setTransitoryInfo(atg.userprofiling.email.TemplateEmailTransitoryInfo pTransitoryInfo)
Set the transitory info. |
boolean |
supportsMultipleContents()
Whether or not we support creating a message with multiple contents passed in. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final java.lang.String PROFILE_ID_TRACKING_DATA_KEY
Constructor Detail |
---|
public TemplateEmailInfoImpl()
Method Detail |
---|
public java.lang.String getMailingName()
public void setMailingName(java.lang.String pMailingName)
public java.lang.String getMessageReplyTo()
public void setMessageReplyTo(java.lang.String pMessageReplyTo)
public void setMessageTo(java.lang.String pMessageTo)
public java.lang.String getMessageTo()
public java.lang.String getMessageFrom()
public void setMessageFrom(java.lang.String pMessageFrom)
public java.lang.String getMessageCc()
public void setMessageCc(java.lang.String pMessageCc)
public java.lang.String getMessageBcc()
public void setMessageBcc(java.lang.String pMessageBcc)
public java.lang.String getMessageSubject()
public void setMessageSubject(java.lang.String pMessageSubject)
public java.util.Map getTrackingData()
public void setTrackingData(java.util.Map pTrackingData)
public java.lang.String getProfileId()
public void setProfileId(java.lang.String pProfileId)
public MessageContentProcessor getContentProcessor()
public void setContentProcessor(MessageContentProcessor pContentProcessor)
public void setTransitoryInfo(atg.userprofiling.email.TemplateEmailTransitoryInfo pTransitoryInfo)
public atg.userprofiling.email.TemplateEmailTransitoryInfo getTransitoryInfo()
public boolean supportsMultipleContents()
TemplateEmailInfo
supportsMultipleContents
in class TemplateEmailInfo
public javax.mail.Message createMessage(java.lang.String pRecipient, java.lang.String pContent, java.lang.String pContentType) throws atg.userprofiling.email.InvalidSenderAddressException, InvalidRecipientAddressException, TemplateEmailException
createMessage
in class TemplateEmailInfo
pRecipient
- the email address of the main recipient,
corresponding to a particular profilepContent
- the message text obtained by instantiating
the template for a particular profilepContentType
- the content type obtaine by instantiating the
template for a particular profile (example : text/plain).
InvalidRecipientAddressException
- if the recipient
email address is null, malformed, or invalid
TemplateEmailException
- if any other problem is
encountered while composing the Message
atg.userprofiling.email.InvalidSenderAddressException
public javax.mail.Message createMessage(java.lang.String pRecipient, java.lang.String[] pContents, java.lang.String[] pContentTypes) throws atg.userprofiling.email.InvalidSenderAddressException, InvalidRecipientAddressException, TemplateEmailException
createMessage
in class TemplateEmailInfo
pRecipient
- the email address of the main recipient,
corresponding to a particular profilepContent
- the message text obtained by instantiating
the template for a particular profilepContentType
- the content type obtaine by instantiating the
template for a particular profile (example : text/plain).
InvalidRecipientAddressException
- if the recipient
email address is null, malformed, or invalid
TemplateEmailException
- if any other problem is
encountered while composing the Message
atg.userprofiling.email.InvalidSenderAddressException
public void copyPropertiesTo(TemplateEmailInfo pCopy)
copyPropertiesTo
in class TemplateEmailInfo
pCopy
- the info to which to copy properties.public TemplateEmailInfo copy()
copy
in class TemplateEmailInfo
protected void appendProperties(java.lang.StringBuffer pBuffer)
appendProperties
in class TemplateEmailInfo
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |