org.jasig.portlet.emailpreview
Class EmailMessage

java.lang.Object
  org.jasig.portlet.emailpreview.EmailMessage

Direct Known Subclasses:

ExchangeEmailMessage

public class EmailMessage
extends Object

An entity abstraction for representing information related to an email message.

Author:

Andreas Christoforides, Jen Bourey, jbourey@unicon.net, Drew Wills, drew@unicon.net

Constructor Summary

EmailMessage(int messageNumber, String uid, String sender, String subject, Date sentDate, boolean unread, boolean answered, boolean deleted, boolean multipart, String contentType, EmailMessageContent content)

EmailMessage(int messageNumber, String uid, String sender, String subject, Date sentDate, boolean unread, boolean answered, boolean deleted, boolean multipart, String contentType, EmailMessageContent content, String allRecipients)
Creates a new EmailMessage based on the specified Message and EmailMessageContent.

Method Summary

String	getAllRecipients()
EmailMessageContent	getContent()
String	getContentType()
String	getMessageId() Returns the UID of the message if it is present, else the message number.
int	getMessageNumber()
String	getSender() Returns the sender of this email message.
String	getSenderName()
Date	getSentDate() Returns the date the email message was sent or null if the server did not provide one.
String	getSentDateString()
String	getSubject() Returns the email message subject.
String	getUid() Returns the UID of the message as set by the Folder or null if the Folder does not implement UIDFolder.
boolean	isAnswered()
boolean	isDeleted()
boolean	isMultipart()
boolean	isUnread()
void	setUnread(boolean unread)

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailMessage

public EmailMessage(int messageNumber,
                    String uid,
                    String sender,
                    String subject,
                    Date sentDate,
                    boolean unread,
                    boolean answered,
                    boolean deleted,
                    boolean multipart,
                    String contentType,
                    EmailMessageContent content,
                    String allRecipients)

Creates a new EmailMessage based on the specified Message and EmailMessageContent.

EmailMessage

public EmailMessage(int messageNumber,
                    String uid,
                    String sender,
                    String subject,
                    Date sentDate,
                    boolean unread,
                    boolean answered,
                    boolean deleted,
                    boolean multipart,
                    String contentType,
                    EmailMessageContent content)

Method Detail

getMessageNumber

public int getMessageNumber()

getUid

public String getUid()

Returns the UID of the message as set by the Folder or null if the Folder does not implement UIDFolder.

Returns:

The UID provided by the Folder for this message or null

getMessageId

public String getMessageId()

Returns the UID of the message if it is present, else the message number.

Returns:

UID if present else message number

getSentDate

public Date getSentDate()

Returns the date the email message was sent or null if the server did not provide one.

Returns:

Date the email message was sent or null

Throws:

MessagingException

getSentDateString

public String getSentDateString()

getSender

public String getSender()

Returns the sender of this email message.

Returns:

The sender of the email message.

getSenderName

public String getSenderName()

getSubject

public String getSubject()

Returns the email message subject.

Returns:

The email message subject.

isUnread

public boolean isUnread()

setUnread

public void setUnread(boolean unread)

isAnswered

public boolean isAnswered()

isDeleted

public boolean isDeleted()

isMultipart

public boolean isMultipart()

getContentType

public String getContentType()

Returns:

The content type (e.g. "text/plain") of the message body or null if the content cannot be read

getContent

public EmailMessageContent getContent()

getAllRecipients

public String getAllRecipients()