A B C E F G H I M O P R S T W

A

addAttachments(Attachments) - Method in class com.sendgrid.Mail

Add attachments to the email.

addBcc(Email) - Method in class com.sendgrid.Personalization

Add a recipient.

addCategory(String) - Method in class com.sendgrid.Mail

Add a category to the email.

addCc(Email) - Method in class com.sendgrid.Personalization

Add a recipient.

addContent(Content) - Method in class com.sendgrid.Mail

Add content to this email.

addCustomArg(String, String) - Method in class com.sendgrid.Mail

Add a custom argument to the email.

addCustomArg(String, String) - Method in class com.sendgrid.Personalization

Add a custom argument.

addHeader(String, String) - Method in class com.sendgrid.Mail

Add a header to the email.

addHeader(String, String) - Method in class com.sendgrid.Personalization

Add a header.

addPersonalization(Personalization) - Method in class com.sendgrid.Mail

Add a personalizaton to the email.

addRequestHeader(String, String) - Method in class com.sendgrid.SendGrid

Add a new request header.

addSection(String, String) - Method in class com.sendgrid.Mail

Add a section to the email.

addSubstitution(String, String) - Method in class com.sendgrid.Personalization

Add a substitusion.

addTo(Email) - Method in class com.sendgrid.Personalization

Add a recipient.

api(Request) - Method in class com.sendgrid.SendGrid

Class api sets up the request to the SendGrid API, this is main interface.

ASM - Class in com.sendgrid

An object allowing you to specify how to handle unsubscribes.

ASM() - Constructor for class com.sendgrid.ASM

asm - Variable in class com.sendgrid.Mail

The email's unsubscribe handling object.

Attachments - Class in com.sendgrid

An attachment object.

Attachments() - Constructor for class com.sendgrid.Attachments

attachments - Variable in class com.sendgrid.Mail

The email's attachments.

Attachments.Builder - Class in com.sendgrid

A helper object to construct usable attachments.

B

batchId - Variable in class com.sendgrid.Mail

This ID represents a batch of emails to be sent at the same time.

BccSettings - Class in com.sendgrid

This object allows you to have a blind carbon copy automatically sent to the specified email address for every email that is sent.

BccSettings() - Constructor for class com.sendgrid.BccSettings

build() - Method in class com.sendgrid.Attachments.Builder

Construct the attachments object.

build() - Method in class com.sendgrid.Mail

Create a string represenation of the Mail object JSON.

Builder(String, InputStream) - Constructor for class com.sendgrid.Attachments.Builder

Construct a new attachment builder.

Builder(String, String) - Constructor for class com.sendgrid.Attachments.Builder

Construct a new attachment builder.

buildPretty() - Method in class com.sendgrid.Mail

Create a string represenation of the Mail object JSON and pretty print it.

C

categories - Variable in class com.sendgrid.Mail

The email's categories.

ClickTrackingSetting - Class in com.sendgrid

Settings to determine how you would like to track the metrics of how your recipients interact with your email.

ClickTrackingSetting() - Constructor for class com.sendgrid.ClickTrackingSetting

com.sendgrid - package com.sendgrid

Content - Class in com.sendgrid

An object in which you may specify the content of your email.

Content() - Constructor for class com.sendgrid.Content

Construct an empty content object.

Content(String, String) - Constructor for class com.sendgrid.Content

Construct a content object with the specified type and value.

content - Variable in class com.sendgrid.Mail

The email's content.

customArgs - Variable in class com.sendgrid.Mail

The email's custom arguments.

E

Email - Class in com.sendgrid

An email address represented as an address name pair.

Email() - Constructor for class com.sendgrid.Email

Construct an empty email.

Email(String) - Constructor for class com.sendgrid.Email

Construct an email with the supplied email and an empty name.

Email(String, String) - Constructor for class com.sendgrid.Email

Construct an email with the supplied address and name.

F

FooterSetting - Class in com.sendgrid

An object representing the default footer that you would like included on every email.

FooterSetting() - Constructor for class com.sendgrid.FooterSetting

from - Variable in class com.sendgrid.Mail

The email's from field.

G

getASM() - Method in class com.sendgrid.Mail

Get the email's unsubscribe handling object (ASM).

