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

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

Add a category to the email.

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

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

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

Add a header to the email.

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

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.

addRequestHeader(String, String) - Method in interface com.sendgrid.SendGridAPI

Adds a request headers.

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

Add a section to the email.

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

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

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

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

api(Request) - Method in interface com.sendgrid.SendGridAPI

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

APICallback - Interface in com.sendgrid

An interface describing a callback mechanism for the asynchronous, rate limit aware API connection.

ASM - Class in com.sendgrid

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.

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

Attempt an API call.

attempt(Request, APICallback) - Method in class com.sendgrid.SendGrid

Attempt an API call.

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

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

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

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

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

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

equals(Object) - Method in class com.sendgrid.ASM

equals(Object) - Method in class com.sendgrid.Attachments

equals(Object) - Method in class com.sendgrid.BccSettings

equals(Object) - Method in class com.sendgrid.ClickTrackingSetting

equals(Object) - Method in class com.sendgrid.Content

equals(Object) - Method in class com.sendgrid.Email

equals(Object) - Method in class com.sendgrid.FooterSetting

equals(Object) - Method in class com.sendgrid.GoogleAnalyticsSetting

equals(Object) - Method in class com.sendgrid.Mail

equals(Object) - Method in class com.sendgrid.MailSettings

equals(Object) - Method in class com.sendgrid.OpenTrackingSetting

equals(Object) - Method in class com.sendgrid.Personalization

equals(Object) - Method in class com.sendgrid.Setting

equals(Object) - Method in class com.sendgrid.SpamCheckSetting

equals(Object) - Method in class com.sendgrid.SubscriptionTrackingSetting

equals(Object) - Method in class com.sendgrid.TrackingSettings

error(Exception) - Method in interface com.sendgrid.APICallback

Callback method in case of an error.

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

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

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

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

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

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

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

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

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

Get the email's categories.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Get the filename for this attachment.

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

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

Get the email's from address.

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

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

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

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

Get the email's headers.

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

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

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

getHost() - Method in interface com.sendgrid.SendGridAPI

Gets the host.

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

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

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.

getLibraryVersion() - Method in interface com.sendgrid.SendGridAPI

Returns the library version

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

Get the email's settings.

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

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

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

Get the email's personalizations.

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

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

Get the maximum number of retries on a rate limit response.

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

Get the duration of time (in milliseconds) to sleep between consecutive rate limit retries.

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

Get the email's reply to address.

getRequest() - Method in exception com.sendgrid.RateLimitException

Get the originating request object.

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

Obtain the request headers.

getRequestHeaders() - Method in interface com.sendgrid.SendGridAPI

Gets the request headers.

getRetryCount() - Method in exception com.sendgrid.RateLimitException

Get the number of times the action was attemted.

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

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

Get the email's sections.

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

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

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

Get the email's subject line.

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

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

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

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

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

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

Get the email's template ID.

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

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

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

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

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

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

Get the API version.

getVersion() - Method in interface com.sendgrid.SendGridAPI

Gets the version.

GoogleAnalyticsSetting - Class in com.sendgrid

An object configuring the tracking provided by Google Analytics.

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

H

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

headers - Variable in class com.sendgrid.Mail

The email's headers.

I

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

Initialize the client.

initializeSendGrid(String) - Method in interface com.sendgrid.SendGridAPI

Initializes SendGrid

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

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

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

Makes the call to the SendGrid API, override this method for testing.

makeCall(Request) - Method in interface com.sendgrid.SendGridAPI

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

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

R

RateLimitException - Exception in com.sendgrid

An exception thrown when the maximum number of retries have occurred, and the API calls are still rate limited.

RateLimitException(Request, int) - Constructor for exception com.sendgrid.RateLimitException

Construct a new exception.

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

Remove a request header.

removeRequestHeader(String) - Method in interface com.sendgrid.SendGridAPI

Removes a request headers.

replyTo - Variable in class com.sendgrid.Mail

The email's reply to address.

response(Response) - Method in interface com.sendgrid.APICallback

Callback method in case of a valid response.

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

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.

SendGridAPI - Interface in com.sendgrid

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Set the filename for this attachment.

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

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

Set the email's from address.

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

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

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

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

Set the SendGrid host.

setHost(String) - Method in interface com.sendgrid.SendGridAPI

Sets the host.

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

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

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

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

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

setRateLimitRetry(int) - Method in class com.sendgrid.SendGrid

Set the maximum number of retries on a rate limit response.

setRateLimitSleep(int) - Method in class com.sendgrid.SendGrid

Set the duration of time (in milliseconds) to sleep between consecutive rate limit retries.

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

Set the email's reply to address.

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

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

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

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

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

Set the email's subject line.

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

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

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

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

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

Set the email's template ID.

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

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

Setting - Class in com.sendgrid

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

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

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

Set the API version.

setVersion(String) - Method in interface com.sendgrid.SendGridAPI

Sets the 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

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