com.sendgrid.helpers.mail.objects

Class MailSettings

java.lang.Object

com.sendgrid.helpers.mail.objects.MailSettings

public class MailSettings
extends Object

An object representing a collection of different mail settings that you can use to specify how you would like this email to be handled.

Constructor Summary

Constructors

Constructor and Description
MailSettings()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BccSettings	getBccSettings()
Setting	getBypassBounceManagement() Allows you to bypass the bounce list to ensure that the email is delivered to recipients.
Setting	getBypassListManagement() A setting that allows you to bypass all unsubscribe groups and suppressions to ensure that the email is delivered to every single recipient.
Setting	getBypassSpamManagement() Allows you to bypass the spam report list to ensure that the email is delivered to recipients.
Setting	getBypassUnsubscribeManagement() Allows you to bypass the global unsubscribe list to ensure that the email is delivered to recipients.
FooterSetting	getFooterSetting() Get the footer settings that you would like included on every email.
Setting	getSandBoxMode() Get sandbox mode.
SpamCheckSetting	getSpamCheck() Get the spam check setting.
int	hashCode()
void	setBccSettings(BccSettings bccSettings) Set the BCC settings.
void	setBypassBounceManagement(Setting bypassBounceManagement)
void	setBypassListManagement(Setting bypassListManagement)
void	setBypassSpamManagement(Setting bypassSpamManagement)
void	setBypassUnsubscribeManagement(Setting bypassUnsubscribeManagement)
void	setFooterSetting(FooterSetting footerSetting) Set the footer settings that you would like included on every email.
void	setSandboxMode(Setting sandBoxMode) Set sandbox mode.
void	setSpamCheckSetting(SpamCheckSetting spamCheckSetting) Set the spam check setting.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailSettings

public MailSettings()

Method Detail

getBccSettings

public BccSettings getBccSettings()

setBccSettings

public void setBccSettings(BccSettings bccSettings)

Set the BCC settings.

Parameters:

bccSettings - the BCC settings.

getBypassListManagement

public Setting getBypassListManagement()

A setting that allows you to bypass all unsubscribe groups and suppressions to ensure that the email is delivered to every single recipient. This should only be used in emergencies when it is absolutely necessary that every recipient receives your email.

Returns:

the bypass list setting.

setBypassListManagement

public void setBypassListManagement(Setting bypassListManagement)

getBypassSpamManagement

public Setting getBypassSpamManagement()

Allows you to bypass the spam report list to ensure that the email is delivered to recipients. Bounce and unsubscribe lists will still be checked; addresses on these other lists will not receive the message. This filter cannot be combined with the bypass_list_management filter.

Returns:

the bypass spam setting

setBypassSpamManagement

public void setBypassSpamManagement(Setting bypassSpamManagement)

getBypassBounceManagement

public Setting getBypassBounceManagement()

Allows you to bypass the bounce list to ensure that the email is delivered to recipients. Spam report and unsubscribe lists will still be checked; addresses on these other lists will not receive the message. This filter cannot be combined with the bypass_list_management filter.

Returns:

the bypass bounce setting

setBypassBounceManagement

public void setBypassBounceManagement(Setting bypassBounceManagement)

getBypassUnsubscribeManagement

public Setting getBypassUnsubscribeManagement()

Allows you to bypass the global unsubscribe list to ensure that the email is delivered to recipients. Bounce and spam report lists will still be checked; addresses on these other lists will not receive the message. This filter applies only to global unsubscribes and will not bypass group unsubscribes. This filter cannot be combined with the bypass_list_management filter.

Returns:

the bypass unsubscribe setting

setBypassUnsubscribeManagement

public void setBypassUnsubscribeManagement(Setting bypassUnsubscribeManagement)

getFooterSetting

public FooterSetting getFooterSetting()

Get the footer settings that you would like included on every email.

Returns:

the setting.

setFooterSetting

public void setFooterSetting(FooterSetting footerSetting)

Set the footer settings that you would like included on every email.

Parameters:

footerSetting - the setting.

getSandBoxMode

public Setting getSandBoxMode()

Get sandbox mode. This allows you to send a test email to ensure that your request body is valid and formatted correctly.

Returns:

the sandbox mode setting.

setSandboxMode

public void setSandboxMode(Setting sandBoxMode)

Set sandbox mode.

Parameters:

sandBoxMode - the sandbox mode setting.

getSpamCheck

public SpamCheckSetting getSpamCheck()

Get the spam check setting. This allows you to test the content of your email for spam.

Returns:

the spam check setting.

setSpamCheckSetting

public void setSpamCheckSetting(SpamCheckSetting spamCheckSetting)

Set the spam check setting. This allows you to test the content of your email for spam.

Parameters:

spamCheckSetting - the spam check setting.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object