Package com.sun.mail.imap

Class IMAPMessage

java.lang.Object

jakarta.mail.Message

jakarta.mail.internet.MimeMessage

com.sun.mail.imap.IMAPMessage

All Implemented Interfaces:

ReadableMime, MimePart, Part

Direct Known Subclasses:

IMAPNestedMessage

public class IMAPMessage
extends MimeMessage
implements ReadableMime

This class implements an IMAPMessage object.

An IMAPMessage object starts out as a light-weight object. It gets filled-in incrementally when a request is made for some item. Or when a prefetch is done using the FetchProfile.

An IMAPMessage has a messageNumber and a sequenceNumber. The messageNumber is its index into its containing folder's messageCache. The sequenceNumber is its IMAP sequence-number.

Author:

John Mani, Bill Shannon

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IMAPMessage.FetchProfileCondition	This class implements the test to be done on each message in the folder.

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

MimeMessage.RecipientType

Field Summary

Fields

Modifier and Type	Field	Description
protected BODYSTRUCTURE	bs
protected ENVELOPE	envelope
protected Map<String,Object>	items	A map of the extension FETCH items.
protected String	sectionId

Fields inherited from class jakarta.mail.internet.MimeMessage

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

Fields inherited from class jakarta.mail.Message

expunged, folder, msgnum, session

Fields inherited from interface jakarta.mail.Part

ATTACHMENT, INLINE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IMAPMessage(IMAPFolder folder, int msgnum)	Constructor.
protected	IMAPMessage(Session session)	Constructor, for use by IMAPNestedMessage.

Method Summary

Modifier and Type	Method	Description
void	addFrom(Address[] addresses)
void	addHeader(String name, String value)
void	addHeaderLine(String line)
void	addRecipients(Message.RecipientType type, Address[] addresses)
protected void	checkExpunged()
protected Object	fetchItem(FetchItem fitem)	Fetch an individual item for the current message.
protected void	forceCheckExpunged()	Do a NOOP to force any untagged EXPUNGE responses and then check if this message is expunged.
Enumeration<String>	getAllHeaderLines()	Get all header-lines.
Enumeration<Header>	getAllHeaders()	Get all headers.
String	getContentID()	Get the Content-ID.
String[]	getContentLanguage()	Get the content language.
String	getContentMD5()	Get the Content-MD5.
protected InputStream	getContentStream()	Get all the bytes for this message.
String	getContentType()	Get the Content-Type.
DataHandler	getDataHandler()	Get the DataHandler object for this message.
String	getDescription()	Get the decoded Content-Description.
String	getDisposition()	Get the Content-Disposition.
String	getEncoding()	Get the Content-Transfer-Encoding.
protected int	getFetchBlockSize()
String	getFileName()	Get the "filename" Disposition parameter.
Flags	getFlags()	Get the Flags for this message.
Address[]	getFrom()	Get the "From" attribute.
String[]	getHeader(String name)	Get the named header.
String	getHeader(String name, String delimiter)	Get the named header.
String	getInReplyTo()	Get the In-Reply-To header.
Object	getItem(FetchItem fitem)	Return the data associated with the FetchItem.
int	getLineCount()	Get the total number of lines.
Enumeration<String>	getMatchingHeaderLines(String[] names)	Get all matching header-lines.
Enumeration<Header>	getMatchingHeaders(String[] names)	Get matching headers.
protected Object	getMessageCacheLock()	Get the messageCacheLock, associated with this Message's Folder.
String	getMessageID()	Get the Message-ID.
InputStream	getMimeStream()	Return the MIME format stream corresponding to this message.
long	getModSeq()	Return the modification sequence number (MODSEQ) for this message.
Enumeration<String>	getNonMatchingHeaderLines(String[] names)	Get all non-matching headerlines.
Enumeration<Header>	getNonMatchingHeaders(String[] names)	Get non-matching headers.
boolean	getPeek()	Get whether or not to use the PEEK variant of FETCH when fetching message content.
protected IMAPProtocol	getProtocol()	Get this message's folder's protocol connection.
Date	getReceivedDate()	Get the received date (INTERNALDATE).
Address[]	getRecipients(Message.RecipientType type)	Get the desired Recipient type.
Address[]	getReplyTo()	Get the ReplyTo addresses.
Address	getSender()	Get the "Sender" attribute.
Date	getSentDate()	Get the SentDate.
protected int	getSequenceNumber()	Get this message's IMAP sequence number.
int	getSize()	Get the message size.
long	getSizeLong()	Get the message size as a long.
String	getSubject()	Get the decoded subject.
protected long	getUID()	Return the UID for this message.
protected void	handleExtensionFetchItems(Map<String,Object> extensionItems)	Apply the data in the extension FETCH items to this message.
protected boolean	handleFetchItem(Item item, String[] hdrs, boolean allHeaders)	Apply the data in the FETCH item to this message.
protected boolean	ignoreBodyStructureSize()
void	invalidateHeaders()	Invalidate cached header and envelope information for this message.
protected boolean	isREV1()
boolean	isSet(Flags.Flag flag)	Test if the given Flags are set in this message.
void	removeHeader(String name)
void	setContentID(String cid)
void	setContentLanguage(String[] languages)
void	setContentMD5(String md5)
void	setDataHandler(DataHandler content)
void	setDescription(String description, String charset)
void	setDisposition(String disposition)
protected void	setExpunged(boolean set)
void	setFileName(String filename)
void	setFlags(Flags flag, boolean set)	Set/Unset the given flags in this message.
void	setFrom(Address address)
void	setHeader(String name, String value)
protected void	setMessageNumber(int msgnum)	Wrapper around the protected method Message.setMessageNumber() to make that method accessible to IMAPFolder.
void	setPeek(boolean peek)	Set whether or not to use the PEEK variant of FETCH when fetching message content.
void	setRecipients(Message.RecipientType type, Address[] addresses)
void	setReplyTo(Address[] addresses)
void	setSender(Address address)
void	setSentDate(Date d)
void	setSubject(String subject, String charset)
protected void	setUID(long uid)
void	writeTo(OutputStream os)	Write out the bytes into the given OutputStream.