getAttachments() - Method in class com.sendgrid.Mail

Get the email's attachments.

getBatchId() - Method in class com.sendgrid.Mail

Get the email's batch ID.

getBccs() - Method in class com.sendgrid.Personalization

Set the BCC list.

getBccSettings() - Method in class com.sendgrid.MailSettings

Get the BCC settings.

getBypassListManagement() - Method in class com.sendgrid.MailSettings

A setting that allows you to bypass all unsubscribe groups and suppressions to ensure that the email is delivered to every single recipient.

getCampaignContent() - Method in class com.sendgrid.GoogleAnalyticsSetting

Get the content Used to differentiate your campaign from advertisements.

getCampaignMedium() - Method in class com.sendgrid.GoogleAnalyticsSetting

Get the name of the marketing medium.

getCampaignName() - Method in class com.sendgrid.GoogleAnalyticsSetting

Get the name of the campaign.

getCampaignSource() - Method in class com.sendgrid.GoogleAnalyticsSetting

Get the name of the referrer source.

getCampaignTerm() - Method in class com.sendgrid.GoogleAnalyticsSetting

Get the term used to identify any paid keywords.

getCategories() - Method in class com.sendgrid.Mail

Get the email's categories.

getCcs() - Method in class com.sendgrid.Personalization

Set the CC list.

getClickTrackingSetting() - Method in class com.sendgrid.TrackingSettings

Get the click tracking setting.

getContent() - Method in class com.sendgrid.Attachments

Get the attachment's content.

getContent() - Method in class com.sendgrid.Mail

Get the email's content.

getContentId() - Method in class com.sendgrid.Attachments

Get the attachment content ID.

getCustomArgs() - Method in class com.sendgrid.Mail

Get the email's custom arguments.

getCustomArgs() - Method in class com.sendgrid.Personalization

Get the custom arguments.

getDisposition() - Method in class com.sendgrid.Attachments

Get the content-disposition of the attachment specifying how you would like the attachment to be displayed.

getEmail() - Method in class com.sendgrid.BccSettings

Get the email address that you would like to receive the BCC.

getEmail() - Method in class com.sendgrid.Email

Get the email address.

getEnable() - Method in class com.sendgrid.BccSettings

Determines if this setting is enabled.

getEnable() - Method in class com.sendgrid.ClickTrackingSetting

Determines if this setting is enabled.

getEnable() - Method in class com.sendgrid.FooterSetting

Get whether or not the footer is enabled.

getEnable() - Method in class com.sendgrid.GoogleAnalyticsSetting

Get whether or not this setting is enabled.

getEnable() - Method in class com.sendgrid.OpenTrackingSetting

Determines if this setting is enabled.

getEnable() - Method in class com.sendgrid.Setting

Get whether or not this setting is enabled.

getEnable() - Method in class com.sendgrid.SpamCheckSetting

Determines if this setting is enabled.

getEnable() - Method in class com.sendgrid.SubscriptionTrackingSetting

Determines if this setting is enabled.

getEnableText() - Method in class com.sendgrid.ClickTrackingSetting

Get the enabled text.

getFilename() - Method in class com.sendgrid.Attachments

Get the filename for this attachment.

getFooterSetting() - Method in class com.sendgrid.MailSettings

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

getFrom() - Method in class com.sendgrid.Mail

Get the email's from address.

getGoogleAnalyticsSetting() - Method in class com.sendgrid.TrackingSettings

Get the Google Analytics setting.

getGroupId() - Method in class com.sendgrid.ASM

Get the group ID.

getGroupsToDisplay() - Method in class com.sendgrid.ASM

Get the groups to display.

getHeaders() - Method in class com.sendgrid.Mail

Get the email's headers.

getHeaders() - Method in class com.sendgrid.Personalization

Get the headers.

getHost() - Method in class com.sendgrid.SendGrid

Get the SendGrid host (api.sendgrid.com by default).

getHtml() - Method in class com.sendgrid.FooterSetting

Get the HTML content of the footer.

getHtml() - Method in class com.sendgrid.SubscriptionTrackingSetting

Get the HTML to be appended to the email, with the subscription tracking link.

getIpPoolId() - Method in class com.sendgrid.Mail

Get the email's IP pool ID.

