org.xwiki.mail

Class ExtendedMimeMessage

java.lang.Object

javax.mail.Message

javax.mail.internet.MimeMessage

org.xwiki.mail.ExtendedMimeMessage

All Implemented Interfaces:

javax.mail.internet.MimePart, javax.mail.Part

public class ExtendedMimeMessage
extends javax.mail.internet.MimeMessage

Extension of the MimeMessage in order to support processing by this mail API.

Since:

7.4.1

Version:

$Id: 3dc68f67016d8064f698487fffe4581062e33f73 $

Nested Class Summary

Nested classes/interfaces inherited from class javax.mail.internet.MimeMessage

javax.mail.internet.MimeMessage.RecipientType

Field Summary

Fields inherited from class javax.mail.internet.MimeMessage

content, contentStream, dh, flags, headers, modified, saved

Fields inherited from class javax.mail.Message

expunged, folder, msgnum, session

Fields inherited from interface javax.mail.Part

ATTACHMENT, INLINE

Constructor Summary

Constructors

Constructor and Description
ExtendedMimeMessage() Create a new extended MimeMessage.
ExtendedMimeMessage(javax.mail.internet.MimeMessage source)
ExtendedMimeMessage(javax.mail.Session session, InputStream is) Constructs a MimeMessage by reading and parsing the data from the specified MIME InputStream.

Method Summary

Modifier and Type	Method and Description
boolean	ensureSaved() Ensure that a message is saved to ensure the stability of its Message-ID header.
String	getType() Retrieve what type of email is being sent (see setType(String)).
String	getUniqueMessageId() Compute a unique message identifier for this mime message.
boolean	isEmpty()
void	setHeader(String name, String value)
void	setMessageId(String messageId) Save the message and set the message-ID headers of the message to the provided value.
void	setType(String mailType) Specifies what type of email is being sent.
static ExtendedMimeMessage	wrap(javax.mail.internet.MimeMessage message) Helper method to wrap any MimeMessage into an ExtendedMimeMessage, without double wrapping.

Methods inherited from class javax.mail.internet.MimeMessage

addFrom, addHeader, addHeaderLine, addRecipients, addRecipients, createInternetHeaders, createMimeMessage, getAllHeaderLines, getAllHeaders, getAllRecipients, getContent, getContentID, getContentLanguage, getContentMD5, getContentStream, getContentType, getDataHandler, getDescription, getDisposition, getEncoding, getFileName, getFlags, getFrom, getHeader, getHeader, getInputStream, getLineCount, getMatchingHeaderLines, getMatchingHeaders, getMessageID, getNonMatchingHeaderLines, getNonMatchingHeaders, getRawInputStream, getReceivedDate, getRecipients, getReplyTo, getSender, getSentDate, getSize, getSubject, isMimeType, isSet, parse, removeHeader, reply, saveChanges, setContent, setContent, setContentID, setContentLanguage, setContentMD5, setDataHandler, setDescription, setDescription, setDisposition, setFileName, setFlags, setFrom, setFrom, setRecipients, setRecipients, setReplyTo, setSender, setSentDate, setSubject, setSubject, setText, setText, setText, updateHeaders, updateMessageID, writeTo, writeTo

Methods inherited from class javax.mail.Message

addRecipient, getFolder, getMessageNumber, isExpunged, match, setExpunged, setFlag, setMessageNumber, setRecipient

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedMimeMessage

public ExtendedMimeMessage()

Create a new extended MimeMessage. Note: We don't care about supporting Session here ATM since it's not required. MimeMessages will be given a valid Session when it's deserialized from the mail content store for sending.

ExtendedMimeMessage

public ExtendedMimeMessage(javax.mail.Session session,
                           InputStream is)
                    throws javax.mail.MessagingException

Constructs a MimeMessage by reading and parsing the data from the specified MIME InputStream.

Parameters:

session - Session object for this message

is - the message input stream

Throws:

javax.mail.MessagingException - on error

ExtendedMimeMessage

public ExtendedMimeMessage(javax.mail.internet.MimeMessage source)
                    throws javax.mail.MessagingException

Parameters:

source - see javadoc for MimeMessage.MimeMessage(javax.mail.internet.MimeMessage)

Throws:

javax.mail.MessagingException - see javadoc for MimeMessage.MimeMessage(javax.mail.internet.MimeMessage)

Method Detail

wrap

public static ExtendedMimeMessage wrap(javax.mail.internet.MimeMessage message)

Helper method to wrap any MimeMessage into an ExtendedMimeMessage, without double wrapping.

Parameters:

message - the MimeMessage to wrap.

Returns:

the ExtendedMimeMessage.

Throws:

RuntimeException - if an error occurs during the conversion, which is unexpected if the initial message is a fully formed MimeMessage or already an ExtendedMimeMessage.

isEmpty

public boolean isEmpty()

Returns:

true if no body content has been defined yet for this message or false otherwise

setType

public void setType(String mailType)

Specifies what type of email is being sent. This is useful for applications to specify a type when they send mail. This allows (for example) to filter these emails in the Mail Sender Status Admin UI.

Parameters:

mailType - the type of mail being sent (e.g "Watchlist", "Reset Password", "Send Page by Mail", etc)

getType

public String getType()

Retrieve what type of email is being sent (see setType(String)).

Returns:

the type of mail being sent (e.g "Watchlist", "Reset Password", "Send Page by Mail", etc)

setMessageId

public void setMessageId(String messageId)

Save the message and set the message-ID headers of the message to the provided value.

Parameters:

messageId - message identifier to be set on the message header.

ensureSaved

public boolean ensureSaved()
                    throws javax.mail.MessagingException

Ensure that a message is saved to ensure the stability of its Message-ID header.

Returns:

true if the message has been saved, false if it was already saved.

Throws:

javax.mail.MessagingException - on error

setHeader

public void setHeader(String name,
                      String value)
               throws javax.mail.MessagingException

Specified by:

setHeader in interface javax.mail.Part

Overrides:

setHeader in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

getUniqueMessageId

public String getUniqueMessageId()

Compute a unique message identifier for this mime message. The unique identifier is based on the message-ID header and the recipients. If no message-ID is found, the message is first saved in order to generate a message-ID.

Returns:

a unique identifier for this message