Methods inherited from class jakarta.mail.internet.MimeMessage

addRecipients, createInternetHeaders, createMimeMessage, getAllRecipients, getContent, getInputStream, getRawInputStream, isMimeType, parse, reply, reply, saveChanges, setContent, setContent, setDescription, setFrom, setFrom, setRecipients, setSubject, setText, setText, setText, updateHeaders, updateMessageID, writeTo

Methods inherited from class jakarta.mail.Message

addRecipient, getFolder, getMessageNumber, getSession, isExpunged, match, setFlag, setRecipient

Methods inherited from class java.lang.Object

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

Field Details

bs

protected BODYSTRUCTURE bs

envelope

protected ENVELOPE envelope

items

protected Map<String,Object> items

A map of the extension FETCH items. In addition to saving the data in this map, an entry in this map indicates that we *have* the data, and so it doesn't need to be fetched again. The map is created only when needed, to avoid significantly increasing the effective size of an IMAPMessage object.

Since:

JavaMail 1.4.6

sectionId

protected String sectionId

Constructor Details

IMAPMessage

protected IMAPMessage(IMAPFolder folder,
 int msgnum)

Constructor.

Parameters:

folder - the folder containing this message

msgnum - the message sequence number

IMAPMessage

protected IMAPMessage(Session session)

Constructor, for use by IMAPNestedMessage.

Parameters:

session - the Session

Method Details

getProtocol

protected IMAPProtocol getProtocol()
                            throws ProtocolException,
FolderClosedException

Get this message's folder's protocol connection. Throws FolderClosedException, if the protocol connection is not available. ASSERT: Must hold the messageCacheLock.

Returns:

the IMAPProtocol object for the containing folder

Throws:

ProtocolException - for protocol errors

