jodd.mail

Class ReceivedEmail

java.lang.Object

jodd.mail.CommonEmail<ReceivedEmail>

jodd.mail.ReceivedEmail

public class ReceivedEmail
extends CommonEmail<ReceivedEmail>

Received email.

Field Summary

Fields

Modifier and Type	Field and Description
static ReceivedEmail[]	EMPTY_ARRAY

Fields inherited from class jodd.mail.CommonEmail

PRIORITY_HIGH, PRIORITY_HIGHEST, PRIORITY_LOW, PRIORITY_LOWEST, PRIORITY_NORMAL, X_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ReceivedEmail(javax.mail.Message msg, boolean envelope, java.io.File attachmentStorage) Creates a ReceivedEmail from a given Message.

Method Summary

Modifier and Type	Method and Description
ReceivedEmail	attachedMessage(ReceivedEmail email) Adds attached ReceivedEmail.
java.util.List<ReceivedEmail>	attachedMessages() Returns the List of attached messages.
ReceivedEmail	attachedMessages(java.util.List<ReceivedEmail> emails) Adds attached ReceivedEmails.
ReceivedEmail	clone() Clones the email with all its necessary data.
static ReceivedEmail	create() Static constructor for fluent interface.
javax.mail.Flags	flags()
ReceivedEmail	flags(javax.mail.Flags flags) Sets the flags.
boolean	isAnswered() Returns true if message is answered.
boolean	isDeleted() Returns true if message is deleted.
boolean	isDraft() Returns true if message is draft.
boolean	isFlagged() Returns true is message is flagged.
boolean	isRecent() Returns true if message is recent.
boolean	isSeen() Returns true if message is seen.
java.lang.String	messageId() Returns message ID if set by server.
ReceivedEmail	messageId(java.lang.String messageId) Sets message ID.
int	messageNumber() Returns message number.
ReceivedEmail	messageNumber(int messageNumber) Sets message number.
javax.mail.Message	originalMessage()
ReceivedEmail	originalMessage(javax.mail.Message originalMessage) Sets the original message.
protected static java.lang.String	parseContentId(javax.mail.Part part) Returns the Content-ID of this Part.
protected static boolean	parseInline(javax.mail.Part part) Returns true if the Part is inline.
protected void	parseMessage(javax.mail.Message msg, boolean envelope) Parses Message and extracts all data for the received message.
protected void	processPart(javax.mail.Part part) Process part of the received message.
java.util.Date	receivedDate() Returns email's received Date.
ReceivedEmail	receivedDate(java.util.Date date) Sets email's received Date.

Methods inherited from class jodd.mail.CommonEmail

_this, attachment, attachment, attachments, attachments, cc, cc, cc, cc, cc, cc, cc, cc, embeddedAttachment, embeddedAttachment, from, from, from, from, from, header, header, headers, headers, headers, htmlMessage, htmlMessage, message, message, message, message, messages, priority, priority, replyTo, replyTo, replyTo, replyTo, replyTo, replyTo, replyTo, replyTo, resetCc, resetReplyTo, resetTo, sentDate, sentDate, storeAttachment, storeAttachments, subject, subject, subject, subjectEncoding, textMessage, textMessage, to, to, to, to, to, to, to, to, toString, valueOrEmptyArray

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final ReceivedEmail[] EMPTY_ARRAY

Constructor Detail

ReceivedEmail

public ReceivedEmail(javax.mail.Message msg,
                     boolean envelope,
                     java.io.File attachmentStorage)

Creates a ReceivedEmail from a given Message.

Parameters:

msg - Message

envelope - flag if this is an envelope

Method Detail

create

public static ReceivedEmail create()

Static constructor for fluent interface.

Returns:

new ReceivedEmail.

clone

public ReceivedEmail clone()

Description copied from class: CommonEmail

Clones the email with all its necessary data.

Specified by:

clone in class CommonEmail<ReceivedEmail>

Returns:

new object of type T

parseMessage

protected void parseMessage(javax.mail.Message msg,
                            boolean envelope)
                     throws javax.mail.MessagingException,
                            java.io.IOException

Parses Message and extracts all data for the received message.

Parameters:

msg - Message to parse.

Throws:

java.io.IOException - if there is an error with the content

javax.mail.MessagingException - if there is an error.

processPart

protected void processPart(javax.mail.Part part)
                    throws javax.mail.MessagingException,
                           java.io.IOException

Process part of the received message. All parts are simply added to the ReceivedEmail, i.e. hierarchy is not saved.

Parameters:

part - Part of received message

Throws:

java.io.IOException - if there is an error with the content.

javax.mail.MessagingException - if there is an error.

parseContentId

protected static java.lang.String parseContentId(javax.mail.Part part)
                                          throws javax.mail.MessagingException

Returns the Content-ID of this Part. Returns null if none present.

Parameters:

part - Part the Part to parse.

Returns:

String containing content ID.

Throws:

javax.mail.MessagingException - if there is a failure.

See Also:

MimePart.getContentID()

parseInline

protected static boolean parseInline(javax.mail.Part part)
                              throws javax.mail.MessagingException

Returns true if the Part is inline.

Parameters:

part - Part to parse.

Returns:

true if the Part is inline.

Throws:

javax.mail.MessagingException - if there is a failure.

originalMessage

public javax.mail.Message originalMessage()

Returns:

Message

originalMessage

public ReceivedEmail originalMessage(javax.mail.Message originalMessage)

Sets the original message.

Parameters:

originalMessage - Message to set.

flags

public javax.mail.Flags flags()

Returns:

Flags

flags

public ReceivedEmail flags(javax.mail.Flags flags)

Sets the flags.

Parameters:

flags - Flags to set.

isAnswered

public boolean isAnswered()

Returns true if message is answered.

Returns:

true if message is answered.

isDeleted

public boolean isDeleted()

Returns true if message is deleted.

Returns:

true if message is deleted.

isDraft

public boolean isDraft()

Returns true if message is draft.

isFlagged

public boolean isFlagged()

Returns true is message is flagged.

Returns:

true is message is flagged.

isRecent

public boolean isRecent()

Returns true if message is recent.

Returns:

true if message is recent.

isSeen

public boolean isSeen()

Returns true if message is seen.

Returns:

true if message is seen.

messageNumber

public int messageNumber()

Returns message number.

Returns:

message number

messageId

public java.lang.String messageId()

Returns message ID if set by server.

messageNumber

public ReceivedEmail messageNumber(int messageNumber)

Sets message number.

Parameters:

messageNumber - The message number to set.

Returns:

this

messageId

public ReceivedEmail messageId(java.lang.String messageId)

Sets message ID.

receivedDate

public ReceivedEmail receivedDate(java.util.Date date)

Sets email's received Date.

Parameters:

date - The received Date to set.

Returns:

this

receivedDate

public java.util.Date receivedDate()

Returns email's received Date.

Returns:

The email's received Date.

attachedMessages

public ReceivedEmail attachedMessages(java.util.List<ReceivedEmail> emails)

Adds attached ReceivedEmails.

Parameters:

emails - List of ReceivedEmails to attach.

attachedMessage

public ReceivedEmail attachedMessage(ReceivedEmail email)

Adds attached ReceivedEmail.

Parameters:

email - ReceivedEmail to attach.

Returns:

this

attachedMessages

public java.util.List<ReceivedEmail> attachedMessages()

Returns the List of attached messages. If no attached message is available, returns an empty List.

Returns:

List of ReceivedEmails.