Class SMTPEnvelope

java.lang.Object

org.deltava.mail.SMTPEnvelope

All Implemented Interfaces:

Serializable, Cloneable, Comparable<NotificationEnvelope<?>>, NotificationEnvelope<Address>

class SMTPEnvelope
extends Object
implements NotificationEnvelope<Address>

A bean to aggregate SMTP message information.

Since:

1.0

Version:

11.1

Author:

Luke

Nested Class Summary

Nested classes/interfaces inherited from interface org.deltava.beans.NotificationEnvelope

NotificationEnvelope.Protocol

Constructor Summary

Constructors

Constructor	Description
SMTPEnvelope(boolean isOurDomain, EMailAddress from)	Creates a new STMP envelope.

Method Summary

Modifier and Type	Method	Description
void	addCopyTo(EMailAddress addr)	Adds an address to the copy-to list.
void	addHeader(String name, String value)	Adds a header to the message.
void	addRecipient(EMailAddress addr)	Adds an address to the recipient list.
void	addRecipients(Collection<EMailAddress> addrs)	Adds a Collection of addresses to the recipient list.
void	clearRecipients()	Clears the list of recipients.
Object	clone()	Clones this SMTP envelope.
javax.activation.DataSource	getAttachment()	Returns the envelope's attachment, if any.
String	getBody()	Returns the message body.
String	getContentType()	Returns the message content type.
Address[]	getCopyTo()	Returns the copy-to recipient list.
Instant	getCreatedOn()	Returns the envelope creation date.
Address	getEndpoint()	Returns the destination address.
EMailAddress	getFrom()	Returns the originator of this e-mail message.
Map<String,String>	getHeaders()	Returns the message headers.
NotificationEnvelope.Protocol	getProtocol()	Returns this envelope's notification protocol.
Address[]	getRecipients()	Returns the recipient list.
String	getSubject()	Returns the message subject.
int	hashCode()
boolean	hasRecipients()	Returns if the envelope has any recipients.
boolean	isOurDomain()	Returns whether this envelope originates from our e-mail domain, or is spoofing another domain.
void	setAttachment(javax.activation.DataSource ds)	Adds an attachment to the envelope.
void	setBody(String body)	Sets the message body.
void	setContentType(String cType)	Sets the message content type.
void	setRecipient(EMailAddress addr)	Clears the recipient list and overwrites it with a single address.
void	setSubject(String subj)	Sets the message subject.
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.deltava.beans.NotificationEnvelope

compareTo

Constructor Details

SMTPEnvelope

SMTPEnvelope(boolean isOurDomain,
 EMailAddress from)

Creates a new STMP envelope.

Parameters:

isOurDomain - TRUE if from an SES-validated domain, otheriwse FALSE

from - the originating address

Method Details

getAttachment

public javax.activation.DataSource getAttachment()

Returns the envelope's attachment, if any.

Returns:

a Java Activation data source, or null

See Also:

• setAttachment(DataSource)

getBody

public String getBody()

Returns the message body.

Returns:

the message body

See Also:

• setBody(String)

getCreatedOn

public Instant getCreatedOn()

Description copied from interface: NotificationEnvelope

Returns the envelope creation date.

Specified by:

getCreatedOn in interface NotificationEnvelope<Address>

Returns:

the creation date/time

getProtocol

public NotificationEnvelope.Protocol getProtocol()

Description copied from interface: NotificationEnvelope

Returns this envelope's notification protocol.

Specified by:

getProtocol in interface NotificationEnvelope<Address>

Returns:

the Protocol

getSubject

public String getSubject()

Returns the message subject.

Returns:

the subject

See Also:

• setSubject(String)

getContentType

public String getContentType()

Returns the message content type.

Returns:

the MIME type

See Also:

• setContentType(String)

getFrom

public EMailAddress getFrom()

Returns the originator of this e-mail message.

Returns:

the originating address

getCopyTo

public Address[] getCopyTo()

Returns the copy-to recipient list.

Returns:

an array of Address beans, or null if empty

See Also:

• addCopyTo(EMailAddress)
• hasRecipients()

getRecipients

public Address[] getRecipients()

Returns the recipient list.

Returns:

an array of Address beans

See Also:

• addRecipient(EMailAddress)
• addRecipients(Collection)
• setRecipient(EMailAddress)
• hasRecipients()

getEndpoint

public Address getEndpoint()

Description copied from interface: NotificationEnvelope

Returns the destination address.

Specified by:

getEndpoint in interface NotificationEnvelope<Address>

Returns:

the address

getHeaders

public Map<String,String> getHeaders()

Returns the message headers.

Returns:

a Map of headers

See Also:

• addHeader(String, String)

hasRecipients

public boolean hasRecipients()

Returns if the envelope has any recipients.

Returns:

TRUE if receipients or copyTo are not empty, otherwise FALSE

See Also:

• getRecipients()
• getCopyTo()

isOurDomain

public boolean isOurDomain()

Returns whether this envelope originates from our e-mail domain, or is spoofing another domain.

Returns:

TRUE if created using a validated SES domain, otherwise FALSE

setAttachment

public void setAttachment(javax.activation.DataSource ds)

Adds an attachment to the envelope.

Parameters:

ds - a Java Activation data source

See Also:

• getAttachment()

setBody

public void setBody(String body)

Sets the message body.

Parameters:

body - the body text

See Also:

• getBody()

setSubject

public void setSubject(String subj)

Sets the message subject.

Parameters:

subj - the subject

See Also:

• getSubject()

setContentType

public void setContentType(String cType)

Sets the message content type.

Parameters:

cType - the MIME type

See Also:

• getContentType()

addRecipient

public void addRecipient(EMailAddress addr)

Adds an address to the recipient list.

Parameters:

addr - the e-mail address

See Also:

• addRecipients(Collection)
• setRecipient(EMailAddress)
• getRecipients()

addHeader

public void addHeader(String name,
 String value)

Adds a header to the message.

Parameters:

name - the header name

value - the header value

See Also:

• getHeaders()

setRecipient

public void setRecipient(EMailAddress addr)

Clears the recipient list and overwrites it with a single address.

Parameters:

addr - the e-mail address

See Also:

• addRecipient(EMailAddress)
• addRecipients(Collection)
• getRecipients()

addRecipients

public void addRecipients(Collection<EMailAddress> addrs)

Adds a Collection of addresses to the recipient list.

Parameters:

addrs - a Collection of EMailAddress beans

See Also:

• addRecipient(EMailAddress)
• setRecipient(EMailAddress)
• getRecipients()

addCopyTo

public void addCopyTo(EMailAddress addr)

Adds an address to the copy-to list.

Parameters:

addr - the e-mail address

See Also:

• getCopyTo()

clearRecipients

public void clearRecipients()

Clears the list of recipients.

clone

public Object clone()

Clones this SMTP envelope.

Overrides:

clone in class Object

Returns:

a copy of the envelope

See Also:

• Cloneable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object