io.stallion.email

Class EmailSender

java.lang.Object

io.stallion.email.EmailSender

Direct Known Subclasses:

SmtpEmailSender

public abstract class EmailSender
extends Object

Helper class for sending an email. Can be used as follows: EmailSender .newSender() .setTo("recipient@domain.com") .setFrom("sender@domain.com") .setSubject("President's Day Sale!") .setHtml("...email body email...") .send(); You can create subclasses to implement senders for particular services, such as Amazon Simple Email Service, Sendgrid, etc. The default subclass is SmtpEmailSender() which is used by default throughout Stallion.

Constructor Summary

Constructors

Constructor and Description
EmailSender()
EmailSender(EmailSettings emailSettings)

Method Summary

Modifier and Type	Method and Description
protected void	doSend()
String	getCustomKey()
String	getFrom() The email from address
String	getHtml() The HTML for the email body
String	getReplyTo() The reply to address (optional)
String	getSubject() The email subject
String	getText() Plain text version of the email body
List<String>	getTos() A list of valid email addresses that we are sending to
String	getType()
protected void	init(EmailSettings emailSettings)
boolean	isShouldLog()
protected void	logEmail()
static EmailSender	newSender() Create a new instance of the default implementation for this application.
boolean	send() Send the email.
EmailSender	setCustomKey(String customKey)
EmailSender	setFrom(String from)
EmailSender	setHtml(String html)
EmailSender	setReplyTo(String replyTo)
EmailSender	setShouldLog(boolean shouldLog)
EmailSender	setSubject(String subject)
EmailSender	setText(String text)
EmailSender	setTo(String... tos)
EmailSender	setTos(List<String> tos)
EmailSender	setType(String type)
void	validate() Validate the email settings to make sure that a user, host, password, etc, have been set correctly.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailSender

public EmailSender()

EmailSender

public EmailSender(EmailSettings emailSettings)

Method Detail

newSender

public static EmailSender newSender()

Create a new instance of the default implementation for this application. TODO: allow the default implementation class to be configured via settings

Returns:

init

protected void init(EmailSettings emailSettings)

send

public boolean send()

Send the email.

Returns:

logEmail

protected void logEmail()

validate

public void validate()
              throws ValidationException

Validate the email settings to make sure that a user, host, password, etc, have been set correctly.

Throws:

ValidationException

doSend

protected void doSend()
               throws javax.mail.MessagingException,
                      EmailSendException,
                      ValidationException

Throws:

javax.mail.MessagingException

EmailSendException

ValidationException

getTos

public List<String> getTos()

A list of valid email addresses that we are sending to

Returns:

setTos

public EmailSender setTos(List<String> tos)

setTo

public EmailSender setTo(String... tos)

getFrom

public String getFrom()

The email from address

Returns:

setFrom

public EmailSender setFrom(String from)

getHtml

public String getHtml()

The HTML for the email body

Returns:

setHtml

public EmailSender setHtml(String html)

getText

public String getText()

Plain text version of the email body

Returns:

setText

public EmailSender setText(String text)

getReplyTo

public String getReplyTo()

The reply to address (optional)

Returns:

setReplyTo

public EmailSender setReplyTo(String replyTo)

getSubject

public String getSubject()

The email subject

Returns:

setSubject

public EmailSender setSubject(String subject)

getCustomKey

public String getCustomKey()

setCustomKey

public EmailSender setCustomKey(String customKey)

isShouldLog

public boolean isShouldLog()

setShouldLog

public EmailSender setShouldLog(boolean shouldLog)

getType

public String getType()

setType

public EmailSender setType(String type)