Package com.mailersend.sdk.emails

Class Email

java.lang.Object

com.mailersend.sdk.emails.Email

public class Email
extends Object

Email class.

Version:

$Id: $Id

Author:

john

Field Summary

Fields

Modifier and Type	Field	Description
protected HashMap<String,Object>	allRecipientsPersonalization
protected HashMap<String,String>	allRecipientsSubstitutions
ArrayList<Attachment>	attachments
ArrayList<Recipient>	bcc
ArrayList<Recipient>	cc
Recipient	from
String	html
String	inReplyTo
String	listUnsubscribe
ArrayList<Personalization>	personalization
ArrayList<Recipient>	recipients
Recipient	replyTo
Date	sendAt
protected String	sendAtStamp
String	subject
ArrayList<String>	tags
String	templateId
String	text

Constructor Summary

Constructors

Constructor	Description
Email()

Method Summary

Modifier and Type	Method	Description
void	AddBcc(Recipient recipient)	Adds a blind carbon copy recipient to the email
void	AddBcc(String name, String email)	Adds a blind carbon copy recipient to the email
void	AddCc(Recipient recipient)	Adds a carbon copy recipient to the email
void	AddCc(String name, String email)	Adds a carbon copy recipient to the email
void	addPersonalization(Recipient recipient, String name, Object value)	Adds a personalization for the given recipient
void	addPersonalization(String name, Object value)	Adds personalization to all recipients
void	addRecipient(String name, String email)	Adds a recipient to the email
void	AddRecipient(Recipient recipient)	Adds a recipient
void	AddRecipients(Recipient[] recipients)	Adds multiple recipients to the email
void	AddReplyTo(Recipient replyTo)	Sets the reply to parameter
void	AddReplyTo(String name, String email)	Sets the reply to parameter
void	AddTag(String tag)	Add a tag to the email
void	AddVariable(String name, String value)	Adds a variable to all recipients
void	attachFile(File file)	attachFile.
void	attachFile(String path)	Attach a file to the email
protected void	preparePersonalizationForAllRecipients()	Adds each entry of the allRecipientsPersonalization hash map as a personalization for each recipient
protected void	prepareSubstitutionsForAllRecipients()	Adds each entry of the allRecipientsSubstitutions hash map as a substitution for each recipient
String	serializeForSending()	Prepares the email for sending and returns it as a serialized JSON string
void	setFrom(String name, String email)	Sets the email from
void	setHtml(String html)	Sets the email's HTML body
void	setInReplyTo(String inReplyTo)	Set in reply to
void	setListUnsubscribe(String listUnsubscribe)	Sets the list unsubscribe parameter Accepts a single value that complies with RFC 8058 Note: This feature is available to Professional and Enterprise accounts only
void	setPlain(String plain)	Sets the email's plain text bofy
void	setSendAt(Date sendAt)	Set the send at date
void	setSubject(String subject)	Sets the email's subject
void	setTemplateId(String templateId)	Sets the email's template id

Methods inherited from class java.lang.Object

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

Field Detail

recipients

@SerializedName("to")
public ArrayList<Recipient> recipients

from

@SerializedName("from")
public Recipient from

cc

@SerializedName("cc")
public ArrayList<Recipient> cc

bcc

@SerializedName("bcc")
public ArrayList<Recipient> bcc

replyTo

@SerializedName("reply_to")
public Recipient replyTo

subject

@SerializedName("subject")
public String subject

text

@SerializedName("text")
public String text

html

@SerializedName("html")
public String html

templateId

@SerializedName("template_id")
public String templateId

tags

@SerializedName("tags")
public ArrayList<String> tags

attachments

public ArrayList<Attachment> attachments

personalization

@SerializedName("personalization")
public ArrayList<Personalization> personalization

sendAt

public Date sendAt

allRecipientsPersonalization

protected transient HashMap<String,Object> allRecipientsPersonalization

allRecipientsSubstitutions

protected transient HashMap<String,String> allRecipientsSubstitutions

sendAtStamp

@SerializedName("send_at")
protected String sendAtStamp

inReplyTo

@SerializedName("in_reply_to")
public String inReplyTo

listUnsubscribe

@SerializedName("list_unsubscribe")
public String listUnsubscribe

Constructor Detail

Email

public Email()

Method Detail

addRecipient

public void addRecipient(String name,
                         String email)

Adds a recipient to the email

Parameters:

name - a String object.

email - a String object.

AddRecipient

public void AddRecipient(Recipient recipient)

Adds a recipient

Parameters:

recipient - a Recipient object.

AddRecipients

public void AddRecipients(Recipient[] recipients)

Adds multiple recipients to the email

Parameters:

recipients - an array of Recipient objects.

AddCc

public void AddCc(String name,
                  String email)

Adds a carbon copy recipient to the email

Parameters:

name - a String object.

email - a String object.

AddCc

public void AddCc(Recipient recipient)

Adds a carbon copy recipient to the email

Parameters:

recipient - a Recipient object.

AddBcc

public void AddBcc(String name,
                   String email)

Adds a blind carbon copy recipient to the email

Parameters:

name - a String object.

email - a String object.

AddBcc

public void AddBcc(Recipient recipient)

Adds a blind carbon copy recipient to the email

Parameters:

recipient - a Recipient object.

AddReplyTo

public void AddReplyTo(Recipient replyTo)

Sets the reply to parameter

Parameters:

replyTo - a Recipient object.

AddReplyTo

public void AddReplyTo(String name,
                       String email)

Sets the reply to parameter

Parameters:

name - a String object.

email - a String object.

setFrom

public void setFrom(String name,
                    String email)

Sets the email from

Parameters:

name - a String object.

email - a String object.

setSubject

public void setSubject(String subject)

Sets the email's subject

Parameters:

subject - a String object.

setHtml

public void setHtml(String html)

Sets the email's HTML body

Parameters:

html - a String object.

setPlain

public void setPlain(String plain)

Sets the email's plain text bofy

Parameters:

plain - a String object.

setTemplateId

public void setTemplateId(String templateId)

Sets the email's template id

Parameters:

templateId - a String object.

addPersonalization

public void addPersonalization(Recipient recipient,
                               String name,
                               Object value)

Adds a personalization for the given recipient

Parameters:

recipient - a Recipient object.

name - a String object.

value - a Object object.

setSendAt

public void setSendAt(Date sendAt)

Set the send at date

Parameters:

sendAt - a Date object.

setInReplyTo

public void setInReplyTo(String inReplyTo)

Set in reply to

Parameters:

inReplyTo - a String object.

setListUnsubscribe

public void setListUnsubscribe(String listUnsubscribe)

Sets the list unsubscribe parameter Accepts a single value that complies with RFC 8058 Note: This feature is available to Professional and Enterprise accounts only

Parameters:

listUnsubscribe - a String object.

addPersonalization

public void addPersonalization(String name,
                               Object value)

Adds personalization to all recipients

Parameters:

name - a String object.

value - a Object object.

AddVariable

public void AddVariable(String name,
                        String value)

Adds a variable to all recipients

Parameters:

name - a String object.

value - a String object.

AddTag

public void AddTag(String tag)

Add a tag to the email

Parameters:

tag - a String object.

attachFile

public void attachFile(String path)
                throws IOException

Attach a file to the email

Parameters:

path - a String object.

Throws:

IOException

attachFile

public void attachFile(File file)
                throws IOException

attachFile.

Parameters:

file - a File object.

Throws:

IOException - if any.

preparePersonalizationForAllRecipients

protected void preparePersonalizationForAllRecipients()

Adds each entry of the allRecipientsPersonalization hash map as a personalization for each recipient

prepareSubstitutionsForAllRecipients

protected void prepareSubstitutionsForAllRecipients()

Adds each entry of the allRecipientsSubstitutions hash map as a substitution for each recipient

serializeForSending

public String serializeForSending()

Prepares the email for sending and returns it as a serialized JSON string

Returns:

String