com.neurosys.messenger.email.service

Class MailerService

java.lang.Object

com.neurosys.messenger.email.service.MailerService

All Implemented Interfaces:

IMailerService

Direct Known Subclasses:

MailerService

public class MailerService
extends Object
implements IMailerService

A mailer service that can mail an email template based on

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected EmailDispatcher	emailDispatcher
protected int	numEmailsPerBatch
protected Long	sendLimitDurationUnit
protected Integer	serverMailLimitPerLongDuration
protected long	tempDelayBetweenBatches

Constructor Summary

Constructors

Constructor and Description
MailerService()

Method Summary

Modifier and Type	Method and Description
static EmailMessage	constructEmailMessageFromTemplate(EmailMessage templateMessage, List<EmailMultiPartBuilder.Part> emailContentParts) A convenience Util that creates an EmailMessage from some basic info.
static EmailMessage	constructEmailMessageFromTemplate(EmailMessage templateMessage, String content) Send single body plain text/html email. Refers to DisposableMessage.getContentType(); if null then checks EmailMessage.isAllowHtml()
static EmailMessage	constructEmailMessageFromTemplate(EmailMultiPartBuilder.Part.MultiPartType multiPartType, ContentType contentType, EmailMessage templateMessage, List<EmailMultiPartBuilder.Part> emailContentParts) A convenience Util that creates an EmailMessage from some basic info
static String	deriveAttachmentId(EmailMultiPartBuilder.FilePart filepart, String attachmentSuffix) Some EmailMultiPartBuilder.Parts may need to refer to EmailMultiPartBuilder.FilePart or EmailMultiPartBuilder.ImagePart.
EmailDispatcher	getEmailDispatcher()
int	getNumEmailsPerBatch() For a given set of Recipients, how many will be clubbed in one batch
Long	getSendLimitDurationUnit() serverMailLimitPerLongDuration is the number of Mails that can be sent in a UNIT of time.
Integer	getServerMailLimitPerLongDuration() Number of mails that can be sent in sendLimitDurationUnit of time
long	getTempDelayBetweenBatches() During bulk mailing operations, what is the delay in milli-secs between any 2 consequitive batches
protected void	onBatchEnd(int batchNumber, List<javax.mail.internet.InternetAddress> batch) After a batch is dispatched and any waits are oever
protected void	onBatchException(int batchNumber, List<javax.mail.internet.InternetAddress> batch, Exception e) While batch processing if there is any Exception
protected void	onBatchStart(int batchNumber, List<javax.mail.internet.InternetAddress> batch) Before a batch is dispatched
protected void	onMailSend(int batchNumber, List<javax.mail.internet.InternetAddress> batch, long totalMailsSentTillNow) Just after a batch is dispatched
void	sendMail(EmailMessage message) Send mails directly and synchronously
void	sendMailBuffered(EmailMessage message) Send the mail to DisposableMessage.getRecipients()in a Buffered manner using a BufferSplitter.
void	setEmailDispatcher(EmailDispatcher emailDispatcher)
void	setNumEmailsPerBatch(int numEmailsPerBatch) For a given set of Recipients, how many will be clubbed in one batch
void	setSendLimitDurationUnit(Long sendLimitDurationUnit) serverMailLimitPerLongDuration is the number of Mails that can be sent in a UNIT of time.
void	setServerMailLimitPerLongDuration(Integer serverMailLimitPerLongDuration) Number of mails that can be sent in sendLimitDurationUnit of time
void	setTempDelayBetweenBatches(long tempDelayBetweenBatches) During bulk mailing operations, what is the delay in milli-secs between any 2 consequitive batches

Methods inherited from class java.lang.Object

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

Field Detail

emailDispatcher

@Autowired
 @Qualifier(value="DefaultEmailDispatcher")
protected EmailDispatcher emailDispatcher

tempDelayBetweenBatches

protected long tempDelayBetweenBatches

numEmailsPerBatch

protected int numEmailsPerBatch

sendLimitDurationUnit

protected Long sendLimitDurationUnit

serverMailLimitPerLongDuration

protected Integer serverMailLimitPerLongDuration

Constructor Detail

MailerService

public MailerService()

Method Detail

deriveAttachmentId

public static final String deriveAttachmentId(EmailMultiPartBuilder.FilePart filepart,
                                              String attachmentSuffix)

Some EmailMultiPartBuilder.Parts may need to refer to EmailMultiPartBuilder.FilePart or EmailMultiPartBuilder.ImagePart. This can be done on the basis of a unique Id. Additionally, the id must follow the convention to be unique and like "@xyz" convention, supplied by the suffix.

Parameters:

filepart - as EmailMultiPartBuilder.FilePart

attachmentSuffix - as String

Returns:

id as String

constructEmailMessageFromTemplate

public static EmailMessage constructEmailMessageFromTemplate(EmailMultiPartBuilder.Part.MultiPartType multiPartType,
                                                             ContentType contentType,
                                                             EmailMessage templateMessage,
                                                             List<EmailMultiPartBuilder.Part> emailContentParts)
                                                      throws Exception

A convenience Util that creates an EmailMessage from some basic info

Parameters:

multiPartType - as EmailMultiPartBuilder.Part.MultiPartType

contentType - as ContentType

