org.eclipse.stardust.engine.api.runtime
Interface Mail

public interface Mail

A lightweight representation of a mail message. It provides simplified access to the basic information contained in a mail message.

Version:

$Revision$

Author:

ubirkemeyer

Method Summary

java.util.List	getAllRecipients() Gets all recipients.
java.util.List	getBccRecipients() Gets the list of Bcc recipients.
java.util.List	getCcRecipients() Gets the list of CC recipients.
java.lang.Object	getContent() Gets the content of this message.
java.lang.String	getContentType() Gets the mime type of the content.
int	getLineCount() Gets the number of lines contained in that message.
java.lang.String	getMessageId() Gets the value of the Message-ID header, if available.
java.util.Date	getReceivedDate() Gets the time when the mail message was received.
java.util.List	getReplyTo() Gets the list of replyTo addresses.
java.lang.String	getSender() Gets the sender of this message.
java.util.Date	getSentDate() Gets the time when the mail message was sent.
int	getSize() Gets the size of the content.
java.lang.String	getStringContent() Gets the string content of this message.
java.lang.String	getSubject() Gets the subject of this mail message.
java.util.List	getToRecipients() Gets the list of recipients.

Method Detail

getMessageId

java.lang.String getMessageId()

Gets the value of the Message-ID header, if available.

Returns:

The message ID header, uniquely identifying the mail on the server.

Since:

3.1

getSender

java.lang.String getSender()

Gets the sender of this message.

Returns:

the sender of the message.

getToRecipients

java.util.List getToRecipients()

Gets the list of recipients.

Returns:

a List of strings representing recipients.

getCcRecipients

java.util.List getCcRecipients()

Gets the list of CC recipients.

Returns:

a List of strings representing recipients.

getBccRecipients

java.util.List getBccRecipients()

Gets the list of Bcc recipients.

Returns:

a List of strings representing recipients.

getAllRecipients

java.util.List getAllRecipients()

Gets all recipients.

Returns:

the concatenated list of recipients, CC recipients and BCC recipients.

getReplyTo

java.util.List getReplyTo()

Gets the list of replyTo addresses.

Returns:

a List of strings containing the replyTo addresses.

getSubject

java.lang.String getSubject()

Gets the subject of this mail message.

Returns:

the subject of the mail.

getSentDate

java.util.Date getSentDate()

Gets the time when the mail message was sent.

Returns:

the sent time.

getReceivedDate

java.util.Date getReceivedDate()

Gets the time when the mail message was received.

Returns:

the receive time.

getLineCount

int getLineCount()

Gets the number of lines contained in that message.

Returns:

the line count.

getContentType

java.lang.String getContentType()

Gets the mime type of the content.

Returns:

the mime type of the content.

getContent

java.lang.Object getContent()

Gets the content of this message.

Returns:

the content of the message.

getStringContent

java.lang.String getStringContent()

Gets the string content of this message.

Returns:

the string content of the message.

getSize

int getSize()

Gets the size of the content.

Returns:

the message content size.