FolderClosedException - if the folder is closed

isREV1

protected boolean isREV1()
                  throws FolderClosedException

Throws:

FolderClosedException

getMessageCacheLock

protected Object getMessageCacheLock()

Get the messageCacheLock, associated with this Message's Folder.

Returns:

the message cache lock object

getSequenceNumber

protected int getSequenceNumber()

Get this message's IMAP sequence number. ASSERT: This method must be called only when holding the messageCacheLock.

Returns:

the message sequence number

setMessageNumber

protected void setMessageNumber(int msgnum)

Wrapper around the protected method Message.setMessageNumber() to make that method accessible to IMAPFolder.

Overrides:

setMessageNumber in class Message

getUID

protected long getUID()

Return the UID for this message. Returns -1 if not known; use UIDFolder.getUID() in this case.

Returns:

the UID

See Also:

• UIDFolder.getUID(jakarta.mail.Message)

setUID

protected void setUID(long uid)

getModSeq

public long getModSeq()
               throws MessagingException

Return the modification sequence number (MODSEQ) for this message. Returns -1 if not known.

Returns:

the modification sequence number

Throws:

MessagingException - for failures

Since:

JavaMail 1.5.1

See Also:

• "RFC 4551"

setExpunged

protected void setExpunged(boolean set)

Overrides:

setExpunged in class Message

checkExpunged

protected void checkExpunged()
                      throws MessageRemovedException

Throws:

MessageRemovedException

forceCheckExpunged

protected void forceCheckExpunged()
                           throws MessageRemovedException,
FolderClosedException

Do a NOOP to force any untagged EXPUNGE responses and then check if this message is expunged.

Throws:

MessageRemovedException - if the message has been removed

FolderClosedException - if the folder has been closed

getFetchBlockSize

protected int getFetchBlockSize()

ignoreBodyStructureSize

protected boolean ignoreBodyStructureSize()

getFrom

public Address[] getFrom()
                  throws MessagingException

Get the "From" attribute.

Overrides:

getFrom in class MimeMessage

Throws:

MessagingException

setFrom

public void setFrom(Address address)
             throws MessagingException

Overrides:

setFrom in class MimeMessage

Throws:

MessagingException

addFrom

public void addFrom(Address[] addresses)
             throws MessagingException

Overrides:

addFrom in class MimeMessage

Throws:

MessagingException

getSender

public Address getSender()
                  throws MessagingException

Get the "Sender" attribute.

Overrides:

getSender in class MimeMessage

Throws:

MessagingException

setSender

public void setSender(Address address)
               throws MessagingException

Overrides:

setSender in class MimeMessage

Throws:

MessagingException

getRecipients

public Address[] getRecipients(Message.RecipientType type)
                        throws MessagingException

Get the desired Recipient type.

Overrides:

getRecipients in class MimeMessage

Throws:

MessagingException

setRecipients

public void setRecipients(Message.RecipientType type,
 Address[] addresses)
                   throws MessagingException

Overrides:

setRecipients in class MimeMessage

Throws:

MessagingException

addRecipients

public void addRecipients(Message.RecipientType type,
 Address[] addresses)
                   throws MessagingException

Overrides:

addRecipients in class MimeMessage

Throws:

MessagingException

getReplyTo

public Address[] getReplyTo()
                     throws MessagingException

Get the ReplyTo addresses.

Overrides:

getReplyTo in class MimeMessage

Throws:

MessagingException

setReplyTo

public void setReplyTo(Address[] addresses)
                throws MessagingException

Overrides:

setReplyTo in class MimeMessage

Throws:

MessagingException

getSubject

public String getSubject()
                  throws MessagingException

Get the decoded subject.

Overrides:

getSubject in class MimeMessage

Throws:

MessagingException

setSubject

public void setSubject(String subject,
 String charset)
                throws MessagingException

Overrides:

setSubject in class MimeMessage

Throws:

MessagingException

getSentDate

public Date getSentDate()
                 throws MessagingException

Get the SentDate.

