org.apache.james.core

Class MimeMessageWrapper

java.lang.Object

javax.mail.Message

javax.mail.internet.MimeMessage

org.apache.james.core.MimeMessageWrapper

All Implemented Interfaces:

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

public class MimeMessageWrapper
extends javax.mail.internet.MimeMessage
implements Disposable

This object wraps a MimeMessage, only loading the underlying MimeMessage object when needed. Also tracks if changes were made to reduce unnecessary saves.

Nested Class Summary

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

javax.mail.internet.MimeMessage.RecipientType

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bodyModified This is false until we parse the message
protected boolean	headersModified This is false until we parse the message
protected boolean	messageParsed This is false until we parse the message
protected MimeMessageSource	source Can provide an input stream to the data
static String	USE_MEMORY_COPY System property which tells JAMES if it should copy a message in memory or via a temporary file.

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
MimeMessageWrapper(javax.mail.internet.MimeMessage original)
MimeMessageWrapper(MimeMessageSource source) A constructor that instantiates a MimeMessageWrapper based on a MimeMessageSource
MimeMessageWrapper(javax.mail.Session session, MimeMessageSource source) A constructor that instantiates a MimeMessageWrapper based on a MimeMessageSource

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String name, String value)
void	addHeaderLine(String line)
protected javax.mail.internet.InternetHeaders	createInternetHeaders(InputStream is) If we already parsed the headers then we simply return the updated ones.
void	dispose() Dispose the object
Enumeration	getAllHeaderLines()
Enumeration	getAllHeaders()
protected InputStream	getContentStream()
String[]	getHeader(String name) We override all the "headers" access methods to be sure that we loaded the headers
String	getHeader(String name, String delimiter)
int	getLineCount() Corrects JavaMail 1.1 version which always returns -1.
Enumeration	getMatchingHeaderLines(String[] names)
Enumeration	getMatchingHeaders(String[] names)
InputStream	getMessageInputStream() Return an InputStream which holds the full content of the message.
long	getMessageSize() Returns size of message, ie headers and content
Enumeration	getNonMatchingHeaderLines(String[] names)
Enumeration	getNonMatchingHeaders(String[] names)
InputStream	getRawInputStream()
int	getSize() This is the MimeMessage implementation - this should return ONLY the body, not the entire message (should not count headers).
String	getSourceId() Returns the source ID of the MimeMessageSource that is supplying this with data.
boolean	isBodyModified() Get whether the body of the message has been modified
boolean	isHeaderModified() Get whether the header of the message has been modified
boolean	isModified() Get whether the message has been modified.
protected void	loadHeaders() Load the message headers from the internal source.
void	loadMessage() Load the complete MimeMessage from the internal source.
protected void	parse(InputStream is)
void	removeHeader(String name)
void	setDataHandler(DataHandler arg0) The message is changed when working with headers and when altering the content.
void	setHeader(String name, String value)
protected void	updateMessageID() Overrides default javamail behaviour by not altering the Message-ID by default, see JAMES-875 and JAMES-1010
void	writeTo(OutputStream os) Rewritten for optimization purposes
void	writeTo(OutputStream headerOs, OutputStream bodyOs) Write
void	writeTo(OutputStream headerOs, OutputStream bodyOs, String[] ignoreList)
void	writeTo(OutputStream headerOs, OutputStream bodyOs, String[] ignoreList, boolean preLoad)
void	writeTo(OutputStream os, String[] ignoreList) Rewritten for optimization purposes

Methods inherited from class javax.mail.internet.MimeMessage

addFrom, addRecipients, addRecipients, createMimeMessage, getAllRecipients, getContent, getContentID, getContentLanguage, getContentMD5, getContentType, getDataHandler, getDescription, getDisposition, getEncoding, getFileName, getFlags, getFrom, getInputStream, getMessageID, getReceivedDate, getRecipients, getReplyTo, getSender, getSentDate, getSubject, isMimeType, isSet, reply, saveChanges, setContent, setContent, setContentID, setContentLanguage, setContentMD5, setDescription, setDescription, setDisposition, setFileName, setFlags, setFrom, setFrom, setRecipients, setRecipients, setReplyTo, setSender, setSentDate, setSubject, setSubject, setText, setText, setText, updateHeaders

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

Field Detail

USE_MEMORY_COPY

public static final String USE_MEMORY_COPY

System property which tells JAMES if it should copy a message in memory or via a temporary file. Default is the file

See Also:

Constant Field Values

source

protected MimeMessageSource source

Can provide an input stream to the data

messageParsed

protected boolean messageParsed

This is false until we parse the message

headersModified

protected boolean headersModified

This is false until we parse the message

bodyModified

protected boolean bodyModified

This is false until we parse the message

Constructor Detail

MimeMessageWrapper

public MimeMessageWrapper(javax.mail.Session session,
                  MimeMessageSource source)
                   throws javax.mail.MessagingException

A constructor that instantiates a MimeMessageWrapper based on a MimeMessageSource

Parameters:

source - the MimeMessageSource

Throws:

javax.mail.MessagingException

MimeMessageWrapper

public MimeMessageWrapper(MimeMessageSource source)
                   throws javax.mail.MessagingException

A constructor that instantiates a MimeMessageWrapper based on a MimeMessageSource

Parameters:

source - the MimeMessageSource

Throws:

javax.mail.MessagingException

javax.mail.MessagingException

MimeMessageWrapper

public MimeMessageWrapper(javax.mail.internet.MimeMessage original)
                   throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

Method Detail

updateMessageID

protected void updateMessageID()
                        throws javax.mail.MessagingException

Overrides default javamail behaviour by not altering the Message-ID by default, see JAMES-875 and JAMES-1010

Overrides:

updateMessageID in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

See Also:

MimeMessage.updateMessageID()

getSourceId

public String getSourceId()

Returns the source ID of the MimeMessageSource that is supplying this with data.

See Also:

MimeMessageSource

loadHeaders

protected void loadHeaders()
                    throws javax.mail.MessagingException

Load the message headers from the internal source.

Throws:

javax.mail.MessagingException - if an error is encountered while loading the headers

loadMessage

public void loadMessage()
                 throws javax.mail.MessagingException

Load the complete MimeMessage from the internal source.

Throws:

javax.mail.MessagingException - if an error is encountered while loading the message

isModified

public boolean isModified()

Get whether the message has been modified.

Returns:

whether the message has been modified

isBodyModified

public boolean isBodyModified()

Get whether the body of the message has been modified

Returns:

bodyModified

isHeaderModified

public boolean isHeaderModified()

Get whether the header of the message has been modified

Returns:

headersModified

writeTo

public void writeTo(OutputStream os)
             throws IOException,
                    javax.mail.MessagingException

Rewritten for optimization purposes

Specified by:

writeTo in interface javax.mail.Part

Overrides:

writeTo in class javax.mail.internet.MimeMessage

Throws:

IOException

javax.mail.MessagingException

writeTo

public void writeTo(OutputStream os,
           String[] ignoreList)
             throws IOException,
                    javax.mail.MessagingException

Rewritten for optimization purposes

Overrides:

writeTo in class javax.mail.internet.MimeMessage

Throws:

IOException

javax.mail.MessagingException

writeTo

public void writeTo(OutputStream headerOs,
           OutputStream bodyOs)
             throws IOException,
                    javax.mail.MessagingException

Write

Throws:

IOException

javax.mail.MessagingException

writeTo

public void writeTo(OutputStream headerOs,
           OutputStream bodyOs,
           String[] ignoreList)
             throws IOException,
                    javax.mail.MessagingException

Throws:

IOException

javax.mail.MessagingException

writeTo

public void writeTo(OutputStream headerOs,
           OutputStream bodyOs,
           String[] ignoreList,
           boolean preLoad)
             throws IOException,
                    javax.mail.MessagingException

Throws:

IOException

javax.mail.MessagingException

getSize

public int getSize()
            throws javax.mail.MessagingException

This is the MimeMessage implementation - this should return ONLY the body, not the entire message (should not count headers). This size will never change on MimeMessage.saveChanges()

Specified by:

getSize in interface javax.mail.Part

Overrides:

getSize in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

getLineCount

public int getLineCount()
                 throws javax.mail.MessagingException

Corrects JavaMail 1.1 version which always returns -1. Only corrected for content less than 5000 bytes, to avoid memory hogging.

Specified by:

getLineCount in interface javax.mail.Part

Overrides:

getLineCount in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

getMessageSize

public long getMessageSize()
                    throws javax.mail.MessagingException

