com.databasesandlife.util

Class EmailTransaction

java.lang.Object

com.databasesandlife.util.EmailTransaction

public class EmailTransaction
extends Object

An transaction allowing emails to be sent over SMTP

This object allows emails to take part in transactional operations. Any part of the code may send(Message) emails using this transaction. They get stored in memory, and only really get sent when commit() is called. This way, if an exception occurs after the email gets sent, and the operation is successfully retried, the recipient only gets one email based on the successful operation and no emails based on the unsuccessful operation.

There is no need to rollback this object if an operation has been not successful. Simply throw the object away.

Author:

This source is copyright Adrian Smith and licensed under the LGPL 3.

See Also:

Project on GitHub

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmailTransaction.EmailSendingConfiguration
static class	EmailTransaction.MxSmtpConfiguration
static class	EmailTransaction.SmtpServerAddress
static class	EmailTransaction.SmtpServerConfiguration
static class	EmailTransaction.TlsSmtpServerAddress

Field Summary

Fields

Modifier and Type	Field and Description
protected EmailTransaction.EmailSendingConfiguration	config
protected List<javax.mail.Message>	messages

Constructor Summary

Constructors

Constructor and Description
EmailTransaction(EmailTransaction.EmailSendingConfiguration config)

Method Summary

Modifier and Type	Method and Description
void	commit()
String	getEmailBodyForTesting(int idx)
int	getEmailCountForTesting()
protected static String	getHostForMxRecord(String mxAddress)
javax.mail.internet.MimeMessage	newMimeMessage()
protected javax.mail.Session	newSession()
protected Properties	newSessionProperties()
static EmailTransaction.SmtpServerConfiguration	parseAddress(String str) Can be "foo" or "foo:123" or "foo:123|adrian|password" or "MX:foo.com"
void	send(javax.mail.Message msg)

Methods inherited from class java.lang.Object

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

Field Detail

config

@Nonnull
protected final EmailTransaction.EmailSendingConfiguration config

messages

protected final List<javax.mail.Message> messages

Constructor Detail

EmailTransaction

public EmailTransaction(@Nonnull
                        EmailTransaction.EmailSendingConfiguration config)
                 throws ConfigurationException

Throws:

ConfigurationException

Method Detail

getHostForMxRecord

protected static String getHostForMxRecord(String mxAddress)
                                    throws ConfigurationException

Throws:

ConfigurationException

newSessionProperties

protected Properties newSessionProperties()
                                   throws ConfigurationException

Throws:

ConfigurationException

newSession

protected javax.mail.Session newSession()
                                 throws ConfigurationException

Throws:

ConfigurationException

parseAddress

@Nonnull
public static EmailTransaction.SmtpServerConfiguration parseAddress(@Nonnull
                                                                             String str)
                                                                      throws ConfigurationException

Can be "foo" or "foo:123" or "foo:123|adrian|password" or "MX:foo.com"

Throws:

ConfigurationException

newMimeMessage

@Nonnull
public javax.mail.internet.MimeMessage newMimeMessage()

send

public void send(javax.mail.Message msg)

commit

public void commit()

getEmailCountForTesting

public int getEmailCountForTesting()

getEmailBodyForTesting

public String getEmailBodyForTesting(int idx)