org.mule.extension.email.api.attributes

Class BaseEmailAttributes

java.lang.Object

org.mule.runtime.core.message.BaseAttributes

org.mule.extension.email.api.attributes.BaseEmailAttributes

All Implemented Interfaces:

Serializable, org.mule.runtime.api.message.Attributes

Direct Known Subclasses:

IMAPEmailAttributes, POP3EmailAttributes

public abstract class BaseEmailAttributes
extends BaseAttributes

Contains all the basic metadata of a received email, it carries information such as the subject of the email, the number in the mailbox and the recipients between others.

This class aims to be returned as attributes for every email message in a PagingProviderEmailDelegate operation.

Since:

4.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseEmailAttributes(javax.mail.Message msg)

Method Summary

Modifier and Type	Method and Description
List<String>	getBccAddresses()
List<String>	getCcAddresses()
List<String>	getFromAddresses() Get the identity of the person(s) who wished this message to be sent.
Map<String,String>	getHeaders()
abstract long	getId()
int	getNumber() Returns the number of the email in the mailbox folder in a moment.
LocalDateTime	getReceivedDate() Get the date this message was received.
List<String>	getReplyToAddresses() Get the addresses to which replies should be directed.
LocalDateTime	getSentDate() Get the date this message was sent.
String	getSubject()
List<String>	getToAddresses()

Methods inherited from class org.mule.runtime.core.message.BaseAttributes

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseEmailAttributes

public BaseEmailAttributes(javax.mail.Message msg)

Method Detail

getId

public abstract long getId()

Returns:

the unique id of the email in a folder.

getNumber

public int getNumber()

Returns the number of the email in the mailbox folder in a moment.

Take in mind that this number change with the different operations that can occur in a folder i.e. moving mails, deleting emails, etc.

Returns:

the number of the email in the mailbox.

getSubject

public String getSubject()

Returns:

the subject of the email.

getToAddresses

public List<String> getToAddresses()

Returns:

all the recipient addresses of "To" (primary) type.

getBccAddresses

public List<String> getBccAddresses()

Returns:

all the recipient addresses of "Bcc" (blind carbon copy) type.

getCcAddresses

public List<String> getCcAddresses()

Returns:

all the recipient addresses of "Cc" (carbon copy) type.

getFromAddresses

public List<String> getFromAddresses()

Get the identity of the person(s) who wished this message to be sent.

Returns:

all the from addresses.

getReplyToAddresses

public List<String> getReplyToAddresses()

Get the addresses to which replies should be directed. This will usually be the sender of the email, but some emails may direct replies to a different address

Returns:

all the recipient addresses of replyTo type.

getReceivedDate

public LocalDateTime getReceivedDate()

Get the date this message was received.

Returns:

the date this message was received.

getSentDate

public LocalDateTime getSentDate()

Get the date this message was sent.

Returns:

the date this message was sent.

getHeaders

public Map<String,String> getHeaders()

Returns:

all the headers of this email message.