io.stallion.email

Class JsExtendableContactableEmailer<T extends Contactable>

java.lang.Object

io.stallion.email.ContactableEmailer<T>

io.stallion.email.JsExtendableContactableEmailer<T>

Type Parameters:

T -

public abstract class JsExtendableContactableEmailer<T extends Contactable>
extends ContactableEmailer<T>

A version of the ContactableEmailer meant to be extended from Javascript. Every method that one would normally override now has a version that passes in the object. This is to prevent the problem whereby classes extended by nashorn do not get access to "this" So we have to manually pass in the instance as the first argument. It's like python all over again!

Field Summary

Fields inherited from class io.stallion.email.ContactableEmailer

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

Constructor Summary

Constructors

Constructor and Description
JsExtendableContactableEmailer(T user)
JsExtendableContactableEmailer(T user, Map<String,Object> context)

Method Summary

Modifier and Type	Method and Description
boolean	checkOptOut() Override this to check for additional conditions where the user might be opted out.
boolean	checkOptOut(JsExtendableContactableEmailer<T> self)
String	getCc() Override this to set a custom list of CC addresses
String	getCcJs(JsExtendableContactableEmailer<T> self)
String	getEmailType() The type of the email, used for logging, defaults to using the Java class name, can be overrident
String	getEmailType(JsExtendableContactableEmailer<T> self)
String	getFromAddress() Who is sending the email.
String	getFromAddressJs(JsExtendableContactableEmailer<T> self)
String	getReplyTo() Override this to set a custom-reply to address.
String	getReplyToJs(JsExtendableContactableEmailer<T> self)
String	getSubject() Your email subject.
abstract String	getSubjectJs(Object self)
String	getTemplate() The path to the jinja template.
abstract String	getTemplate(Object self)
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.
String	getUniqueKey(JsExtendableContactableEmailer<T> self)
protected void	onPrepareContext() Override this to prepare additional context variables.
protected void	onPrepareContext(JsExtendableContactableEmailer<T> self)

Methods inherited from class io.stallion.email.ContactableEmailer

checkDefaultOptOut, getContext, getSandbox, hasSeenKey, isTransactional, markSeenKey, 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

JsExtendableContactableEmailer

public JsExtendableContactableEmailer(T user)

JsExtendableContactableEmailer

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

Method Detail

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<T extends Contactable>

Returns:

getTemplate

public abstract String getTemplate(Object self)

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<T extends Contactable>

Returns:

getSubjectJs

public abstract String getSubjectJs(Object self)

getFromAddress

public String getFromAddress()

Description copied from class: ContactableEmailer

Who is sending the email. Defaults to email.defaultFromAddress in Stallion settings, or the first admin email if that does not exist, or the email user and host, if that doesn't exist.

Overrides:

getFromAddress in class ContactableEmailer<T extends Contactable>

Returns:

getFromAddressJs

public String getFromAddressJs(JsExtendableContactableEmailer<T> self)

getReplyTo

public String getReplyTo()

Description copied from class: ContactableEmailer

Override this to set a custom-reply to address.

Overrides:

getReplyTo in class ContactableEmailer<T extends Contactable>

Returns:

getReplyToJs

public String getReplyToJs(JsExtendableContactableEmailer<T> self)

getCc

public String getCc()

Description copied from class: ContactableEmailer

Override this to set a custom list of CC addresses

Overrides:

getCc in class ContactableEmailer<T extends Contactable>

Returns:

getCcJs

public String getCcJs(JsExtendableContactableEmailer<T> self)

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<T extends Contactable>

Returns:

getUniqueKey

public String getUniqueKey(JsExtendableContactableEmailer<T> self)

onPrepareContext

protected void onPrepareContext()

Description copied from class: ContactableEmailer

Override this to prepare additional context variables.

Overrides:

onPrepareContext in class ContactableEmailer<T extends Contactable>

onPrepareContext

protected void onPrepareContext(JsExtendableContactableEmailer<T> self)

getEmailType

public String getEmailType()

Description copied from class: ContactableEmailer

The type of the email, used for logging, defaults to using the Java class name, can be overrident

Overrides:

getEmailType in class ContactableEmailer<T extends Contactable>

Returns:

getEmailType

public String getEmailType(JsExtendableContactableEmailer<T> self)

checkOptOut

public boolean checkOptOut()

Description copied from class: ContactableEmailer

Override this to check for additional conditions where the user might be opted out.

Overrides:

checkOptOut in class ContactableEmailer<T extends Contactable>

Returns:

checkOptOut

public boolean checkOptOut(JsExtendableContactableEmailer<T> self)