com.sendgrid

Class SubscriptionTrackingSetting

java.lang.Object

com.sendgrid.SubscriptionTrackingSetting

public class SubscriptionTrackingSetting
extends java.lang.Object

A subscription tracking setting object. Subscription tracking allows you to insert a subscription management link at the bottom of the text and html bodies of your email. If you would like to specify the location of the link within your email, you may use the substitution_tag.

Constructor Summary

Constructors

Constructor and Description
SubscriptionTrackingSetting()

Method Summary

Modifier and Type	Method and Description
boolean	getEnable() Determines if this setting is enabled.
java.lang.String	getHtml() Get the HTML to be appended to the email, with the subscription tracking link.
java.lang.String	getSubstitutionTag() Get the tag that will be replaced with the unsubscribe URL.
java.lang.String	getText() Get the plain text to be appended to the email, with the subscription tracking link.
void	setEnable(boolean enable) Set if this setting is enabled.
void	setHtml(java.lang.String html) Set the HTML.
void	setSubstitutionTag(java.lang.String substitutionTag) Set the substitution tag.
void	setText(java.lang.String text) Set the plain text.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionTrackingSetting

public SubscriptionTrackingSetting()

Method Detail

getEnable

public boolean getEnable()

Determines if this setting is enabled.

Returns:

true if subscription tracking is enabled, false otherwise.

setEnable

public void setEnable(boolean enable)

Set if this setting is enabled.

Parameters:

enable - true if subscription tracking is enabled, false otherwise.

getText

public java.lang.String getText()

Get the plain text to be appended to the email, with the subscription tracking link. You may control where the link is by using the tag <% %>

Returns:

the plain text.

setText

public void setText(java.lang.String text)

Set the plain text.

Parameters:

text - the plain text.

getHtml

public java.lang.String getHtml()

Get the HTML to be appended to the email, with the subscription tracking link. You may control where the link is by using the tag <% %>

Returns:

the HTML.

setHtml

public void setHtml(java.lang.String html)

Set the HTML.

Parameters:

html - the HTML.

getSubstitutionTag

public java.lang.String getSubstitutionTag()

Get the tag that will be replaced with the unsubscribe URL. for example: [unsubscribe_url]. If this parameter is used, it will override both the text and html parameters. The URL of the link will be placed at the substitution tag’s location, with no additional formatting.

Returns:

the substitution tag.

setSubstitutionTag

public void setSubstitutionTag(java.lang.String substitutionTag)

Set the substitution tag.

Parameters:

substitutionTag - the substitution tag.