com.client.core.email.model

Class MailInfo

java.lang.Object

com.client.core.email.model.MailInfo

All Implemented Interfaces:

java.io.Serializable

public class MailInfo
extends java.lang.Object
implements java.io.Serializable

Object used to represent information required to send an email. Can be passed to the Emailer to specify more than the typical amount of information required for an email (i.e. attachments, cc, bcc).

Can also be used to override which email address emails are being sent from. Providing a sender/senderName in this object will override the application-wide from email settings.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MailInfo()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<MailAttachment>	getAttachments() Optional collection of MailAttachments to be sent with the email.
java.util.Collection<java.lang.String>	getBcc() Optional collection of email addresses to send as blind carbon copy recipients
java.lang.String	getBody() Returns the content of the body of the email address to be sent.
java.util.Collection<java.lang.String>	getCc() Optional collection of email addresses to send as carbon copy recipients
java.lang.String	getMimeType() Returns the String representation of the mime type being used for the body of the email to be sent.
java.lang.String	getReplyTo() Returns the optional reply to email address for the email to be sent
java.lang.String	getSender() Returns the email address of the user sending the email.
java.lang.String	getSenderName() Returns the name of the user sending the email.
java.lang.String	getSubject() Returns the subject line for the email to be sent
java.util.Collection<java.lang.String>	getTo() Returns the collection of email addresses to which the email is to be sent
void	setAttachments(java.util.Collection<MailAttachment> attachments)
void	setBcc(java.util.Collection<java.lang.String> bcc)
void	setBody(java.lang.String body)
void	setCc(java.util.Collection<java.lang.String> cc)
void	setMimeType(java.lang.String mimeType)
void	setReplyTo(java.lang.String replyTo)
void	setSender(java.lang.String sender)
void	setSenderName(java.lang.String senderName)
void	setSubject(java.lang.String subject)
void	setTo(java.util.Collection<java.lang.String> to)

Methods inherited from class java.lang.Object

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

Constructor Detail

MailInfo

public MailInfo()

Method Detail

getSender

public java.lang.String getSender()

Returns the email address of the user sending the email. Is optional when used in conjunction with Emailer.sendEmail(MailInfo), if provided will override the sender from MailSettings

Returns:

email address of the user sending the email

setSender

public void setSender(java.lang.String sender)

getSenderName

public java.lang.String getSenderName()

Returns the name of the user sending the email. Is optional when used in conjunction with Emailer.sendEmail(MailInfo), if provided will override the sender from MailSettings

Returns:

name of the user sending the email

setSenderName

public void setSenderName(java.lang.String senderName)

getAttachments

public java.util.Collection<MailAttachment> getAttachments()

Optional collection of MailAttachments to be sent with the email.

Returns:

the collection of attachments

setAttachments

public void setAttachments(java.util.Collection<MailAttachment> attachments)

getBcc

public java.util.Collection<java.lang.String> getBcc()

Optional collection of email addresses to send as blind carbon copy recipients

Returns:

the collection of bcc email addresses

setBcc

public void setBcc(java.util.Collection<java.lang.String> bcc)

getBody

public java.lang.String getBody()

Returns the content of the body of the email address to be sent. Can be plain text or HTML. Use setMimeType(String) to specify what kind of content it is.

Returns:

setBody

public void setBody(java.lang.String body)

getCc

public java.util.Collection<java.lang.String> getCc()

Optional collection of email addresses to send as carbon copy recipients

Returns:

the collection of cc email addresses

setCc

public void setCc(java.util.Collection<java.lang.String> cc)

getMimeType

public java.lang.String getMimeType()

Returns the String representation of the mime type being used for the body of the email to be sent. Defaults to HTML.

Returns:

the mime type of the email body.

setMimeType

public void setMimeType(java.lang.String mimeType)

getReplyTo

public java.lang.String getReplyTo()

Returns the optional reply to email address for the email to be sent

Returns:

the email address of the reply to user on the email

setReplyTo

public void setReplyTo(java.lang.String replyTo)

getSubject

public java.lang.String getSubject()

Returns the subject line for the email to be sent

Returns:

the subject of the email

setSubject

public void setSubject(java.lang.String subject)

getTo

public java.util.Collection<java.lang.String> getTo()

Returns the collection of email addresses to which the email is to be sent

Returns:

the collection of addresses the email will be sent to

setTo

public void setTo(java.util.Collection<java.lang.String> to)