Overrides:

getSentDate in class MimeMessage

Throws:

MessagingException

setSentDate

public void setSentDate(Date d)
                 throws MessagingException

Overrides:

setSentDate in class MimeMessage

Throws:

MessagingException

getReceivedDate

public Date getReceivedDate()
                     throws MessagingException

Get the received date (INTERNALDATE).

Overrides:

getReceivedDate in class MimeMessage

Throws:

MessagingException

getSize

public int getSize()
            throws MessagingException

Get the message size.

Note that this returns RFC822.SIZE. That is, it's the size of the whole message, header and body included. Note also that if the size of the message is greater than Integer.MAX_VALUE (2GB), this method returns Integer.MAX_VALUE.

Specified by:

getSize in interface Part

Overrides:

getSize in class MimeMessage

Throws:

MessagingException

getSizeLong

public long getSizeLong()
                 throws MessagingException

Get the message size as a long.

Suitable for messages that might be larger than 2GB.

Returns:

the message size as a long integer

Throws:

MessagingException - for failures

Since:

JavaMail 1.6

getLineCount

public int getLineCount()
                 throws MessagingException

Get the total number of lines.

Returns the "body_fld_lines" field from the BODYSTRUCTURE. Note that this field is available only for text/plain and message/rfc822 types

Specified by:

getLineCount in interface Part

Overrides:

getLineCount in class MimeMessage

Throws:

MessagingException

getContentLanguage

public String[] getContentLanguage()
                            throws MessagingException

Get the content language.

Specified by:

getContentLanguage in interface MimePart

Overrides:

getContentLanguage in class MimeMessage

Throws:

MessagingException

setContentLanguage

public void setContentLanguage(String[] languages)
                        throws MessagingException

Specified by:

setContentLanguage in interface MimePart

Overrides:

setContentLanguage in class MimeMessage

Throws:

MessagingException

getInReplyTo

public String getInReplyTo()
                    throws MessagingException

Get the In-Reply-To header.

Returns:

the In-Reply-To header

Throws:

MessagingException - for failures

Since:

JavaMail 1.3.3

getContentType

public String getContentType()
                      throws MessagingException

Get the Content-Type. Generate this header from the BODYSTRUCTURE. Append parameters as well.

Specified by:

getContentType in interface Part

Overrides:

getContentType in class MimeMessage

Throws:

MessagingException

getDisposition

public String getDisposition()
                      throws MessagingException

Get the Content-Disposition.

Specified by:

getDisposition in interface Part

Overrides:

getDisposition in class MimeMessage

Throws:

MessagingException

setDisposition

public void setDisposition(String disposition)
                    throws MessagingException

Specified by:

setDisposition in interface Part

Overrides:

setDisposition in class MimeMessage

Throws:

MessagingException

getEncoding

public String getEncoding()
                   throws MessagingException

Get the Content-Transfer-Encoding.

Specified by:

getEncoding in interface MimePart

Overrides:

getEncoding in class MimeMessage

Throws:

MessagingException

getContentID

public String getContentID()
                    throws MessagingException

Get the Content-ID.

Specified by:

getContentID in interface MimePart

Overrides:

getContentID in class MimeMessage

Throws:

MessagingException

setContentID

public void setContentID(String cid)
                  throws MessagingException

Overrides:

setContentID in class MimeMessage

Throws:

MessagingException

getContentMD5

public String getContentMD5()
                     throws MessagingException

Get the Content-MD5.

Specified by:

getContentMD5 in interface MimePart

Overrides:

getContentMD5 in class MimeMessage

Throws:

MessagingException

setContentMD5

public void setContentMD5(String md5)
                   throws MessagingException

Specified by:

setContentMD5 in interface MimePart

Overrides:

setContentMD5 in class MimeMessage

Throws:

MessagingException

getDescription

public String getDescription()
                      throws MessagingException

Get the decoded Content-Description.

Specified by:

getDescription in interface Part

Overrides:

getDescription in class MimeMessage

