Mail (Twilio SendGrid Java helper library 4.9.3 API)

java.lang.Object
- com.sendgrid.helpers.mail.Mail

```
public class Mail
extends Object
```
Class Mail builds an object that sends an email through Twilio SendGrid. Note that this object is not thread safe.

Field Summary

Fields
Modifier and Type	Field and Description
`ASM`	`asm` The email's unsubscribe handling object.
`List<Attachments>`	`attachments` The email's attachments.
`String`	`batchId` This ID represents a batch of emails to be sent at the same time.
`List<String>`	`categories` The email's categories.
`List<Content>`	`content` The email's content.
`Map<String,String>`	`customArgs` The email's custom arguments.
`Email`	`from` The email's from field.
`Map<String,String>`	`headers` The email's headers.
`String`	`ipPoolId` The email's IP pool name.
`MailSettings`	`mailSettings` The email's mail settings.
`List<Personalization>`	`personalization` The email's personalization.
`Email`	`replyTo` The email's reply to address.
`Map<String,String>`	`sections` The email's sections.
`long`	`sendAt` A unix timestamp allowing you to specify when you want your email to be delivered.
`String`	`subject` The email's subject line.
`String`	`templateId` The email's template ID.
`TrackingSettings`	`trackingSettings` The email's tracking settings.

Constructor Summary

Constructors
Constructor and Description

Mail()
Construct a new Mail object.

Mail(Email from, String subject, Email to, Content content)
Construct a new Mail object.

Constructors
Constructor and Description
`Mail()` Construct a new Mail object.
`Mail(Email from, String subject, Email to, Content content)` Construct a new Mail object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttachments(Attachments attachments)` Add attachments to the email.
`void`	`addCategory(String category)` Add a category to the email.
`void`	`addContent(Content content)` Add content to this email.
`void`	`addCustomArg(String key, String value)` Add a custom argument to the email.
`void`	`addHeader(String key, String value)` Add a header to the email.
`void`	`addPersonalization(Personalization personalization)` Add a personalization to the email.
`void`	`addSection(String key, String value)` Add a section to the email.
`String`	`build()` Create a string representation of the Mail object JSON.
`String`	`buildPretty()` Create a string representation of the Mail object JSON and pretty print it.
`boolean`	`equals(Object obj)`
`ASM`	`getASM()` Get the email's unsubscribe handling object (ASM).
`List<Attachments>`	`getAttachments()` Get the email's attachments.
`String`	`getBatchId()` Get the email's batch ID.
`List<String>`	`getCategories()` Get the email's categories.
`List<Content>`	`getContent()` Get the email's content.
`Map<String,String>`	`getCustomArgs()` Get the email's custom arguments.
`Email`	`getFrom()` Get the email's from address.
`Map<String,String>`	`getHeaders()` Get the email's headers.
`String`	`getIpPoolId()` Get the email's IP pool ID.
`MailSettings`	`getMailSettings()` Get the email's settings.
`List<Personalization>`	`getPersonalization()` Get the email's personalizations.
`Email`	`getReplyto()` Get the email's reply to address.
`Map<String,String>`	`getSections()` Get the email's sections.
`String`	`getSubject()` Get the email's subject line.
`String`	`getTemplateId()` Get the email's template ID.
`TrackingSettings`	`getTrackingSettings()` Get the email's tracking settings.
`int`	`hashCode()`
`long`	`sendAt()` Get the email's send at time (Unix timestamp).
`void`	`setASM(ASM asm)` Set the email's unsubscribe handling object (ASM).
`void`	`setBatchId(String batchId)` Set the email's batch ID.
`void`	`setFrom(Email from)` Set the email's from address.
`void`	`setIpPoolId(String ipPoolId)` Set the email's IP pool ID.
`void`	`setMailSettings(MailSettings mailSettings)` Set the email's settings.
`void`	`setReplyTo(Email replyTo)` Set the email's reply to address.
`void`	`setSendAt(long sendAt)` Set the email's send at time (Unix timestamp).
`void`	`setSubject(String subject)` Set the email's subject line.
`void`	`setTemplateId(String templateId)` Set the email's template ID.
`void`	`setTrackingSettings(TrackingSettings trackingSettings)` Set the email's tracking settings.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - from
```
public Email from
```
    The email's from field.
  - subject
```
public String subject
```
    The email's subject line. This is the global, or “message level”, subject of your email. This may be overridden by personalizations[x].subject.
  - personalization
```
public List<Personalization> personalization
```
    The email's personalization. Each object within personalizations can be thought of as an envelope - it defines who should receive an individual message and how that message should be handled.
  - content
```
public List<Content> content
```
    The email's content.
  - attachments
```
public List<Attachments> attachments
```
    The email's attachments.
  - templateId
```
public String templateId
```
    The email's template ID.
  - sections
```
public Map<String,String> sections
```
    The email's sections. An object of key/value pairs that define block sections of code to be used as substitutions.
  - headers
```
public Map<String,String> headers
```
    The email's headers.
  - categories
```
public List<String> categories
```
    The email's categories.
  - customArgs
```
public Map<String,String> customArgs
```
    The email's custom arguments. Values that are specific to the entire send that will be carried along with the email and its activity data. Substitutions will not be made on custom arguments, so any string that is entered into this parameter will be assumed to be the custom argument that you would like to be used. This parameter is overridden by personalizations[x].custom_args if that parameter has been defined. Total custom args size may not exceed 10,000 bytes.
  - sendAt
```
public long sendAt
```
    A unix timestamp allowing you to specify when you want your email to be delivered. This may be overridden by the personalizations[x].send_at parameter. Scheduling more than 72 hours in advance is forbidden.
  - batchId
```
public String batchId
```
    This ID represents a batch of emails to be sent at the same time. Including a batch_id in your request allows you include this email in that batch, and also enables you to cancel or pause the delivery of that batch. For more information, see https://sendgrid.com/docs/API_Reference/Web_API_v3/cancel_schedule_send.
  - asm
```
public ASM asm
```
    The email's unsubscribe handling object.
  - ipPoolId
```
public String ipPoolId
```
    The email's IP pool name.
  - mailSettings
```
public MailSettings mailSettings
```
    The email's mail settings.
  - trackingSettings
```
public TrackingSettings trackingSettings
```
    The email's tracking settings.
  - replyTo
```
public Email replyTo
```
    The email's reply to address.
- Constructor Detail
  - Mail
```
public Mail()
```
    Construct a new Mail object.
  - Mail
```
public Mail(Email from,
            String subject,
            Email to,
            Content content)