getLibraryVersion() - Method in class com.sendgrid.SendGrid

Retrieve the current library version.

getMailSettings() - Method in class com.sendgrid.Mail

Get the email's settings.

getName() - Method in class com.sendgrid.Email

Get the name.

getOpenTrackingSetting() - Method in class com.sendgrid.TrackingSettings

Get the open tracking setting.

getPersonalization() - Method in class com.sendgrid.Mail

Get the email's personalizations.

getPostToUrl() - Method in class com.sendgrid.SpamCheckSetting

Get the Inbound Parse URL that you would like a copy of your email along with the spam report to be sent to.

getReplyto() - Method in class com.sendgrid.Mail

Get the email's reply to address.

getRequestHeaders() - Method in class com.sendgrid.SendGrid

Obtain the request headers.

getSandBoxMode() - Method in class com.sendgrid.MailSettings

Get sandbox mode.

getSections() - Method in class com.sendgrid.Mail

Get the email's sections.

getSpamCheck() - Method in class com.sendgrid.MailSettings

Get the spam check setting.

getSpamThreshold() - Method in class com.sendgrid.SpamCheckSetting

Get the the threshold used to determine if your content qualifies as spam on a scale from 1 to 10, with 10 being most strict, or most likely to be considered as spam.

getSubject() - Method in class com.sendgrid.Mail

Get the email's subject line.

getSubject() - Method in class com.sendgrid.Personalization

Get the subject of the email.

getSubscriptionTrackingSetting() - Method in class com.sendgrid.TrackingSettings

Get the subscription tracking setting.

getSubstitutions() - Method in class com.sendgrid.Personalization

Get the substitusions.

getSubstitutionTag() - Method in class com.sendgrid.OpenTrackingSetting

Get the substituion tag.

getSubstitutionTag() - Method in class com.sendgrid.SubscriptionTrackingSetting

Get the tag that will be replaced with the unsubscribe URL.

getTemplateId() - Method in class com.sendgrid.Mail

Get the email's template ID.

getText() - Method in class com.sendgrid.FooterSetting

Get the plain text content of the footer.

getText() - Method in class com.sendgrid.SubscriptionTrackingSetting

Get the plain text to be appended to the email, with the subscription tracking link.

getTos() - Method in class com.sendgrid.Personalization

Get the to list.

getTrackingSettings() - Method in class com.sendgrid.Mail

Get the email's tracking settings.

getType() - Method in class com.sendgrid.Attachments

Get the mime type of the content you are attaching.

getType() - Method in class com.sendgrid.Content

Get the mime type of the content you are including in your email.

getValue() - Method in class com.sendgrid.Content

Get the actual content of the specified mime type that you are including in your email.

getVersion() - Method in class com.sendgrid.SendGrid

Get the API version.

GoogleAnalyticsSetting - Class in com.sendgrid

An object configuring the tracking provided by Google Analytics.

GoogleAnalyticsSetting() - Constructor for class com.sendgrid.GoogleAnalyticsSetting

H

headers - Variable in class com.sendgrid.Mail

The email's headers.

I

initializeSendGrid(String) - Method in class com.sendgrid.SendGrid

Initialize the client.

ipPoolId - Variable in class com.sendgrid.Mail

The email's IP pool name.

M

Mail - Class in com.sendgrid

Class Mail builds an object that sends an email through SendGrid.

Mail() - Constructor for class com.sendgrid.Mail

Construct a new Mail object.

Mail(Email, String, Email, Content) - Constructor for class com.sendgrid.Mail

Construct a new Mail object.

mailSettings - Variable in class com.sendgrid.Mail

The email's mail settings.

MailSettings - Class in com.sendgrid

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

MailSettings() - Constructor for class com.sendgrid.MailSettings

makeCall(Request) - Method in class com.sendgrid.SendGrid

Class makeCall makes the call to the SendGrid API, override this method for testing.

O

OpenTrackingSetting - Class in com.sendgrid

An open tracking settings object.

OpenTrackingSetting() - Constructor for class com.sendgrid.OpenTrackingSetting

P

personalization - Variable in class com.sendgrid.Mail

The email's personalization.

Personalization - Class in com.sendgrid

An object representing a message and its metadata.

Personalization() - Constructor for class com.sendgrid.Personalization

