io.stallion.email

Class AddressEmailer

java.lang.Object

io.stallion.email.ContactableEmailer

io.stallion.email.AddressEmailer

public class AddressEmailer
extends ContactableEmailer

Simple implementation of ContactableEmailer that can send an email jus using an email address, template, and email subject.

Field Summary

Fields inherited from class io.stallion.email.ContactableEmailer

dayStamp, hourStamp, minuteStamp, sandbox, templateUrl, user, weekStamp

Constructor Summary

Constructors

Constructor and Description
AddressEmailer(String emailAddress, String template, String subject)
AddressEmailer(String emailAddress, String template, String subject, Map<String,Object> context)

Method Summary

Modifier and Type	Method and Description
String	getSubject() Your email subject.
String	getTemplate() The path to the jinja template.
boolean	isTransactional() Return true if this is an email that opt-out should not apply to.

Methods inherited from class io.stallion.email.ContactableEmailer

checkDefaultOptOut, checkOptOut, getCc, getContext, getEmailType, getFromAddress, getReplyTo, getSandbox, getUniqueKey, hasSeenKey, markSeenKey, onPrepareContext, onPreSend, prepareContext, put, sendEmail, setSandbox, shouldLog, updateContext

Methods inherited from class java.lang.Object

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

Constructor Detail

AddressEmailer

public AddressEmailer(String emailAddress,
                      String template,
                      String subject)

AddressEmailer

public AddressEmailer(String emailAddress,
                      String template,
                      String subject,
                      Map<String,Object> context)

Parameters:

emailAddress -

template - - path to a jinja template

subject -

context - - gets passed to the template context

Method Detail

isTransactional

public boolean isTransactional()

Description copied from class: ContactableEmailer

Return true if this is an email that opt-out should not apply to. For example, return true for: password reset emails, security alerts, transaction reciepts. return false for all other emails that need an unsubscribe link, per CAN-SPAM laws.

Specified by:

isTransactional in class ContactableEmailer

Returns:

getTemplate

public String getTemplate()

Description copied from class: ContactableEmailer

The path to the jinja template. If the template is in a resource file, should be "pluginName:/my-template.jinja" where my-template.jinja is in the templates folder in your resources directory in your java project. If it is a built-in stallion template, use "stallion:/my-template.jinja"

Specified by:

getTemplate in class ContactableEmailer

Returns:

getSubject

public String getSubject()

Description copied from class: ContactableEmailer

Your email subject. This is interpreted as a SimpleTemplate -- so if you do "Hello, {{ contact.firstName }}" or "Hello, {{ myVar }}" then it will look-up the variable from the context and interpolate it.

Specified by:

getSubject in class ContactableEmailer

Returns: