gnu.mail.providers.imap

Class IMAPMessage

java.lang.Object

javax.mail.Message

javax.mail.internet.MimeMessage

gnu.mail.providers.ReadOnlyMessage

gnu.mail.providers.imap.IMAPMessage

All Implemented Interfaces:

MimePart, Part

public final class IMAPMessage
extends gnu.mail.providers.ReadOnlyMessage

The message class implementing the IMAP4 mail protocol.

Nested Class Summary

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

MimeMessage.RecipientType

Field Summary

Fields inherited from class javax.mail.internet.MimeMessage

cachedContent, 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

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Enumeration	getAllHeaderLines() Returns all the header-lines.
java.util.Enumeration	getAllHeaders() Returns all the headers.
java.lang.String	getContentID() Returns the value of the Content-ID header field.
java.lang.String[]	getContentLanguage() Returns the languages specified in the Content-Language header field of this message, as defined by RFC 1766.
protected java.io.InputStream	getContentStream() Returns the unencoded bytes of the content.
java.lang.String	getContentType() Returns the value of the RFC 822 Content-Type header field, or "text/plain" if the header is not available.
javax.activation.DataHandler	getDataHandler() Returns a data handler for accessing this message's content.
java.lang.String	getDescription() Returns the Content-Description header field of this message.
java.lang.String	getDisposition() Returns the value of the RFC 822 Content-Disposition header field, or null if the header is not available.
java.lang.String	getEncoding() Returns the value of the Content-Transfer-Encoding header field.
java.lang.String	getFileName() Returns the filename associated with this message.
Flags	getFlags() Returns the flags for this message.
java.lang.String[]	getHeader(java.lang.String name) Returns the specified header field.
java.lang.String	getHeader(java.lang.String name, java.lang.String delimiter) Returns the specified header field.
int	getLineCount() Returns the number of lines in the content of this message, or -1 if this number cannot be determined.
java.util.Enumeration	getMatchingHeaderLines(java.lang.String[] names) Returns all the header-lines with any of the given names.
java.util.Enumeration	getMatchingHeaders(java.lang.String[] names) Returns all the headers with any of the given names.
java.lang.String	getMessageID() Returns the value of the Message-ID header field.
java.util.Enumeration	getNonMatchingHeaderLines(java.lang.String[] names) Returns all the header-lines without any of the given names.
java.util.Enumeration	getNonMatchingHeaders(java.lang.String[] names) Returns all the headers without any of the given names.
java.util.Date	getReceivedDate() Returns the date on which this message was received.
java.util.Date	getSentDate() Returns the value of the RFC 822 Date field.
int	getSize() Returns the size of the content of this message in bytes, or -1 if the size cannot be determined.
java.lang.String	getSubject() Returns the value of the Subject header field.
boolean	isSet(Flags.Flag flag) Indicates whether the specified flag is set in this message.
void	setFlags(Flags flag, boolean set) Set the specified flags.
protected void	updateHeaders() Updates the headers of this part, based on the content.

Methods inherited from class gnu.mail.providers.ReadOnlyMessage

addHeader, addHeaderLine, removeHeader, saveChanges, setContent, setContent, setHeader

Methods inherited from class javax.mail.internet.MimeMessage

addFrom, addRecipients, addRecipients, createInternetHeaders, createMimeMessage, getAllRecipients, getContent, getContentMD5, getFrom, getInputStream, getRawInputStream, getRecipients, getReplyTo, getSender, isMimeType, parse, reply, reply, setContentID, setContentLanguage, setContentMD5, setDataHandler, setDescription, setDescription, setDisposition, setFileName, setFrom, setFrom, setFrom, setRecipients, setRecipients, setReplyTo, setSender, setSentDate, setSubject, setSubject, setText, setText, setText, updateMessageId, writeTo, writeTo

Methods inherited from class javax.mail.Message

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

Methods inherited from class java.lang.Object

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

Method Detail

getReceivedDate

public java.util.Date getReceivedDate()
                               throws MessagingException

Description copied from class: MimeMessage

Returns the date on which this message was received. This returns null if the received date cannot be obtained.

Overrides:

getReceivedDate in class MimeMessage

Throws:

MessagingException

getSize

public int getSize()
            throws MessagingException

Description copied from class: MimeMessage

Returns the size of the content of this message in bytes, or -1 if the size cannot be determined.