R

removeRequestHeader(String) - Method in class com.sendgrid.SendGrid

Remove a request header.

replyTo - Variable in class com.sendgrid.Mail

The email's reply to address.

S

sections - Variable in class com.sendgrid.Mail

The email's sections.

sendAt - Variable in class com.sendgrid.Mail

A unix timestamp allowing you to specify when you want your email to be delivered.

sendAt() - Method in class com.sendgrid.Mail

Get the email's send at time (Unix timestamp).

sendAt() - Method in class com.sendgrid.Personalization

Get the send at time.

SendGrid - Class in com.sendgrid

Class SendGrid allows for quick and easy access to the SendGrid API.

SendGrid(String) - Constructor for class com.sendgrid.SendGrid

Construct a new SendGrid API wrapper.

SendGrid(String, Boolean) - Constructor for class com.sendgrid.SendGrid

Construct a new SendGrid API wrapper.

SendGrid(String, Client) - Constructor for class com.sendgrid.SendGrid

Construct a new SendGrid API wrapper.

setASM(ASM) - Method in class com.sendgrid.Mail

Set the email's unsubscribe handling object (ASM).

setBatchId(String) - Method in class com.sendgrid.Mail

Set the email's batch ID.

setBccSettings(BccSettings) - Method in class com.sendgrid.MailSettings

Set the BCC settings.

setBypassListManagement(Setting) - Method in class com.sendgrid.MailSettings

Set the bypass setting.

setCampaignContent(String) - Method in class com.sendgrid.GoogleAnalyticsSetting

Set the content Used to differentiate your campaign from advertisements.

setCampaignMedium(String) - Method in class com.sendgrid.GoogleAnalyticsSetting

Set the name of the marketing medium.

setCampaignName(String) - Method in class com.sendgrid.GoogleAnalyticsSetting

Set the name of the campaign.

setCampaignSource(String) - Method in class com.sendgrid.GoogleAnalyticsSetting

Set the name of the referrer source.

setCampaignTerm(String) - Method in class com.sendgrid.GoogleAnalyticsSetting

Set the term used to identify any paid keywords.

setClickTrackingSetting(ClickTrackingSetting) - Method in class com.sendgrid.TrackingSettings

Set the click tracking setting.

setContent(String) - Method in class com.sendgrid.Attachments

Set the attachment's content.

setContentId(String) - Method in class com.sendgrid.Attachments

Set the content ID.

setDisposition(String) - Method in class com.sendgrid.Attachments

Set the content-disposition of the attachment.

setEmail(String) - Method in class com.sendgrid.BccSettings

Set the email address that you would like to receive the BCC.

setEmail(String) - Method in class com.sendgrid.Email

Set the email address.

setEnable(boolean) - Method in class com.sendgrid.BccSettings

Set whether or not BCC is enabled.

setEnable(boolean) - Method in class com.sendgrid.ClickTrackingSetting

Set if this setting is enabled.

setEnable(boolean) - Method in class com.sendgrid.FooterSetting

Set whether or not the footer is enabled.

setEnable(boolean) - Method in class com.sendgrid.GoogleAnalyticsSetting

Set whether or not this setting is enabled.

setEnable(boolean) - Method in class com.sendgrid.OpenTrackingSetting

Set if this setting is enabled.

setEnable(boolean) - Method in class com.sendgrid.Setting

Set whether or not this setting is enabled.

setEnable(boolean) - Method in class com.sendgrid.SpamCheckSetting

Set if this setting is enabled.

setEnable(boolean) - Method in class com.sendgrid.SubscriptionTrackingSetting

Set if this setting is enabled.

setEnableText(boolean) - Method in class com.sendgrid.ClickTrackingSetting

Set the enalbed text.

setFilename(String) - Method in class com.sendgrid.Attachments

Set the filename for this attachment.

setFooterSetting(FooterSetting) - Method in class com.sendgrid.MailSettings

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

setFrom(Email) - Method in class com.sendgrid.Mail

Set the email's from address.

setGoogleAnalyticsSetting(GoogleAnalyticsSetting) - Method in class com.sendgrid.TrackingSettings

Set the Google Analytics setting.

setGroupId(int) - Method in class com.sendgrid.ASM

Set the group ID.

