de.hybris.platform.acceleratorservices.email.impl

Class DefaultEmailService

java.lang.Object

de.hybris.platform.acceleratorservices.email.impl.DefaultEmailService

All Implemented Interfaces:

EmailService

public class DefaultEmailService
extends java.lang.Object
implements EmailService

Service to create and send emails.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMAIL_BODY_ENCODING Deprecated. As of release 6.7, replaced by StandardCharsets.UTF_8
static int	EMAIL_BODY_MAX_LENGTH
static java.lang.String	EMAIL_BODY_MAX_LENGTH_KEY
static java.lang.String	EMAIL_BODY_MIME_TYPE
static java.lang.String	EMAILSERVICE_SEND_ENABLED_CONFIG_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultEmailService()

Method Summary

Modifier and Type	Method and Description
protected void	addReplyTo(EmailMessageModel message, HtmlEmail email)
protected java.util.List<java.lang.String>	convertToStrings(java.util.List<EmailAddressModel> addresses)
protected MediaModel	createBodyMedia(java.lang.String bodyMediaName, java.lang.String body) Method creates MediaModel object for storing email body
EmailAttachmentModel	createEmailAttachment(java.io.DataInputStream masterDataStream, java.lang.String filename, java.lang.String mimeType) Creates an email attachment from an input stream.
EmailMessageModel	createEmailMessage(java.util.List<EmailAddressModel> toAddresses, java.util.List<EmailAddressModel> ccAddresses, java.util.List<EmailAddressModel> bccAddresses, EmailAddressModel fromAddress, java.lang.String replyToAddress, java.lang.String subject, java.lang.String body, java.util.List<EmailAttachmentModel> attachments) Creates and EmailMessage object.
protected InternetAddress	createInternetAddress(java.lang.String emailAddress, java.lang.String displayName)
protected java.util.Collection<InternetAddress>	getAddresses(java.util.List<EmailAddressModel> emailAddresses)
protected java.lang.String	getBody(EmailMessageModel message) Method checks which attribute is storing email body (bodyMedia or body) and return its content as string
protected CatalogService	getCatalogService()
protected CatalogVersionModel	getCatalogVersion()
protected CatalogVersionService	getCatalogVersionService()
protected ConfigurationService	getConfigurationService()
protected EmailAddressFetchStrategy	getEmailAddressFetchStrategy()
protected MediaFolderModel	getEmailAttachmentsMediaFolder()
protected java.lang.String	getEmailAttachmentsMediaFolderName()
protected MediaFolderModel	getEmailBodyMediaFolder()
protected java.lang.String	getEmailBodyMediaFolderName()
protected MediaService	getMediaService()
protected ModelService	getModelService()
EmailAddressModel	getOrCreateEmailAddressForEmail(java.lang.String emailAddress, java.lang.String displayName) Returns a EmailAddressModel.
protected HtmlEmail	getPerConfiguredEmail()
protected void	logDebugException(java.lang.Exception e)
protected void	logInfo(EmailMessageModel message, EmailException e)
protected java.lang.String	nullifyEmpty(java.lang.String str)
protected boolean	processAttachmentsSuccessful(HtmlEmail email, java.util.List<EmailAttachmentModel> attachments)
boolean	send(EmailMessageModel message) Sends an email
protected void	setAddresses(EmailMessageModel message, HtmlEmail email, java.util.List<EmailAddressModel> toAddresses)
void	setCatalogService(CatalogService catalogService)
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
void	setConfigurationService(ConfigurationService configurationService)
void	setEmailAddressFetchStrategy(EmailAddressFetchStrategy emailAddressFetchStrategy)
void	setEmailAttachmentsMediaFolderName(java.lang.String emailAttachmentsMediaFolderName)
void	setEmailBodyMediaFolderName(java.lang.String emailBodyMediaFolderName)
void	setMediaService(MediaService mediaService)
void	setModelService(ModelService modelService)
protected void	validateAddresses(java.util.List<EmailAddressModel> toAddresses, EmailAddressModel fromAddress)
protected void	validateContent(java.lang.String subject, java.lang.String body)
protected void	validateEmailAddress(java.lang.String address, java.lang.String type)

Methods inherited from class java.lang.Object

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

Field Detail

EMAIL_BODY_ENCODING

@Deprecated
public static final java.lang.String EMAIL_BODY_ENCODING

Deprecated. As of release 6.7, replaced by StandardCharsets.UTF_8

See Also:

Constant Field Values

EMAILSERVICE_SEND_ENABLED_CONFIG_KEY

public static final java.lang.String EMAILSERVICE_SEND_ENABLED_CONFIG_KEY

See Also:

Constant Field Values

EMAIL_BODY_MAX_LENGTH

public static final int EMAIL_BODY_MAX_LENGTH

See Also:

Constant Field Values

EMAIL_BODY_MAX_LENGTH_KEY

public static final java.lang.String EMAIL_BODY_MAX_LENGTH_KEY

See Also:

Constant Field Values

EMAIL_BODY_MIME_TYPE

public static final java.lang.String EMAIL_BODY_MIME_TYPE

See Also:

Constant Field Values

Constructor Detail

DefaultEmailService

public DefaultEmailService()

Method Detail

getOrCreateEmailAddressForEmail

public EmailAddressModel getOrCreateEmailAddressForEmail(java.lang.String emailAddress,
                                                         java.lang.String displayName)

Description copied from interface: EmailService

Returns a EmailAddressModel. Instance is found for the given email address and display name criteria. If there is no instance for this condition the new EmailAddressModel instance is returned based on the given criteria.

Specified by:

getOrCreateEmailAddressForEmail in interface EmailService

Parameters:

emailAddress - Email id

displayName - Display name

Returns:

EmailAddress object

createEmailAttachment

public EmailAttachmentModel createEmailAttachment(java.io.DataInputStream masterDataStream,
                                                  java.lang.String filename,
                                                  java.lang.String mimeType)

Description copied from interface: EmailService

Creates an email attachment from an input stream.

Specified by:

createEmailAttachment in interface EmailService

Parameters:

masterDataStream - Input data stream

filename - File name

mimeType - Mime type

Returns:

EmailAttachment object

getEmailAttachmentsMediaFolder

protected MediaFolderModel getEmailAttachmentsMediaFolder()

getEmailBodyMediaFolder

protected MediaFolderModel getEmailBodyMediaFolder()

createEmailMessage

public EmailMessageModel createEmailMessage(java.util.List<EmailAddressModel> toAddresses,
                                            java.util.List<EmailAddressModel> ccAddresses,
                                            java.util.List<EmailAddressModel> bccAddresses,
                                            EmailAddressModel fromAddress,
                                            java.lang.String replyToAddress,
                                            java.lang.String subject,
                                            java.lang.String body,
                                            java.util.List<EmailAttachmentModel> attachments)

Description copied from interface: EmailService

Creates and EmailMessage object.

Specified by:

createEmailMessage in interface EmailService

Parameters:

toAddresses - List of To email addresses

ccAddresses - List of CC email addresses

bccAddresses - List of BCC email addresses

fromAddress - From email address

replyToAddress - Reply To email address

subject - Subject of the email

body - Contents of the email

attachments - List of email attachments

Returns:

EmailMessage object

validateAddresses

protected void validateAddresses(java.util.List<EmailAddressModel> toAddresses,
                                 EmailAddressModel fromAddress)

validateContent

protected void validateContent(java.lang.String subject,
                               java.lang.String body)

createBodyMedia

protected MediaModel createBodyMedia(java.lang.String bodyMediaName,
                                     java.lang.String body)

Method creates MediaModel object for storing email body

Parameters:

bodyMediaName - - name for created object

body - - content of email body

Returns:

created MediaModel object

getCatalogVersion

protected CatalogVersionModel getCatalogVersion()

validateEmailAddress

protected void validateEmailAddress(java.lang.String address,
                                    java.lang.String type)

send

public boolean send(EmailMessageModel message)

Description copied from interface: EmailService

Sends an email

Specified by:

send in interface EmailService

Parameters:

message - EmailMessage

Returns:

true if successful

addReplyTo

protected void addReplyTo(EmailMessageModel message,
                          HtmlEmail email)
                   throws EmailException

Throws:

EmailException

logInfo

protected void logInfo(EmailMessageModel message,
                       EmailException e)

processAttachmentsSuccessful

protected boolean processAttachmentsSuccessful(HtmlEmail email,
                                               java.util.List<EmailAttachmentModel> attachments)

setAddresses

protected void setAddresses(EmailMessageModel message,
                            HtmlEmail email,
                            java.util.List<EmailAddressModel> toAddresses)
                     throws EmailException

Throws:

EmailException

getPerConfiguredEmail

protected HtmlEmail getPerConfiguredEmail()
                                   throws EmailException

Throws:

EmailException

getBody

protected java.lang.String getBody(EmailMessageModel message)

Method checks which attribute is storing email body (bodyMedia or body) and return its content as string

Parameters:

message - - email message object

Returns:

email body

nullifyEmpty

protected java.lang.String nullifyEmpty(java.lang.String str)

getAddresses

protected java.util.Collection<InternetAddress> getAddresses(java.util.List<EmailAddressModel> emailAddresses)

createInternetAddress

protected InternetAddress createInternetAddress(java.lang.String emailAddress,
                                                java.lang.String displayName)
                                         throws EmailException

Throws:

EmailException

convertToStrings

protected java.util.List<java.lang.String> convertToStrings(java.util.List<EmailAddressModel> addresses)

logDebugException

protected void logDebugException(java.lang.Exception e)

getEmailAddressFetchStrategy

protected EmailAddressFetchStrategy getEmailAddressFetchStrategy()

setEmailAddressFetchStrategy

public void setEmailAddressFetchStrategy(EmailAddressFetchStrategy emailAddressFetchStrategy)

getEmailAttachmentsMediaFolderName

protected java.lang.String getEmailAttachmentsMediaFolderName()

setEmailAttachmentsMediaFolderName

public void setEmailAttachmentsMediaFolderName(java.lang.String emailAttachmentsMediaFolderName)

getEmailBodyMediaFolderName

protected java.lang.String getEmailBodyMediaFolderName()

setEmailBodyMediaFolderName

public void setEmailBodyMediaFolderName(java.lang.String emailBodyMediaFolderName)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getMediaService

protected MediaService getMediaService()

setMediaService

public void setMediaService(MediaService mediaService)

getConfigurationService

protected ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

getCatalogVersionService

protected CatalogVersionService getCatalogVersionService()

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

getCatalogService

protected CatalogService getCatalogService()

setCatalogService

public void setCatalogService(CatalogService catalogService)