templateMessage - as EmailMessage template for the message to be generated

emailContentParts - as List of EmailMultiPartBuilder.Part. Based on attachment flags, a EmailMultiPartBuilder.Part maybe Attached or embedded.

Returns:

Throws:

Exception

constructEmailMessageFromTemplate

public static EmailMessage constructEmailMessageFromTemplate(EmailMessage templateMessage,
                                                             List<EmailMultiPartBuilder.Part> emailContentParts)
                                                      throws Exception

A convenience Util that creates an EmailMessage from some basic info.
Defaults to EmailMultiPartBuilder.Part.MultiPartType.parallel, ContentType.MULTIPART_MIXED

Parameters:

templateMessage - as EmailMessage template for the message to be generated

emailContentParts - as List of EmailMultiPartBuilder.Part. Based on attachment flags, a EmailMultiPartBuilder.Part maybe Attached or embedded.

Returns:

Throws:

Exception

constructEmailMessageFromTemplate

public static EmailMessage constructEmailMessageFromTemplate(EmailMessage templateMessage,
                                                             String content)
                                                      throws Exception

Send single body plain text/html email.
Refers to DisposableMessage.getContentType(); if null then checks EmailMessage.isAllowHtml()

Parameters:

templateMessage - as EmailMessage template for the message to be generated

content -

Returns:

Throws:

Exception

sendMail

public void sendMail(EmailMessage message)
              throws Exception

Description copied from interface: IMailerService

Send mails directly and synchronously

Specified by:

sendMail in interface IMailerService

Throws:

Exception

sendMailBuffered

public void sendMailBuffered(EmailMessage message)
                      throws Exception

Send the mail to DisposableMessage.getRecipients()in a Buffered manner using a BufferSplitter. The process may be synchronours or asynchronous; but in both cases Exceptions during batch processing will be notified to onBatchException(int, List, Exception) and not thrown directly.
One may further obtain the list by using Reader like CSVMailAddressReader.

For example:
List emailAddresses = CSVMailAddressReader_Instance.read(new File(userAddressListCSVPath));
Will append all EmailMessage.getCCList() and EmailMessage.getBCCList() to the main Recipient list

Specified by:

sendMailBuffered in interface IMailerService

Throws:

Exception

onBatchStart

protected void onBatchStart(int batchNumber,
                            List<javax.mail.internet.InternetAddress> batch)

Before a batch is dispatched

Parameters:

batchNumber, - index of the batch. Starts from 0

batch - as List of InternetAddress in this batch

onMailSend

protected void onMailSend(int batchNumber,
                          List<javax.mail.internet.InternetAddress> batch,
                          long totalMailsSentTillNow)

Just after a batch is dispatched

Parameters:

batchNumber, - index of the batch. Starts from 0

batch - as List of InternetAddress in this batch

totalMailsSentTillNow - as long

onBatchEnd

protected void onBatchEnd(int batchNumber,
                          List<javax.mail.internet.InternetAddress> batch)

After a batch is dispatched and any waits are oever

Parameters:

batchNumber, - index of the batch. Starts from 0

batch - as List of InternetAddress in this batch

onBatchException

protected void onBatchException(int batchNumber,
                                List<javax.mail.internet.InternetAddress> batch,
                                Exception e)

While batch processing if there is any Exception

Parameters:

batchNumber, - index of the batch. Starts from 0

batch - as List of InternetAddress in this batch

e - as Exception

getEmailDispatcher

public EmailDispatcher getEmailDispatcher()

setEmailDispatcher

public void setEmailDispatcher(EmailDispatcher emailDispatcher)

getTempDelayBetweenBatches

public long getTempDelayBetweenBatches()

During bulk mailing operations, what is the delay in milli-secs between any 2 consequitive batches

setTempDelayBetweenBatches

public void setTempDelayBetweenBatches(long tempDelayBetweenBatches)

During bulk mailing operations, what is the delay in milli-secs between any 2 consequitive batches

getNumEmailsPerBatch

public int getNumEmailsPerBatch()

For a given set of Recipients, how many will be clubbed in one batch

setNumEmailsPerBatch

public void setNumEmailsPerBatch(int numEmailsPerBatch)

For a given set of Recipients, how many will be clubbed in one batch

getSendLimitDurationUnit

public Long getSendLimitDurationUnit()

serverMailLimitPerLongDuration is the number of Mails that can be sent in a UNIT of time. The UNIT of time (milli secs definining One unit) is determined by this attribute
Example: If we want to sent 800 mails/hour. Then the unit here is an hour = 1L * 60L * 60L * 1000L

setSendLimitDurationUnit

public void setSendLimitDurationUnit(Long sendLimitDurationUnit)

serverMailLimitPerLongDuration is the number of Mails that can be sent in a UNIT of time. The UNIT of time (milli secs definining One unit) is determined by this attribute
Example: If we want to sent 800 mails/hour. Then the unit here is an hour = 1L * 60L * 60L * 1000L

getServerMailLimitPerLongDuration

public Integer getServerMailLimitPerLongDuration()

Number of mails that can be sent in sendLimitDurationUnit of time

setServerMailLimitPerLongDuration

public void setServerMailLimitPerLongDuration(Integer serverMailLimitPerLongDuration)

Number of mails that can be sent in sendLimitDurationUnit of time