Note that this number may not be an exact measure, but if not -1, it will be suitable for display to the user.

Specified by:

getSize in interface Part

Overrides:

getSize in class MimeMessage

Throws:

MessagingException

getLineCount

public int getLineCount()
                 throws MessagingException

Description copied from class: MimeMessage

Returns the number of lines in the content of this message, or -1 if this number cannot be determined.

Note that this number may not be an exact measure, but if not -1, it will be suitable for display to the user.

Specified by:

getLineCount in interface Part

Overrides:

getLineCount in class MimeMessage

Throws:

MessagingException

getContentType

public java.lang.String getContentType()
                                throws MessagingException

Description copied from class: MimeMessage

Returns the value of the RFC 822 Content-Type header field, or "text/plain" if the header is not available.

Specified by:

getContentType in interface Part

Overrides:

getContentType in class MimeMessage

Throws:

MessagingException

getDisposition

public java.lang.String getDisposition()
                                throws MessagingException

Description copied from class: MimeMessage

Returns the value of the RFC 822 Content-Disposition header field, or null if the header is not available.

Specified by:

getDisposition in interface Part

Overrides:

getDisposition in class MimeMessage

Throws:

MessagingException

See Also:

MimeBodyPart.getDisposition()

getEncoding

public java.lang.String getEncoding()
                             throws MessagingException

Description copied from class: MimeMessage

Returns the value of the Content-Transfer-Encoding header field.

Specified by:

getEncoding in interface MimePart

Overrides:

getEncoding in class MimeMessage

Throws:

MessagingException

See Also:

MimeBodyPart.getEncoding()

getContentID

public java.lang.String getContentID()
                              throws MessagingException

Description copied from class: MimeMessage

Returns the value of the Content-ID header field.

Specified by:

getContentID in interface MimePart

Overrides:

getContentID in class MimeMessage

Throws:

MessagingException

See Also:

MimeBodyPart.getContentID()

getContentLanguage

public java.lang.String[] getContentLanguage()
                                      throws MessagingException

Description copied from class: MimeMessage

Returns the languages specified in the Content-Language header field of this message, as defined by RFC 1766. This method returns null if this header is not available.

Specified by:

getContentLanguage in interface MimePart

Overrides:

getContentLanguage in class MimeMessage

Throws:

MessagingException

See Also:

MimeBodyPart.getContentLanguage()

getDescription

public java.lang.String getDescription()
                                throws MessagingException

Description copied from class: MimeMessage

Returns the Content-Description header field of this message.

If the Content-Description field is encoded as per RFC 2047, it is decoded and converted into Unicode.

Specified by:

getDescription in interface Part

Overrides:

getDescription in class MimeMessage

Throws:

MessagingException

See Also:

MimeBodyPart.getDescription()

getMessageID

public java.lang.String getMessageID()
                              throws MessagingException

Description copied from class: MimeMessage

Returns the value of the Message-ID header field.

Overrides:

getMessageID in class MimeMessage

Throws:

MessagingException

getFileName

public java.lang.String getFileName()
                             throws MessagingException

Description copied from class: MimeMessage

Returns the filename associated with this message.

This method returns the value of the "filename" parameter from the Content-Disposition header field of this message. If the latter is not available, it returns the value of the "name" parameter from the Content-Type header field.

Specified by:

getFileName in interface Part

Overrides:

getFileName in class MimeMessage

Throws:

MessagingException

See Also:

MimeBodyPart.getFileName()

getContentStream

protected java.io.InputStream getContentStream()
                                        throws MessagingException

Description copied from class: MimeMessage

Returns the unencoded bytes of the content.

Overrides:

getContentStream in class MimeMessage

Throws:

MessagingException

See Also:

MimeBodyPart.getContentStream()

getDataHandler

public javax.activation.DataHandler getDataHandler()
                                            throws MessagingException

Description copied from class: MimeMessage

Returns a data handler for accessing this message's content.

Specified by:

getDataHandler in interface Part

Overrides:

getDataHandler in class MimeMessage

Throws:

MessagingException

updateHeaders

protected void updateHeaders()
                      throws MessagingException

Description copied from class: MimeMessage

Updates the headers of this part, based on the content.

Overrides:

updateHeaders in class MimeMessage

Throws:

MessagingException

See Also:

MimeBodyPart.updateHeaders()