```
    Construct a new Mail object.
    
    Parameters:
    
    from - the email's from address.
    
    subject - the email's subject line.
    
    to - the email's recipient.
    
    content - the email's content.
- Method Detail
  - getFrom
```
public Email getFrom()
```
    Get the email's from address.
    
    Returns:
    
    the email's from address.
  - setFrom
```
public void setFrom(Email from)
```
    Set the email's from address.
    
    Parameters:
    
    from - the email's from address.
  - getSubject
```
public String getSubject()
```
    Get the email's subject line.
    
    Returns:
    
    the email's subject line.
  - setSubject
```
public void setSubject(String subject)
```
    Set the email's subject line.
    
    Parameters:
    
    subject - the email's subject line.
  - getASM
```
public ASM getASM()
```
    Get the email's unsubscribe handling object (ASM).
    
    Returns:
    
    the email's ASM.
  - setASM
```
public void setASM(ASM asm)
```
    Set the email's unsubscribe handling object (ASM).
    
    Parameters:
    
    asm - the email's ASM.
  - getPersonalization
```
public List<Personalization> getPersonalization()
```
    Get the email's personalizations. Content added to the returned list will be included when sent.
    
    Returns:
    
    the email's personalizations.
  - addPersonalization
```
public void addPersonalization(Personalization personalization)
```
    Add a personalization to the email.
    
    Parameters:
    
    personalization - a personalization.
  - getContent
```
public List<Content> getContent()
```
    Get the email's content. Content added to the returned list will be included when sent.
    
    Returns:
    
    the email's content.
  - addContent
```
public void addContent(Content content)
```
    Add content to this email.
    
    Parameters:
    
    content - content to add to this email.
  - getAttachments
```
public List<Attachments> getAttachments()
```
    Get the email's attachments. Attachments added to the returned list will be included when sent.
    
    Returns:
    
    the email's attachments.
  - addAttachments
```
public void addAttachments(Attachments attachments)
```
    Add attachments to the email.
    
    Parameters:
    
    attachments - attachments to add.
  - getTemplateId
```
public String getTemplateId()
```
    Get the email's template ID.
    
    Returns:
    
    the email's template ID.
  - setTemplateId
```
public void setTemplateId(String templateId)
```
    Set the email's template ID.
    
    Parameters:
    
    templateId - the email's template ID.
  - getSections
```
public Map<String,String> getSections()
```
    Get the email's sections. Sections added to the returned list will be included when sent.
    
    Returns:
    
    the email's sections.
  - addSection
```
public void addSection(String key,
                       String value)
