io.stallion.users

Class UserController.VerifyEmailEmailer

java.lang.Object

io.stallion.email.ContactableEmailer

io.stallion.users.UserController.VerifyEmailEmailer

Enclosing class:

UserController<T extends IUser>

public class UserController.VerifyEmailEmailer
extends ContactableEmailer

Field Summary

Fields inherited from class io.stallion.email.ContactableEmailer

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

Constructor Summary

Constructors

Constructor and Description
VerifyEmailEmailer(T user, Map<String,Object> context)
VerifyEmailEmailer(T user, String token, String returnUrl)

Method Summary

Modifier and Type	Method and Description
String	getSubject() Your email subject.
String	getTemplate() The path to the jinja template.
String	getUniqueKey() This is used to prevent accidentally sending duplicate emails, by default the uniqueKey is built from the subject, the contact id, the current week, and the email type.
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, 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

VerifyEmailEmailer

public VerifyEmailEmailer(T user,
                          Map<String,Object> context)

VerifyEmailEmailer

public VerifyEmailEmailer(T user,
                          String token,
                          String returnUrl)

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:

getUniqueKey

public String getUniqueKey()

Description copied from class: ContactableEmailer

This is used to prevent accidentally sending duplicate emails, by default the uniqueKey is built from the subject, the contact id, the current week, and the email type.

Overrides:

getUniqueKey in class ContactableEmailer

Returns: