me.adaptive.arp.api

Class Email

java.lang.Object

me.adaptive.arp.api.APIBean

me.adaptive.arp.api.Email

public class Email
extends APIBean

Structure representing the data elements of an email.

Since:

v2.0

Constructor Summary

Constructors

Constructor and Description
Email() Default constructor
Email(EmailAddress[] toRecipients, EmailAddress[] ccRecipients, EmailAddress[] bccRecipients, EmailAttachmentData[] emailAttachmentData, java.lang.String messageBody, java.lang.String messageBodyMimeType, java.lang.String subject) Constructor used by the implementation
Email(EmailAddress[] toRecipients, java.lang.String subject, java.lang.String messageBody) Constructor used by the implementation

Method Summary

Modifier and Type	Method and Description
EmailAddress[]	getBccRecipients() Returns the array of recipients
EmailAddress[]	getCcRecipients() Returns the array of recipients
EmailAttachmentData[]	getEmailAttachmentData() Returns an array of attachments
java.lang.String	getMessageBody() Returns the message body of the email
java.lang.String	getMessageBodyMimeType() Returns the myme type of the message body
java.lang.String	getSubject() Returns the subject of the email
EmailAddress[]	getToRecipients() Returns the array of recipients
void	setBccRecipients(EmailAddress[] bccRecipients) Set the array of recipients
void	setCcRecipients(EmailAddress[] ccRecipients) Set the array of recipients
void	setEmailAttachmentData(EmailAttachmentData[] emailAttachmentData) Set the email attachment data array
void	setMessageBody(java.lang.String messageBody) Set the message body of the email
void	setMessageBodyMimeType(java.lang.String messageBodyMimeType) Set the mime type for the message body
void	setSubject(java.lang.String subject) Set the subject of the email
void	setToRecipients(EmailAddress[] toRecipients) Set the array of recipients

Methods inherited from class java.lang.Object

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

Constructor Detail

Email

public Email()

Default constructor

Since:

v2.0

Email

public Email(EmailAddress[] toRecipients,
             EmailAddress[] ccRecipients,
             EmailAddress[] bccRecipients,
             EmailAttachmentData[] emailAttachmentData,
             java.lang.String messageBody,
             java.lang.String messageBodyMimeType,
             java.lang.String subject)

Constructor used by the implementation

Parameters:

toRecipients - array of recipients

ccRecipients - array of cc recipients

bccRecipients - array of bcc recipients

emailAttachmentData - array of attatchments

messageBody - body of the email

messageBodyMimeType - mime type of the body

subject - of the email

Since:

v2.0

Email

public Email(EmailAddress[] toRecipients,
             java.lang.String subject,
             java.lang.String messageBody)

Constructor used by the implementation

Parameters:

toRecipients - array of recipients

subject - of the email

messageBody - body of the email

Since:

v2.0

Method Detail

getBccRecipients

public EmailAddress[] getBccRecipients()

Returns the array of recipients

Returns:

bccRecipients array of bcc recipients

Since:

v2.0

setBccRecipients

public void setBccRecipients(EmailAddress[] bccRecipients)

Set the array of recipients

Parameters:

bccRecipients - array of bcc recipients

Since:

v2.0

getCcRecipients

public EmailAddress[] getCcRecipients()

Returns the array of recipients

Returns:

ccRecipients array of cc recipients

Since:

v2.0

setCcRecipients

public void setCcRecipients(EmailAddress[] ccRecipients)

Set the array of recipients

Parameters:

ccRecipients - array of cc recipients

Since:

v2.0

getEmailAttachmentData

public EmailAttachmentData[] getEmailAttachmentData()

Returns an array of attachments

Returns:

emailAttachmentData array with the email attachments

Since:

v2.0

setEmailAttachmentData

public void setEmailAttachmentData(EmailAttachmentData[] emailAttachmentData)

Set the email attachment data array

Parameters:

emailAttachmentData - array of email attatchments

Since:

v2.0

getMessageBody

public java.lang.String getMessageBody()

Returns the message body of the email

Returns:

message Body string of the email

Since:

v2.0

setMessageBody

public void setMessageBody(java.lang.String messageBody)

Set the message body of the email

Parameters:

messageBody - message body of the email

Since:

v2.0

getMessageBodyMimeType

public java.lang.String getMessageBodyMimeType()

Returns the myme type of the message body

Returns:

mime type string of the message boddy

Since:

v2.0

setMessageBodyMimeType

public void setMessageBodyMimeType(java.lang.String messageBodyMimeType)

Set the mime type for the message body

Parameters:

messageBodyMimeType - type of the body message

Since:

v2.0

getSubject

public java.lang.String getSubject()

Returns the subject of the email

Returns:

subject string of the email

Since:

v2.0

setSubject

public void setSubject(java.lang.String subject)

Set the subject of the email

Parameters:

subject - of the email

Since:

v2.0

getToRecipients

public EmailAddress[] getToRecipients()

Returns the array of recipients

Returns:

toRecipients array of recipients

Since:

v2.0

setToRecipients

public void setToRecipients(EmailAddress[] toRecipients)

Set the array of recipients

Parameters:

toRecipients - array of recipients

Since:

v2.0