```
    Add a section to the email.
    
    Parameters:
    
    key - the section's key.
    
    value - the section's value.
  - getHeaders
```
public Map<String,String> getHeaders()
```
    Get the email's headers. Headers added to the returned list will be included when sent.
    
    Returns:
    
    the email's headers.
  - addHeader
```
public void addHeader(String key,
                      String value)
```
    Add a header to the email.
    
    Parameters:
    
    key - the header's key.
    
    value - the header's value.
  - getCategories
```
public List<String> getCategories()
```
    Get the email's categories. Categories added to the returned list will be included when sent.
    
    Returns:
    
    the email's categories.
  - addCategory
```
public void addCategory(String category)
```
    Add a category to the email.
    
    Parameters:
    
    category - the category.
  - getCustomArgs
```
public Map<String,String> getCustomArgs()
```
    Get the email's custom arguments. Custom arguments added to the returned list will be included when sent.
    
    Returns:
    
    the email's custom arguments.
  - addCustomArg
```
public void addCustomArg(String key,
                         String value)
```
    Add a custom argument to the email.
    
    Parameters:
    
    key - argument's key.
    
    value - the argument's value.
  - sendAt
```
public long sendAt()
```
    Get the email's send at time (Unix timestamp).
    
    Returns:
    
    the email's send at time.
  - setSendAt
```
public void setSendAt(long sendAt)
```
    Set the email's send at time (Unix timestamp).
    
    Parameters:
    
    sendAt - the send at time.
  - getBatchId
```
public String getBatchId()
```
    Get the email's batch ID.
    
    Returns:
    
    the batch ID.
  - setBatchId
```
public void setBatchId(String batchId)
```
    Set the email's batch ID.
    
    Parameters:
    
    batchId - the batch ID.
  - getIpPoolId
```
public String getIpPoolId()
```
    Get the email's IP pool ID.
    
    Returns:
    
    the IP pool ID.
  - setIpPoolId
```
public void setIpPoolId(String ipPoolId)
```
    Set the email's IP pool ID.
    
    Parameters:
    
    ipPoolId - the IP pool ID.
  - getMailSettings
```
public MailSettings getMailSettings()
```
    Get the email's settings.
    
    Returns:
    
    the settings.
  - setMailSettings
```
public void setMailSettings(MailSettings mailSettings)
```
    Set the email's settings.
    
    Parameters:
    
    mailSettings - the settings.
  - getTrackingSettings
```
public TrackingSettings getTrackingSettings()
```
    Get the email's tracking settings.
    
    Returns:
    
    the tracking settings.
  - setTrackingSettings
```
public void setTrackingSettings(TrackingSettings trackingSettings)
```
    Set the email's tracking settings.
    
    Parameters:
    
    trackingSettings - the tracking settings.
  - getReplyto
```
public Email getReplyto()
```
    Get the email's reply to address.
    
    Returns:
    
    the reply to address.
  - setReplyTo
```
public void setReplyTo(Email replyTo)
```
    Set the email's reply to address.
    
    Parameters:
    
    replyTo - the reply to address.
  - build
```
public String build()
             throws IOException
```
    Create a string representation of the Mail object JSON.
    
    Returns:
    
    a JSON string.
    
    Throws:
    
    IOException - in case of a JSON marshal error.
  - buildPretty
```
public String buildPretty()
                   throws IOException
```
    Create a string representation of the Mail object JSON and pretty print it.
    
    Returns:
    
    a pretty JSON string.
    
    Throws:
    
    IOException - in case of a JSON marshal error.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Mail

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

from

subject

personalization

content

attachments

templateId

sections

headers

categories

customArgs

sendAt

batchId

asm

ipPoolId

mailSettings

trackingSettings

replyTo

Constructor Detail

Mail

Mail

Method Detail

getFrom

setFrom

getSubject

setSubject

getASM

setASM

getPersonalization

addPersonalization

getContent

addContent

getAttachments

addAttachments

getTemplateId

setTemplateId

getSections

addSection

getHeaders

addHeader

getCategories

addCategory

getCustomArgs

addCustomArg

sendAt

setSendAt

getBatchId

setBatchId

getIpPoolId

setIpPoolId

getMailSettings

setMailSettings

getTrackingSettings

setTrackingSettings

getReplyto

setReplyTo

build

buildPretty

hashCode

equals