getHeader

public java.lang.String[] getHeader(java.lang.String name)
                             throws MessagingException

Returns the specified header field.

Specified by:

getHeader in interface Part

Overrides:

getHeader in class MimeMessage

Parameters:

name - the header name

Throws:

MessagingException

getHeader

public java.lang.String getHeader(java.lang.String name,
                         java.lang.String delimiter)
                           throws MessagingException

Returns the specified header field.

Specified by:

getHeader in interface MimePart

Overrides:

getHeader in class MimeMessage

Parameters:

name - the header name

delimiter - the delimiter

Throws:

MessagingException

getAllHeaders

public java.util.Enumeration getAllHeaders()
                                    throws MessagingException

Description copied from class: MimeMessage

Returns all the headers.

Specified by:

getAllHeaders in interface Part

Overrides:

getAllHeaders in class MimeMessage

Returns:

an Enumeration of Header objects

Throws:

MessagingException

getAllHeaderLines

public java.util.Enumeration getAllHeaderLines()
                                        throws MessagingException

Description copied from class: MimeMessage

Returns all the header-lines.

Specified by:

getAllHeaderLines in interface MimePart

Overrides:

getAllHeaderLines in class MimeMessage

Returns:

an Enumeration of Strings

Throws:

MessagingException

getMatchingHeaders

public java.util.Enumeration getMatchingHeaders(java.lang.String[] names)
                                         throws MessagingException

Description copied from class: MimeMessage

Returns all the headers with any of the given names.

Specified by:

getMatchingHeaders in interface Part

Overrides:

getMatchingHeaders in class MimeMessage

Parameters:

names - the header names to match

Returns:

an Enumeration of Header objects

Throws:

MessagingException

getMatchingHeaderLines

public java.util.Enumeration getMatchingHeaderLines(java.lang.String[] names)
                                             throws MessagingException

Description copied from class: MimeMessage

Returns all the header-lines with any of the given names.

Specified by:

getMatchingHeaderLines in interface MimePart

Overrides:

getMatchingHeaderLines in class MimeMessage

Returns:

an Enumeration of Strings

Throws:

MessagingException

getNonMatchingHeaders

public java.util.Enumeration getNonMatchingHeaders(java.lang.String[] names)
                                            throws MessagingException

Description copied from class: MimeMessage

Returns all the headers without any of the given names.

Specified by:

getNonMatchingHeaders in interface Part

Overrides:

getNonMatchingHeaders in class MimeMessage

Parameters:

names - the header names to ignore

Returns:

an Enumeration of Header objects

Throws:

MessagingException

getNonMatchingHeaderLines

public java.util.Enumeration getNonMatchingHeaderLines(java.lang.String[] names)
                                                throws MessagingException

Description copied from class: MimeMessage

Returns all the header-lines without any of the given names.

Specified by:

getNonMatchingHeaderLines in interface MimePart

Overrides:

getNonMatchingHeaderLines in class MimeMessage

Returns:

an Enumeration of Strings

Throws:

MessagingException

getSubject

public java.lang.String getSubject()
                            throws MessagingException

Description copied from class: MimeMessage

Returns the value of the Subject header field.

If the subject is encoded as per RFC 2047, it is decoded and converted into Unicode.

Overrides:

getSubject in class MimeMessage

Throws:

MessagingException

getSentDate

public java.util.Date getSentDate()
                           throws MessagingException

Description copied from class: MimeMessage

Returns the value of the RFC 822 Date field. This is the date on which this message was sent.

Overrides:

getSentDate in class MimeMessage

Throws:

MessagingException

getFlags

public Flags getFlags()
               throws MessagingException

Description copied from class: MimeMessage

Returns the flags for this message.

Overrides:

getFlags in class MimeMessage

Throws:

MessagingException

isSet

public boolean isSet(Flags.Flag flag)
              throws MessagingException

Description copied from class: MimeMessage

Indicates whether the specified flag is set in this message.

Overrides:

isSet in class MimeMessage

Parameters:

flag - the flag

Throws:

MessagingException

setFlags

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

Set the specified flags.

Overrides:

setFlags in class gnu.mail.providers.ReadOnlyMessage

Parameters:

flag - the flags to be set

set - the value to be set

Throws:

IllegalWriteException - if the underlying implementation does not support modification of existing values

MessagingException