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

Method Detail

getMessageId

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

String getSender()
Gets the sender of this message.

Returns:
the sender of the message.

getToRecipients

List getToRecipients()
Gets the list of recipients.

Returns:
a List of strings representing recipients.

getCcRecipients

List getCcRecipients()
Gets the list of CC recipients.

Returns:
a List of strings representing recipients.

getBccRecipients

List getBccRecipients()
Gets the list of Bcc recipients.

Returns:
a List of strings representing recipients.

getAllRecipients

List getAllRecipients()
Gets all recipients.

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

getReplyTo

List getReplyTo()
Gets the list of replyTo addresses.

Returns:
a List of strings containing the replyTo addresses.

getSubject

String getSubject()
Gets the subject of this mail message.

Returns:
the subject of the mail.

getSentDate

Date getSentDate()
Gets the time when the mail message was sent.

Returns:
the sent time.

getReceivedDate

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

String getContentType()
Gets the mime type of the content.

Returns:
the mime type of the content.

getContent

Object getContent()
Gets the content of this message.

Returns:
the content of the message.

getStringContent

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.


Copyright © 2017 Eclipse Stardust. All Rights Reserved.