com.atlassian.confluence.mail.archive
Interface Mail

All Superinterfaces:

Content

All Known Implementing Classes:

ContentBackedMail

public interface Mail
extends Content

Field Summary

static java.lang.String	CONTENT_TYPE
static java.lang.String	DEFAULT_NO_SUBJECT
static int	MESSAGE_ID_SIZE
static int	MESSAGE_SUBJECT_SIZE

Method Summary

java.lang.String	getCanonicalSubject() Get the canonical subject of this mail.
CustomContentEntityObject	getEntity() Gets the ContentEntityObject that backs this piece of content.
ConfluenceMailAddress	getFrom()
java.lang.String	getInReplyTo() If this mail has an In-Reply-To header, get the message ID of the email that this message is a response to.
java.lang.String	getMessageBody()
java.lang.String	getMessageId()
java.util.Collection<ConfluenceMailAddress>	getRecipients()
java.util.Collection<java.lang.String>	getReferences()
java.util.Date	getSentDate() Gets the date this mail was sent;
Space	getSpace() Get the space this mail belongs to
java.lang.String	getSpaceKey()
java.lang.String	getSubject() Get the subject line of this mail.

Field Detail

MESSAGE_ID_SIZE

static final int MESSAGE_ID_SIZE

See Also:

Constant Field Values

MESSAGE_SUBJECT_SIZE

static final int MESSAGE_SUBJECT_SIZE

See Also:

Constant Field Values

CONTENT_TYPE

static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

DEFAULT_NO_SUBJECT

static final java.lang.String DEFAULT_NO_SUBJECT

See Also:

Constant Field Values

Method Detail

getEntity

CustomContentEntityObject getEntity()

Description copied from interface: Content

Gets the ContentEntityObject that backs this piece of content.

Specified by:

getEntity in interface Content

Returns:

the persistent object behind this content

getSpaceKey

java.lang.String getSpaceKey()

getMessageId

java.lang.String getMessageId()

getMessageBody

java.lang.String getMessageBody()

getCanonicalSubject

java.lang.String getCanonicalSubject()

Get the canonical subject of this mail. The canonical form removes all Re: and Fwd: style prefixes on the email, returning what should be the original emails subject. All emails within a thread will have the same canonical subject.

See Also:

getSubject()

getSubject

java.lang.String getSubject()

Get the subject line of this mail.

Returns:

the mail's subject line

getInReplyTo

java.lang.String getInReplyTo()

If this mail has an In-Reply-To header, get the message ID of the email that this message is a response to.

Returns:

the message ID of the email this message is a response to, if available.

getSpace

Space getSpace()

Get the space this mail belongs to

Returns:

the space this mail belongs to

getSentDate

java.util.Date getSentDate()

Gets the date this mail was sent;

Returns:

the date this mail was sent.

getFrom

ConfluenceMailAddress getFrom()

getRecipients

java.util.Collection<ConfluenceMailAddress> getRecipients()

getReferences

java.util.Collection<java.lang.String> getReferences()