com.sendgrid

Class Personalization

java.lang.Object

com.sendgrid.Personalization

public class Personalization
extends java.lang.Object

An object representing a message and its metadata. A personalization can be thought of as an envelope - it defines who should receive an individual message and how that message should be handled.

Constructor Summary

Constructors

Constructor and Description
Personalization()

Method Summary

Modifier and Type	Method and Description
void	addBcc(Email email) Add a recipient.
void	addCc(Email email) Add a recipient.
void	addCustomArg(java.lang.String key, java.lang.String value) Add a custom argument.
void	addHeader(java.lang.String key, java.lang.String value) Add a header.
void	addSubstitution(java.lang.String key, java.lang.String value) Add a substitusion.
void	addTo(Email email) Add a recipient.
java.util.List<Email>	getBccs() Set the BCC list.
java.util.List<Email>	getCcs() Set the CC list.
java.util.Map<java.lang.String,java.lang.String>	getCustomArgs() Get the custom arguments.
java.util.Map<java.lang.String,java.lang.String>	getHeaders() Get the headers.
java.lang.String	getSubject() Get the subject of the email.
java.util.Map<java.lang.String,java.lang.String>	getSubstitutions() Get the substitusions.
java.util.List<Email>	getTos() Get the to list.
long	sendAt() Get the send at time.
void	setSendAt(long sendAt) Set the send at time.
void	setSubject(java.lang.String subject) Set the subject of the email.

Methods inherited from class java.lang.Object

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

Constructor Detail

Personalization

public Personalization()

Method Detail

getTos

public java.util.List<Email> getTos()

Get the to list. This is an array of recipients. Each object within this array may contain the name, but must always contain the email, of a recipient. The maximum number of entries is 1000. Content added to the returned list will be included when sent.

Returns:

the to list.

addTo

public void addTo(Email email)

Add a recipient.

Parameters:

email - an email address.

getCcs

public java.util.List<Email> getCcs()

Set the CC list. This is an array of recipients. Each object within this array may contain the name, but must always contain the email, of a recipient. The maximum number of entries is 1000. Content added to the returned list will be included when sent.

Returns:

the CC list.

addCc

public void addCc(Email email)

Add a recipient.

Parameters:

email - an email address.

getBccs

public java.util.List<Email> getBccs()

Set the BCC list. This is an array of recipients. Each object within this array may contain the name, but must always contain the email, of a recipient. The maximum number of entries is 1000. Content added to the returned list will be included when sent.

Returns:

the BCC list.

addBcc

public void addBcc(Email email)

Add a recipient.

Parameters:

email - an email address.

getSubject

public java.lang.String getSubject()

Get the subject of the email.

Returns:

the subject.

setSubject

public void setSubject(java.lang.String subject)

Set the subject of the email.

Parameters:

subject - the subject.

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()

Get the headers. The headers are a collection of JSON key/value pairs allowing you to specify specific handling instructions for your email. You may not overwrite the following headers: x-sg-id, x-sg-eid, received, dkim-signature, Content-Type, Content-Transfer-Encoding, To, From, Subject, Reply-To, CC, BCC Content added to the returned list will be included when sent.

Returns:

the headers.

addHeader

public void addHeader(java.lang.String key,
                      java.lang.String value)

Add a header.

Parameters:

key - the header key.

value - the header value.

getSubstitutions

public java.util.Map<java.lang.String,java.lang.String> getSubstitutions()

Get the substitusions. Substitutions are a collection of key/value pairs following the pattern "substitution_tag":"value to substitute". All are assumed to be strings. These substitutions will apply to the text and html content of the body of your email, in addition to the subject and reply-to parameters. The total collective size of your substitutions may not exceed 10,000 bytes per personalization object. The maximum number of entries is 1000. Content added to the returned list will be included when sent.

Returns:

the substitutions.

addSubstitution

public void addSubstitution(java.lang.String key,
                            java.lang.String value)

Add a substitusion.

Parameters:

key - the key.

value - the value.

getCustomArgs

public java.util.Map<java.lang.String,java.lang.String> getCustomArgs()

Get the custom arguments. Values that are specific to this personalization 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. i May not exceed 10,000 bytes. Content added to the returned list will be included when sent.

Returns:

the custom arguments.

addCustomArg

public void addCustomArg(java.lang.String key,
                         java.lang.String value)

Add a custom argument.

Parameters:

key - the key.

value - the value.

sendAt

public long sendAt()

Get the send at time. This is a unix timestamp allowing you to specify when you want your email to be delivered. Scheduling more than 72 hours in advance is forbidden.

Returns:

the send at time.

setSendAt

public void setSendAt(long sendAt)

Set the send at time.

Parameters:

sendAt - the send at time (Unix timestamp).