Throws:

MessagingException

setDescription

public void setDescription(String description,
 String charset)
                    throws MessagingException

Overrides:

setDescription in class MimeMessage

Throws:

MessagingException

getMessageID

public String getMessageID()
                    throws MessagingException

Get the Message-ID.

Overrides:

getMessageID in class MimeMessage

Throws:

MessagingException

getFileName

public String getFileName()
                   throws MessagingException

Get the "filename" Disposition parameter. (Only available in IMAP4rev1). If thats not available, get the "name" ContentType parameter.

Specified by:

getFileName in interface Part

Overrides:

getFileName in class MimeMessage

Throws:

MessagingException

setFileName

public void setFileName(String filename)
                 throws MessagingException

Specified by:

setFileName in interface Part

Overrides:

setFileName in class MimeMessage

Throws:

MessagingException

getContentStream

protected InputStream getContentStream()
                                throws MessagingException

Get all the bytes for this message. Overrides getContentStream() in MimeMessage. This method is ultimately used by the DataHandler to obtain the input stream for this message.

Overrides:

getContentStream in class MimeMessage

Throws:

MessagingException

See Also:

• MimeMessage.getContentStream()

getDataHandler

public DataHandler getDataHandler()
                           throws MessagingException

Get the DataHandler object for this message.

Specified by:

getDataHandler in interface Part

Overrides:

getDataHandler in class MimeMessage

Throws:

MessagingException

setDataHandler

public void setDataHandler(DataHandler content)
                    throws MessagingException

Specified by:

setDataHandler in interface Part

Overrides:

setDataHandler in class MimeMessage

Throws:

MessagingException

getMimeStream

public InputStream getMimeStream()
                          throws MessagingException

Return the MIME format stream corresponding to this message.

Specified by:

getMimeStream in interface ReadableMime

Returns:

the MIME format stream

Throws:

MessagingException - for failures

Since:

JavaMail 1.4.5

writeTo

public void writeTo(OutputStream os)
             throws IOException,
MessagingException

Write out the bytes into the given OutputStream.

Specified by:

writeTo in interface Part

Overrides:

writeTo in class MimeMessage

Throws:

IOException

MessagingException

getHeader

public String[] getHeader(String name)
                   throws MessagingException

Get the named header.

Specified by:

getHeader in interface Part

Overrides:

getHeader in class MimeMessage

Throws:

MessagingException

getHeader

public String getHeader(String name,
 String delimiter)
                 throws MessagingException

Get the named header.

Specified by:

getHeader in interface MimePart

Overrides:

getHeader in class MimeMessage

Throws:

MessagingException

setHeader

public void setHeader(String name,
 String value)
               throws MessagingException

Specified by:

setHeader in interface Part

Overrides:

setHeader in class MimeMessage

Throws:

MessagingException

addHeader

public void addHeader(String name,
 String value)
               throws MessagingException

Specified by:

addHeader in interface Part

Overrides:

addHeader in class MimeMessage

Throws:

MessagingException

removeHeader

public void removeHeader(String name)
                  throws MessagingException

Specified by:

removeHeader in interface Part

Overrides:

removeHeader in class MimeMessage

Throws:

MessagingException

getAllHeaders

public Enumeration<Header> getAllHeaders()
                                  throws MessagingException

Get all headers.

Specified by:

getAllHeaders in interface Part

Overrides:

getAllHeaders in class MimeMessage

Throws:

MessagingException

getMatchingHeaders

public Enumeration<Header> getMatchingHeaders(String[] names)
                                       throws MessagingException

Get matching headers.

Specified by:

getMatchingHeaders in interface Part

Overrides:

getMatchingHeaders in class MimeMessage

Throws:

MessagingException

getNonMatchingHeaders

public Enumeration<Header> getNonMatchingHeaders(String[] names)
                                          throws MessagingException

Get non-matching headers.

Specified by:

getNonMatchingHeaders in interface Part

Overrides:

getNonMatchingHeaders in class MimeMessage