setGroupsToDisplay(int[]) - Method in class com.sendgrid.ASM

Set the groups to display.

setHost(String) - Method in class com.sendgrid.SendGrid

Set the SendGrid host.

setHtml(String) - Method in class com.sendgrid.FooterSetting

Set the HTML content of the footer.

setHtml(String) - Method in class com.sendgrid.SubscriptionTrackingSetting

Set the HTML.

setIpPoolId(String) - Method in class com.sendgrid.Mail

Set the email's IP pool ID.

setMailSettings(MailSettings) - Method in class com.sendgrid.Mail

Set the email's settings.

setName(String) - Method in class com.sendgrid.Email

Set the name.

setOpenTrackingSetting(OpenTrackingSetting) - Method in class com.sendgrid.TrackingSettings

Set the open tracking setting.

setPostToUrl(String) - Method in class com.sendgrid.SpamCheckSetting

Set the Inbout Parse URL.

setReplyTo(Email) - Method in class com.sendgrid.Mail

Set the email's reply to address.

setSandboxMode(Setting) - Method in class com.sendgrid.MailSettings

Set sandbox mode.

setSendAt(long) - Method in class com.sendgrid.Mail

Set the email's send at time (Unix timestamp).

setSendAt(long) - Method in class com.sendgrid.Personalization

Set the send at time.

setSpamCheckSetting(SpamCheckSetting) - Method in class com.sendgrid.MailSettings

Set the spam check setting.

setSpamThreshold(int) - Method in class com.sendgrid.SpamCheckSetting

Set the spam check threshold.

setSubject(String) - Method in class com.sendgrid.Mail

Set the email's subject line.

setSubject(String) - Method in class com.sendgrid.Personalization

Set the subject of the email.

setSubscriptionTrackingSetting(SubscriptionTrackingSetting) - Method in class com.sendgrid.TrackingSettings

Set the subscription tracking setting.

setSubstitutionTag(String) - Method in class com.sendgrid.OpenTrackingSetting

Set the substitution tag.

setSubstitutionTag(String) - Method in class com.sendgrid.SubscriptionTrackingSetting

Set the substitution tag.

setTemplateId(String) - Method in class com.sendgrid.Mail

Set the email's template ID.

setText(String) - Method in class com.sendgrid.FooterSetting

Set the plain text content of the footer.

setText(String) - Method in class com.sendgrid.SubscriptionTrackingSetting

Set the plain text.

Setting - Class in com.sendgrid

A generic setting object.

Setting() - Constructor for class com.sendgrid.Setting

setTrackingSettings(TrackingSettings) - Method in class com.sendgrid.Mail

Set the email's tracking settings.

setType(String) - Method in class com.sendgrid.Attachments

Set the mime type of the content.

setType(String) - Method in class com.sendgrid.Content

Set the mime type of the content you are including in your email.

setValue(String) - Method in class com.sendgrid.Content

Set the actual content of the specified mime type that you are including in your email.

setVersion(String) - Method in class com.sendgrid.SendGrid

Set the API version.

SpamCheckSetting - Class in com.sendgrid

A setting object that allows you to test the content of your email for spam.

SpamCheckSetting() - Constructor for class com.sendgrid.SpamCheckSetting

subject - Variable in class com.sendgrid.Mail

The email's subject line.

SubscriptionTrackingSetting - Class in com.sendgrid

A subscription tracking setting object.

SubscriptionTrackingSetting() - Constructor for class com.sendgrid.SubscriptionTrackingSetting

T

templateId - Variable in class com.sendgrid.Mail

The email's template ID.

trackingSettings - Variable in class com.sendgrid.Mail

The email's tracking settings.

TrackingSettings - Class in com.sendgrid

An object representing the settings to determine how you would like to track the metrics of how your recipients interact with your email.

TrackingSettings() - Constructor for class com.sendgrid.TrackingSettings

W

withContentId(String) - Method in class com.sendgrid.Attachments.Builder

Set the content ID of this attachment builder.

withDisposition(String) - Method in class com.sendgrid.Attachments.Builder

Set the disposition of this attachment builder.

withType(String) - Method in class com.sendgrid.Attachments.Builder

Set the type of this attachment builder.

A B C E F G H I M O P R S T W