atg.projects.store.email
Class StoreTemplateEmailSender

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.userprofiling.email.TemplateEmailSender
              atg.projects.store.email.StoreTemplateEmailSender

All Implemented Interfaces:

atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, atg.servlet.TemplateEmailConstants, java.util.EventListener

public class StoreTemplateEmailSender
extends atg.userprofiling.email.TemplateEmailSender

This is a Store extention of DPS' TemplateEmailSender component. This extention passes current locale (if set) into the e-mail template to be sent.

See Also:

TemplateEmailSender

Nested Class Summary

Nested classes/interfaces inherited from class atg.userprofiling.email.TemplateEmailSender

atg.userprofiling.email.TemplateEmailSender.TemplateEmailSenderResReqInitter

Field Summary

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.

Fields inherited from class atg.userprofiling.email.TemplateEmailSender

ATG_MAILING_ID_HEADER_NAME, ATG_MAILING_ID_HEADER_NAME_TO_LOWER, INCOMPLETE_STATUSES, PARAM_MESSAGE_FILL_FROM_TEMPLATE

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.servlet.TemplateEmailConstants

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

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

StoreTemplateEmailSender()

Method Summary

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)

Methods inherited from class atg.userprofiling.email.TemplateEmailSender

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

Methods inherited from class atg.nucleus.GenericService

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

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version

See Also:

Constant Field Values

PARAMETER_NAME_EMAIL_REQUEST

public static final 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.

See Also:

Constant Field Values

Constructor Detail

StoreTemplateEmailSender

public StoreTemplateEmailSender()

Method Detail

getPropertyManager

public StorePropertyManager getPropertyManager()

Link to a user properties manager to be used by this component.

Returns:

the mPropertyManager

setPropertyManager

public void setPropertyManager(StorePropertyManager pPropertyManager)

Parameters:

pPropertyManager - the propertyManager to set

sendEmailMessage

public void sendEmailMessage(atg.userprofiling.email.TemplateEmailInfo pEmailInfo,
                             java.util.Collection pRecipients,
                             boolean pRunInSeparateThread,
                             boolean pPersist)
                      throws atg.userprofiling.email.TemplateEmailException

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

Overrides:

sendEmailMessage in class atg.userprofiling.email.TemplateEmailSender

Parameters:

pEmailInfo - the email info

pRecipients - the recipient

pRunInSeparateThread - if true, it shoulld be run in separate thread

pPersist - 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.

Throws:

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)