Throws:

MessagingException

addHeaderLine

public void addHeaderLine(String line)
                   throws MessagingException

Specified by:

addHeaderLine in interface MimePart

Overrides:

addHeaderLine in class MimeMessage

Throws:

MessagingException

getAllHeaderLines

public Enumeration<String> getAllHeaderLines()
                                      throws MessagingException

Get all header-lines.

Specified by:

getAllHeaderLines in interface MimePart

Overrides:

getAllHeaderLines in class MimeMessage

Throws:

MessagingException

getMatchingHeaderLines

public Enumeration<String> getMatchingHeaderLines(String[] names)
                                           throws MessagingException

Get all matching header-lines.

Specified by:

getMatchingHeaderLines in interface MimePart

Overrides:

getMatchingHeaderLines in class MimeMessage

Throws:

MessagingException

getNonMatchingHeaderLines

public Enumeration<String> getNonMatchingHeaderLines(String[] names)
                                              throws MessagingException

Get all non-matching headerlines.

Specified by:

getNonMatchingHeaderLines in interface MimePart

Overrides:

getNonMatchingHeaderLines in class MimeMessage

Throws:

MessagingException

getFlags

public Flags getFlags()
               throws MessagingException

Get the Flags for this message.

Overrides:

getFlags in class MimeMessage

Throws:

MessagingException

isSet

public boolean isSet(Flags.Flag flag)
              throws MessagingException

Test if the given Flags are set in this message.

Overrides:

isSet in class MimeMessage

Throws:

MessagingException

setFlags

public void setFlags(Flags flag,
 boolean set)
              throws MessagingException

Set/Unset the given flags in this message.

Overrides:

setFlags in class MimeMessage

Throws:

MessagingException

setPeek

public void setPeek(boolean peek)

Set whether or not to use the PEEK variant of FETCH when fetching message content. This overrides the default value from the "mail.imap.peek" property.

Parameters:

peek - the peek flag

Since:

JavaMail 1.3.3

getPeek

public boolean getPeek()

Get whether or not to use the PEEK variant of FETCH when fetching message content.

Returns:

the peek flag

Since:

JavaMail 1.3.3

invalidateHeaders

public void invalidateHeaders()

Invalidate cached header and envelope information for this message. Subsequent accesses of this information will cause it to be fetched from the server.

Since:

JavaMail 1.3.3

handleFetchItem

protected boolean handleFetchItem(Item item,
 String[] hdrs,
 boolean allHeaders)
                           throws MessagingException

Apply the data in the FETCH item to this message. ASSERT: Must hold the messageCacheLock.

Parameters:

item - the fetch item

hdrs - the headers we're asking for

allHeaders - load all headers?

Returns:

did we handle this fetch item?

Throws:

MessagingException - for failures

Since:

JavaMail 1.4.6

handleExtensionFetchItems

protected void handleExtensionFetchItems(Map<String,Object> extensionItems)

Apply the data in the extension FETCH items to this message. This method adds all the items to the items map. Subclasses may override this method to call super and then also copy the data to a more convenient form. ASSERT: Must hold the messageCacheLock.

Parameters:

extensionItems - the Map to add fetch items to

Since:

JavaMail 1.4.6

fetchItem

protected Object fetchItem(FetchItem fitem)
                    throws MessagingException

Fetch an individual item for the current message. Note that handleExtensionFetchItems will have been called to store this item in the message before this method returns.

Parameters:

fitem - the FetchItem

Returns:

the data associated with the FetchItem

Throws:

MessagingException - for failures

Since:

JavaMail 1.4.6

getItem

public Object getItem(FetchItem fitem)
               throws MessagingException

Return the data associated with the FetchItem. If the data hasn't been fetched, call the fetchItem method to fetch it. Returns null if there is no data for the FetchItem.

Parameters:

fitem - the FetchItem

Returns:

the data associated with the FetchItem

Throws:

MessagingException - for failures

Since:

JavaMail 1.4.6