public class StoreTemplateEmailSender
extends atg.userprofiling.email.TemplateEmailSender
TemplateEmailSender
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version
|
static java.lang.String |
PARAMETER_NAME_EMAIL_REQUEST
If this parameter is set to 'true' on HTTP request, then request is issued to render an email body.
|
ATG_MAILING_ID_HEADER_NAME, ATG_MAILING_ID_HEADER_NAME_TO_LOWER, INCOMPLETE_STATUSES, PARAM_MESSAGE_FILL_FROM_TEMPLATE
ATTR_EMAIL_SESSION, ATTR_INPUT_PARAMS, ATTR_PREFIX, ATTR_SESSION_COOKIES, PARAM_FILL_FROM_TEMPLATE, PARAM_MAILING_NAME, PARAM_MESSAGE_ATTACHMENTS, PARAM_MESSAGE_BCC, PARAM_MESSAGE_CC, PARAM_MESSAGE_FROM, PARAM_MESSAGE_REPLY_TO, PARAM_MESSAGE_SUBJECT, PARAM_MESSAGE_TO, TEMPLATE_PARAMS
Constructor and Description |
---|
StoreTemplateEmailSender() |
Modifier and Type | Method and Description |
---|---|
StorePropertyManager |
getPropertyManager()
Link to a user properties manager to be used by this component.
|
void |
sendEmailMessage(atg.userprofiling.email.TemplateEmailInfo pEmailInfo,
java.util.Collection pRecipients,
boolean pRunInSeparateThread,
boolean pPersist)
This implementation does the following:
obtain current locale from recipient specified by pRecipients parameter (if there is only one recipient)
if emailInfo's template parameters doesn't contain locale parameter and locale is defined, put locale into template parameters
add template parameter to mark request as email
send email with super-method
|
void |
setPropertyManager(StorePropertyManager pPropertyManager) |
addTemplateEmailListener, createAdminServlet, createMessage, doStartService, doStopService, getAlwaysPruneAfterRendering, getApplicationPrefix, getAppServerConnectRetryTime, getBatchEmailPeriodicService, getContextPathPrefix, getCreateMessagesBatchSize, getDaysContactFatigue, getDynamoInitSessionURL, getEmailAddressPropertyName, getEmailEncodingMap, getEmailMessageSender, getEmailStatusInvalidOptionValue, getEmailStatusPropertyName, getEmailStatusValidOptionValue, getEncodingTyper, getHoursContactFatigue, getInitSessionURL, getLastEmailedPropertyName, getLocalePropertyName, getLoopbackRequestsEnabled, getNextBatchMailing, getNumAppServerConnectAttempts, getProfilePath, getReceiveEmailPropertyName, getRequestLocalePath, getRequestSetupServlet, getRestartRequestThread, getSessionManager, getSiteContextManager, getSiteHttpServerName, getSiteHttpServerPort, getTemplateEmailBatchPersister, getTemplateEmailBatchServerPersister, getTemplateEmailListenerCount, getTemplateEmailListeners, getTemplateEmailPersister, getTemplateInvoker, getTemplateRendererServlet, getTemplateURL, getTemplateURL, getTransactionManager, getUpdateBatchCountsEveryNMessages, getUpdateProfileStatusesEveryNMessages, initializeRequest, initializeResponse, isAddingDebuggingHeaders, isAddingMailingIdHeader, isBatchIfPossible, isBypassRecipientVerification, isEnabledAsTemplateMailServer, isSetValidEmailStatus, recipientIsContactFatigued, removeTemplateEmailListener, sendBatch, sendEmailMessage, sendEmailMessage, sendEmailMessage, sendEmailMessage, sendEmailMessage, sendEmailNotSentEvent, sendEmailSentEvent, serviceNextBatchMailing, setAddingDebuggingHeaders, setAddingMailingIdHeader, setAlwaysPruneAfterRendering, setApplicationPrefix, setAppServerConnectRetryTime, setBatchEmailPeriodicService, setBatchIfPossible, setBypassRecipientVerification, setContextPathPrefix, setCreateMessagesBatchSize, setDaysContactFatigue, setDynamoInitSessionURL, setEmailAddressPropertyName, setEmailEncodingMap, setEmailMessageSender, setEmailStatusInvalidOptionValue, setEmailStatusPropertyName, setEmailStatusValidOptionValue, setEnabledAsTemplateMailServer, setEncodingTyper, setHoursContactFatigue, setInitSessionURL, setLastEmailedPropertyName, setLocalePropertyName, setLoopbackRequestsEnabled, setNumAppServerConnectAttempts, setProfilePath, setReceiveEmailPropertyName, setRequestLocalePath, setRequestSetupServlet, setRestartRequestThread, setSessionManager, setSetValidEmailStatus, setSiteContextManager, setSiteHttpServerName, setSiteHttpServerPort, setTemplateEmailBatchPersister, setTemplateEmailBatchServerPersister, setTemplateEmailPersister, setTemplateInvoker, setTemplateRendererServlet, setTransactionManager, setUpdateBatchCountsEveryNMessages, setUpdateProfileStatusesEveryNMessages
addLogListener, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static final java.lang.String CLASS_VERSION
public static final java.lang.String PARAMETER_NAME_EMAIL_REQUEST
public StorePropertyManager getPropertyManager()
public void setPropertyManager(StorePropertyManager pPropertyManager)
pPropertyManager
- the propertyManager to setpublic void sendEmailMessage(atg.userprofiling.email.TemplateEmailInfo pEmailInfo, java.util.Collection pRecipients, boolean pRunInSeparateThread, boolean pPersist) throws atg.userprofiling.email.TemplateEmailException
sendEmailMessage
in class atg.userprofiling.email.TemplateEmailSender
pEmailInfo
- the email infopRecipients
- the recipientpRunInSeparateThread
- if true, it shoulld be run in separate threadpPersist
- if true, the mailing will be persisted in the database before
the email is actually sent. Thus, if the server goes down unexpectedly, the mailing
will resume when the server is restarted.atg.userprofiling.email.TemplateEmailException
- if any problem was encountered while assembling or
sending the message (but see above for an explanation of when an exception is not thrown)