Returns size of message, ie headers and content

Throws:

javax.mail.MessagingException

getHeader

public String[] getHeader(String name)
                   throws javax.mail.MessagingException

We override all the "headers" access methods to be sure that we loaded the headers

Specified by:

getHeader in interface javax.mail.Part

Overrides:

getHeader in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

getHeader

public String getHeader(String name,
               String delimiter)
                 throws javax.mail.MessagingException

Specified by:

getHeader in interface javax.mail.internet.MimePart

Overrides:

getHeader in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

getAllHeaders

public Enumeration getAllHeaders()
                          throws javax.mail.MessagingException

Specified by:

getAllHeaders in interface javax.mail.Part

Overrides:

getAllHeaders in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

getMatchingHeaders

public Enumeration getMatchingHeaders(String[] names)
                               throws javax.mail.MessagingException

Specified by:

getMatchingHeaders in interface javax.mail.Part

Overrides:

getMatchingHeaders in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

getNonMatchingHeaders

public Enumeration getNonMatchingHeaders(String[] names)
                                  throws javax.mail.MessagingException

Specified by:

getNonMatchingHeaders in interface javax.mail.Part

Overrides:

getNonMatchingHeaders in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

getAllHeaderLines

public Enumeration getAllHeaderLines()
                              throws javax.mail.MessagingException

Specified by:

getAllHeaderLines in interface javax.mail.internet.MimePart

Overrides:

getAllHeaderLines in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

getMatchingHeaderLines

public Enumeration getMatchingHeaderLines(String[] names)
                                   throws javax.mail.MessagingException

Specified by:

getMatchingHeaderLines in interface javax.mail.internet.MimePart

Overrides:

getMatchingHeaderLines in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

getNonMatchingHeaderLines

public Enumeration getNonMatchingHeaderLines(String[] names)
                                      throws javax.mail.MessagingException

Specified by:

getNonMatchingHeaderLines in interface javax.mail.internet.MimePart

Overrides:

getNonMatchingHeaderLines in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

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

addHeader

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

Specified by:

addHeader in interface javax.mail.Part

Overrides:

addHeader in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

removeHeader

public void removeHeader(String name)
                  throws javax.mail.MessagingException

Specified by:

removeHeader in interface javax.mail.Part

Overrides:

removeHeader in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

addHeaderLine

public void addHeaderLine(String line)
                   throws javax.mail.MessagingException

Specified by:

addHeaderLine in interface javax.mail.internet.MimePart

Overrides:

addHeaderLine in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

setDataHandler

public void setDataHandler(DataHandler arg0)
                    throws javax.mail.MessagingException

The message is changed when working with headers and when altering the content. Every method that alter the content will fallback to this one.

Specified by:

setDataHandler in interface javax.mail.Part

Overrides:

setDataHandler in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

See Also:

Part.setDataHandler(javax.activation.DataHandler)

dispose

public void dispose()

Description copied from interface: Disposable

Dispose the object

Specified by:

dispose in interface Disposable

See Also:

Disposable.dispose()

parse

protected void parse(InputStream is)
              throws javax.mail.MessagingException

Overrides:

parse in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

See Also:

MimeMessage.parse(java.io.InputStream)

createInternetHeaders

protected javax.mail.internet.InternetHeaders createInternetHeaders(InputStream is)
                                                             throws javax.mail.MessagingException

If we already parsed the headers then we simply return the updated ones. Otherwise we parse

Overrides:

createInternetHeaders in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

See Also:

MimeMessage.createInternetHeaders(java.io.InputStream)

getContentStream

protected InputStream getContentStream()
                                throws javax.mail.MessagingException

Overrides:

getContentStream in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

See Also:

MimeMessage.getContentStream()

getRawInputStream

public InputStream getRawInputStream()
                              throws javax.mail.MessagingException

Overrides:

getRawInputStream in class javax.mail.internet.MimeMessage

Throws:

javax.mail.MessagingException

See Also:

MimeMessage.getRawInputStream()

getMessageInputStream

public InputStream getMessageInputStream()
                                  throws javax.mail.MessagingException

Return an InputStream which holds the full content of the message. This method tries to optimize this call as far as possible. This stream contains the updated MimeMessage content if something was changed

Returns:

messageInputStream

Throws:

javax.mail.MessagingException