public class

IMAPMessage

extends MimeMessage

java.lang.Object
↳	com.google.code.javax.mail.Message
	↳	com.google.code.javax.mail.internet.MimeMessage
		↳	com.google.code.com.sun.mail.imap.IMAPMessage

Known Direct Subclasses

IMAPNestedMessage

Class Overview

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.

Summary

[Expand]

Inherited Constants

From interface com.google.code.javax.mail.Part

Fields
private static String	EnvelopeCmd
protected BODYSTRUCTURE	bs
private String	description
protected ENVELOPE	envelope
private boolean	headersLoaded
private Hashtable	loadedHeaders
private boolean	peek
private Date	receivedDate
protected String	sectionId
private int	size
private String	subject
private String	type
private long	uid
private String[]	x_gm_labels
private long	x_gm_msgid
private long	x_gm_thrid

[Expand]

Inherited Fields

From class com.google.code.javax.mail.internet.MimeMessage

private static final Flags	answeredFlag
Object	cachedContent	If our content is a Multipart of Message object, we save it the first time it's created by parsing a stream so that changes to the contained objects will not be lost.
protected byte[]	content	Byte array that holds the bytes of this Message's content.
protected InputStream	contentStream	If the data for this message was supplied by an InputStream that implements the SharedInputStream interface, `contentStream` is another such stream representing the content of this message.
protected DataHandler	dh	The DataHandler object representing this Message's content.
protected Flags	flags	The Flags for this message.
protected InternetHeaders	headers	The InternetHeaders object that stores the header of this message.
private static final MailDateFormat	mailDateFormat
protected boolean	modified	A flag indicating whether the message has been modified.
protected boolean	saved	Does the `saveChanges` method need to be called on this message? This flag is set to false by the public constructor and set to true by the `saveChanges` method.
private boolean	strict

From class com.google.code.javax.mail.Message

Protected Constructors
	IMAPMessage(IMAPFolder folder, int msgnum) Constructor.
	IMAPMessage(Session session) Constructor, for use by IMAPNestedMessage.

Public Methods
void	_setGoogleMessageLabels(String[] x_gm_labels)
void	addFrom(Address[] addresses) Add the specified addresses to the existing "From" field.
void	addHeader(String name, String value) Add this value to the existing values for this header_name.
void	addHeaderLine(String line) Add a raw RFC 822 header-line.
void	addRecipients(Message.RecipientType type, Address[] addresses) Add the given addresses to the specified recipient type.
Enumeration	getAllHeaderLines() Get all header-lines.
Enumeration	getAllHeaders() Get all headers.
String	getContentID() Get the Content-ID.
String[]	getContentLanguage() Get the content language.
String	getContentMD5() Get the Content-MD5.
String	getContentType() Get the Content-Type.
synchronized 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.
String	getFileName() Get the "filename" Disposition parameter.
synchronized Flags	getFlags() Get the Flags for this message.
Address[]	getFrom() Get the "From" attribute.
long	getGoogleMessageId()
String[]	getGoogleMessageLabels()
long	getGoogleMessageThreadId()
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.
int	getLineCount() Get the total number of lines.
Enumeration	getMatchingHeaderLines(String[] names) Get all matching header-lines.
Enumeration	getMatchingHeaders(String[] names) Get matching headers.
String	getMessageID() Get the Message-ID.
Enumeration	getNonMatchingHeaderLines(String[] names) Get all non-matching headerlines.
Enumeration	getNonMatchingHeaders(String[] names) Get non-matching headers.
synchronized boolean	getPeek() Get whether or not to use the PEEK variant of FETCH when fetching message content.
Date	getReceivedDate() Get the recieved 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.
int	getSize() Get the message size.
String	getSubject() Get the decoded subject.
synchronized void	invalidateHeaders() Invalidate cached header and envelope information for this message.
synchronized boolean	isSet(Flags.Flag flag) Test if the given Flags are set in this message.
void	removeHeader(String name) Remove all headers with this name.
void	setContentID(String cid) Set the "Content-ID" header field of this Message.
void	setContentLanguage(String[] languages) Set the "Content-Language" header of this MimePart.
void	setContentMD5(String md5) Set the "Content-MD5" header field of this Message.
void	setDataHandler(DataHandler content) This method provides the mechanism to set this part's content.
void	setDescription(String description, String charset) Set the "Content-Description" header field for this Message.
void	setDisposition(String disposition) Set the "Content-Disposition" header field of this Message.
void	setFileName(String filename) Set the filename associated with this part, if possible.
synchronized void	setFlags(Flags flag, boolean set) Set/Unset the given flags in this message.
void	setFrom(Address address) Set the RFC 822 "From" header field.
void	setGoogleMessageId(long x_gm_msgid)
synchronized void	setGoogleMessageLabels(String[] labels, boolean set)
void	setGoogleMessageThreadId(long x_gm_thrid)
void	setHeader(String name, String value) Set the value for this header_name.
synchronized 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) Set the specified recipient type to the given addresses.
void	setReplyTo(Address[] addresses) Set the RFC 822 "Reply-To" header field.
void	setSender(Address address) Set the RFC 822 "Sender" header field.
void	setSentDate(Date d) Set the RFC 822 "Date" header field.
void	setSubject(String subject, String charset) Set the "Subject" header field.
void	writeTo(OutputStream os) Write out the bytes into the given outputstream.

Protected Methods
void	checkExpunged()
void	forceCheckExpunged() Do a NOOP to force any untagged EXPUNGE responses and then check if this message is expunged.
InputStream	getContentStream() Get all the bytes for this message.
int	getFetchBlockSize()
Object	getMessageCacheLock() Get the messageCacheLock, associated with this Message's GmailFolder.
IMAPProtocol	getProtocol() Get this message's folder's protocol connection.
int	getSequenceNumber() Get this message's IMAP sequence number.
long	getUID()
boolean	isREV1()
void	setExpunged(boolean set) Sets the expunged flag for this Message.
void	setMessageNumber(int msgnum) Wrapper around the protected method Message.setMessageNumber() to make that method accessible to IMAPFolder.
void	setUID(long uid)

[Expand]

Inherited Methods

From class com.google.code.javax.mail.internet.MimeMessage

void	addFrom(Address[] addresses) Add the specified addresses to the existing "From" field.
void	addHeader(String name, String value) Add this value to the existing values for this header_name.
void	addHeaderLine(String line) Add a raw RFC 822 header-line.
void	addRecipients(Message.RecipientType type, Address[] addresses) Add the given addresses to the specified recipient type.
void	addRecipients(Message.RecipientType type, String addresses) Add the given addresses to the specified recipient type.
InternetHeaders	createInternetHeaders(InputStream is) Create and return an InternetHeaders object that loads the headers from the given InputStream.
MimeMessage	createMimeMessage(Session session) Create and return a MimeMessage object.
Enumeration	getAllHeaderLines() Get all header lines as an Enumeration of Strings.
Enumeration	getAllHeaders() Return all the headers from this Message as an enumeration of Header objects.
Address[]	getAllRecipients() Get all the recipient addresses for the message.
Object	getContent() Return the content as a Java object.
String	getContentID() Returns the value of the "Content-ID" header field.
String[]	getContentLanguage() Get the languages specified in the "Content-Language" header field of this message.
String	getContentMD5() Return the value of the "Content-MD5" header field.
InputStream	getContentStream() Produce the raw bytes of the content.
String	getContentType() Returns the value of the RFC 822 "Content-Type" header field.
synchronized DataHandler	getDataHandler() Return a DataHandler for this Message's content.
String	getDescription() Returns the "Content-Description" header field of this Message.
String	getDisposition() Returns the value of the "Content-Disposition" header field.
String	getEncoding() Returns the content transfer encoding from the "Content-Transfer-Encoding" header field.
String	getFileName() Get the filename associated with this Message.
synchronized Flags	getFlags() Return a `Flags` object containing the flags for this message.
Address[]	getFrom() Returns the value of the RFC 822 "From" header fields.
String[]	getHeader(String name) Get all the headers for this header_name.
String	getHeader(String name, String delimiter) Get all the headers for this header name, returned as a single String, with headers separated by the delimiter.
InputStream	getInputStream() Return a decoded input stream for this Message's "content".
int	getLineCount() Return the number of lines for the content of this message.
Enumeration	getMatchingHeaderLines(String[] names) Get matching header lines as an Enumeration of Strings.
Enumeration	getMatchingHeaders(String[] names) Return matching headers from this Message as an Enumeration of Header objects.
String	getMessageID() Returns the value of the "Message-ID" header field.
Enumeration	getNonMatchingHeaderLines(String[] names) Get non-matching header lines as an Enumeration of Strings.
Enumeration	getNonMatchingHeaders(String[] names) Return non-matching headers from this Message as an Enumeration of Header objects.
InputStream	getRawInputStream() Return an InputStream to the raw data with any Content-Transfer-Encoding intact.
Date	getReceivedDate() Returns the Date on this message was received.
Address[]	getRecipients(Message.RecipientType type) Returns the recepients specified by the type.
Address[]	getReplyTo() Return the value of the RFC 822 "Reply-To" header field.
Address	getSender() Returns the value of the RFC 822 "Sender" header field.
Date	getSentDate() Returns the value of the RFC 822 "Date" field.
int	getSize() Return the size of the content of this message in bytes.
String	getSubject() Returns the value of the "Subject" header field.
boolean	isMimeType(String mimeType) Is this Part of the specified MIME type? This method compares only the `primaryType` and `subType`.
synchronized boolean	isSet(Flags.Flag flag) Check whether the flag specified in the `flag` argument is set in this message.
void	parse(InputStream is) Parse the InputStream setting the `headers` and `content` fields appropriately.
void	removeHeader(String name) Remove all headers with this name.
Message	reply(boolean replyToAll) Get a new Message suitable for a reply to this message.
void	saveChanges() Updates the appropriate header fields of this message to be consistent with the message's contents.
void	setContent(Object o, String type) A convenience method for setting this Message's content.
void	setContent(Multipart mp) This method sets the Message's content to a Multipart object.
void	setContentID(String cid) Set the "Content-ID" header field of this Message.
void	setContentLanguage(String[] languages) Set the "Content-Language" header of this MimePart.
void	setContentMD5(String md5) Set the "Content-MD5" header field of this Message.
synchronized void	setDataHandler(DataHandler dh) This method provides the mechanism to set this part's content.
void	setDescription(String description, String charset) Set the "Content-Description" header field for this Message.
void	setDescription(String description) Set the "Content-Description" header field for this Message.
void	setDisposition(String disposition) Set the "Content-Disposition" header field of this Message.
void	setFileName(String filename) Set the filename associated with this part, if possible.
synchronized void	setFlags(Flags flag, boolean set) Set the flags for this message.
void	setFrom() Set the RFC 822 "From" header field using the value of the `InternetAddress.getLocalAddress` method.
void	setFrom(Address address) Set the RFC 822 "From" header field.
void	setHeader(String name, String value) Set the value for this header_name.
void	setRecipients(Message.RecipientType type, Address[] addresses) Set the specified recipient type to the given addresses.
void	setRecipients(Message.RecipientType type, String addresses) Set the specified recipient type to the given addresses.
void	setReplyTo(Address[] addresses) Set the RFC 822 "Reply-To" header field.
void	setSender(Address address) Set the RFC 822 "Sender" header field.
void	setSentDate(Date d) Set the RFC 822 "Date" header field.
void	setSubject(String subject) Set the "Subject" header field.
void	setSubject(String subject, String charset) Set the "Subject" header field.
void	setText(String text) Convenience method that sets the given String as this part's content, with a MIME type of "text/plain".
void	setText(String text, String charset, String subtype) Convenience method that sets the given String as this part's content, with a primary MIME type of "text" and the specified MIME subtype.
void	setText(String text, String charset) Convenience method that sets the given String as this part's content, with a MIME type of "text/plain" and the specified charset.
void	updateHeaders() Called by the `saveChanges` method to actually update the MIME headers.
void	updateMessageID() Update the Message-ID header.
void	writeTo(OutputStream os, String[] ignoreList) Output the message as an RFC 822 format stream, without specified headers.
void	writeTo(OutputStream os) Output the message as an RFC 822 format stream.

From class com.google.code.javax.mail.Message

abstract void	addFrom(Address[] addresses) Add these addresses to the existing "From" attribute
void	addRecipient(Message.RecipientType type, Address address) Add this recipient address to the existing ones of the given type.
abstract void	addRecipients(Message.RecipientType type, Address[] addresses) Add these recipient addresses to the existing ones of the given type.
Address[]	getAllRecipients() Get all the recipient addresses for the message.
abstract Flags	getFlags() Returns a `Flags` object containing the flags for this message.
Folder	getFolder() Get the folder from which this message was obtained.
abstract Address[]	getFrom() Returns the "From" attribute.
int	getMessageNumber() Get the Message number for this Message.
abstract Date	getReceivedDate() Get the date this message was received.
abstract Address[]	getRecipients(Message.RecipientType type) Get all the recipient addresses of the given type.
Address[]	getReplyTo() Get the addresses to which replies should be directed.
abstract Date	getSentDate() Get the date this message was sent.
abstract String	getSubject() Get the subject of this message.
boolean	isExpunged() Checks whether this message is expunged.
boolean	isSet(Flags.Flag flag) Check whether the flag specified in the `flag` argument is set in this message.
boolean	match(SearchTerm term) Apply the specified Search criterion to this message.
abstract Message	reply(boolean replyToAll) Get a new Message suitable for a reply to this message.
abstract void	saveChanges() Save any changes made to this message into the message-store when the containing folder is closed, if the message is contained in a folder.
void	setExpunged(boolean expunged) Sets the expunged flag for this Message.
void	setFlag(Flags.Flag flag, boolean set) Set the specified flag on this message to the specified value.
abstract void	setFlags(Flags flag, boolean set) Set the specified flags on this message to the specified value.
abstract void	setFrom() Set the "From" attribute in this Message.
abstract void	setFrom(Address address) Set the "From" attribute in this Message.
void	setMessageNumber(int msgnum) Set the Message number for this Message.
void	setRecipient(Message.RecipientType type, Address address) Set the recipient address.
abstract void	setRecipients(Message.RecipientType type, Address[] addresses) Set the recipient addresses.
void	setReplyTo(Address[] addresses) Set the addresses to which replies should be directed.
abstract void	setSentDate(Date date) Set the sent date of this message.
abstract void	setSubject(String subject) Set the subject of this message.

From class java.lang.Object

From interface com.google.code.javax.mail.HasRawInputStream

From interface com.google.code.javax.mail.Part

abstract void	addHeader(String header_name, String header_value) Add this value to the existing values for this header_name.
abstract Enumeration	getAllHeaders() Return all the headers from this part as an Enumeration of Header objects.
abstract Object	getContent() Return the content as a Java object.
abstract String	getContentType() Returns the Content-Type of the content of this part.
abstract DataHandler	getDataHandler() Return a DataHandler for the content within this part.
abstract String	getDescription() Return a description String for this part.
abstract String	getDisposition() Return the disposition of this part.
abstract String	getFileName() Get the filename associated with this part, if possible.
abstract String[]	getHeader(String header_name) Get all the headers for this header name.
abstract InputStream	getInputStream() Return an input stream for this part's "content".
abstract int	getLineCount() Return the number of lines in the content of this part.
abstract Enumeration	getMatchingHeaders(String[] header_names) Return matching headers from this part as an Enumeration of Header objects.
abstract Enumeration	getNonMatchingHeaders(String[] header_names) Return non-matching headers from this envelope as an Enumeration of Header objects.
abstract int	getSize() Return the size of the content of this part in bytes.
abstract boolean	isMimeType(String mimeType) Is this Part of the specified MIME type? This method compares only the `primaryType` and `subType`.
abstract void	removeHeader(String header_name) Remove all headers with this name.
abstract void	setContent(Object obj, String type) A convenience method for setting this part's content.
abstract void	setContent(Multipart mp) This method sets the given Multipart object as this message's content.
abstract void	setDataHandler(DataHandler dh) This method provides the mechanism to set this part's content.
abstract void	setDescription(String description) Set a description String for this part.
abstract void	setDisposition(String disposition) Set the disposition of this part.
abstract void	setFileName(String filename) Set the filename associated with this part, if possible.
abstract void	setHeader(String header_name, String header_value) Set the value for this header_name.
abstract void	setText(String text) A convenience method that sets the given String as this part's content with a MIME type of "text/plain".
abstract void	writeTo(OutputStream os) Output a bytestream for this Part.

From interface com.google.code.javax.mail.internet.MimePart

abstract void	addHeaderLine(String line) Add a raw RFC822 header-line.
abstract Enumeration	getAllHeaderLines() Get all header lines as an Enumeration of Strings.
abstract String	getContentID() Get the Content-ID of this part.
abstract String[]	getContentLanguage() Get the language tags specified in the Content-Language header of this MimePart.
abstract String	getContentMD5() Get the Content-MD5 digest of this part.
abstract String	getEncoding() Get the transfer encoding of this part.
abstract String	getHeader(String name, String delimiter) Get the values of all header fields available for this header, returned as a single String, with the values separated by the delimiter.
abstract Enumeration	getMatchingHeaderLines(String[] names) Get matching header lines as an Enumeration of Strings.
abstract Enumeration	getNonMatchingHeaderLines(String[] names) Get non-matching header lines as an Enumeration of Strings.
abstract void	setContentLanguage(String[] languages) Set the Content-Language header of this MimePart.
abstract void	setContentMD5(String md5) Set the Content-MD5 of this part.
abstract void	setText(String text) Convenience method that sets the given String as this part's content, with a MIME type of "text/plain".
abstract void	setText(String text, String charset, String subtype) Convenience method that sets the given String as this part's content, with a primary MIME type of "text" and the specified MIME subtype.
abstract void	setText(String text, String charset) Convenience method that sets the given String as this part's content, with a MIME type of "text/plain" and the specified charset.

Fields

private static String EnvelopeCmd

protected BODYSTRUCTURE bs

private String description

protected ENVELOPE envelope

private boolean headersLoaded

private Hashtable loadedHeaders

private boolean peek

private Date receivedDate

protected String sectionId

private int size

private String subject

private String type

private long uid

private String[] x_gm_labels

private long x_gm_msgid

private long x_gm_thrid

Protected Constructors

protected IMAPMessage (IMAPFolder folder, int msgnum)

Constructor.

Parameters

folder
msgnum

protected IMAPMessage (Session session)

Constructor, for use by IMAPNestedMessage.

Parameters

session

Public Methods

public void _setGoogleMessageLabels (String[] x_gm_labels)

Parameters

x_gm_labels

public void addFrom (Address[] addresses)

Add the specified addresses to the existing "From" field. If the "From" field does not already exist, it is created.

Parameters

addresses	The senders of this message

Throws

MessagingException

public void addHeader (String name, String value)

Add this value to the existing values for this header_name. Note that RFC 822 headers must contain only US-ASCII characters, so a header that contains non US-ASCII characters must have been encoded as per the rules of RFC 2047.

Parameters

name	Header name
value	Header value

Throws

MessagingException

public void addHeaderLine (String line)

Add a raw RFC 822 header-line.

Parameters

line

Throws

MessagingException

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

Add the given addresses to the specified recipient type.

Parameters

type	Recipient type
addresses	Addresses

Throws

MessagingException

public Enumeration getAllHeaderLines ()

Get all header-lines.

Throws

MessagingException

public Enumeration getAllHeaders ()

Get all headers.

Returns

array of header objects

Throws

MessagingException

public String getContentID ()

Get the Content-ID.

Returns

content-ID

Throws

MessagingException

public String[] getContentLanguage ()

Get the content language.

Returns

value of content-language header.

Throws

MessagingException

public String getContentMD5 ()

Get the Content-MD5.

Returns

content-MD5

Throws

MessagingException

public String getContentType ()

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

Returns

The ContentType of this part

Throws

MessagingException

public synchronized DataHandler getDataHandler ()

Get the DataHandler object for this message.

Returns

DataHandler for the content

Throws

MessagingException

public String getDescription ()

Get the decoded Content-Description.

Returns

content-description

Throws

MessagingException

public String getDisposition ()

Get the Content-Disposition.

Returns

disposition of this part, or null if unknown

Throws

MessagingException

public String getEncoding ()

Get the Content-Transfer-Encoding.

Returns

content-transfer-encoding

Throws

MessagingException

public String getFileName ()

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

Returns

filename

Throws

MessagingException

public synchronized Flags getFlags ()

Get the Flags for this message.

Returns

Flags object containing the flags for this message

Throws

MessagingException

public Address[] getFrom ()

Get the "From" attribute.

Returns

Address object

Throws

MessagingException

public long getGoogleMessageId ()

public String[] getGoogleMessageLabels ()

public long getGoogleMessageThreadId ()

public String[] getHeader (String name)

Get the named header.

Parameters

name	Name of header

Returns

array of headers

Throws

MessagingException

public String getHeader (String name, String delimiter)

Get the named header.

Parameters

name	The name of this header
delimiter	Separator between values

Returns

the value fields for all headers with this name

Throws

MessagingException

public String getInReplyTo ()

Get the In-Reply-To header.

Throws

MessagingException

public int getLineCount ()

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

Returns

number of lines in the content.

Throws

MessagingException

public Enumeration getMatchingHeaderLines (String[] names)

Get all matching header-lines.

Parameters

names

Throws

MessagingException

public Enumeration getMatchingHeaders (String[] names)

Get matching headers.

Parameters

names

Returns

enumeration of Header objects

Throws

MessagingException

public String getMessageID ()

Get the Message-ID.

Returns

Message-ID

Throws

MessagingException

public Enumeration getNonMatchingHeaderLines (String[] names)

Get all non-matching headerlines.

Parameters

names

Throws

MessagingException

public Enumeration getNonMatchingHeaders (String[] names)

Get non-matching headers.

Parameters

names

Returns

enumeration of Header objects

Throws

MessagingException

public synchronized boolean getPeek ()

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

public Date getReceivedDate ()

Get the recieved date (INTERNALDATE)

Returns

the date this message was received

Throws

MessagingException

public Address[] getRecipients (Message.RecipientType type)

Get the desired Recipient type.

Parameters

type	Type of recepient

Returns

array of Address objects

Throws

MessagingException

public Address[] getReplyTo ()

Get the ReplyTo addresses.

Returns

addresses to which replies should be directed

Throws

MessagingException

public Address getSender ()

Get the "Sender" attribute.

Returns

Address object

Throws

MessagingException

public Date getSentDate ()

Get the SentDate.

Returns

The sent Date

Throws

MessagingException

public int getSize ()

Get the message size.

Note that this returns RFC822.SIZE. That is, it's the size of the whole message, header and body included.

Returns

size of content in bytes

Throws

MessagingException

public String getSubject ()

Get the decoded subject.

Returns

Subject

Throws

MessagingException

public synchronized 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.

public synchronized boolean isSet (Flags.Flag flag)

Test if the given Flags are set in this message.

Parameters

flag	The flag

Returns

value of the specified flag for this message

Throws

MessagingException

public void removeHeader (String name)

Remove all headers with this name.

Parameters

name	The name of this header

Throws

MessagingException

public void setContentID (String cid)

Set the "Content-ID" header field of this Message. If the cid parameter is null, any existing "Content-ID" is removed.

Parameters

cid

Throws

MessagingException

public void setContentLanguage (String[] languages)

Set the "Content-Language" header of this MimePart. The Content-Language header is defined by RFC 1766.

Parameters

languages	Array of language tags

Throws

MessagingException

public void setContentMD5 (String md5)

Set the "Content-MD5" header field of this Message.

Parameters

md5	The MD5 value

Throws

MessagingException

public void setDataHandler (DataHandler content)

This method provides the mechanism to set this part's content. The given DataHandler object should wrap the actual content.

Parameters

content	The DataHandler for the content.

Throws

MessagingException

public void setDescription (String description, String charset)

Set the "Content-Description" header field for this Message. If the description parameter is null, then any existing "Content-Description" fields are removed.

If the description contains non US-ASCII characters, it will be encoded using the specified charset. If the description contains only US-ASCII characters, no encoding is done and it is used as-is.

Note that if the charset encoding process fails, a MessagingException is thrown, and an UnsupportedEncodingException is included in the chain of nested exceptions within the MessagingException.

Parameters

description	Description
charset	Charset for encoding

Throws

MessagingException

public void setDisposition (String disposition)

Set the "Content-Disposition" header field of this Message. If disposition is null, any existing "Content-Disposition" header field is removed.

Parameters

disposition	Disposition of this part

Throws

MessagingException

public void setFileName (String filename)

Set the filename associated with this part, if possible.

Sets the "filename" parameter of the "Content-Disposition" header field of this message.

If the mail.mime.encodefilename System property is set to true, the MimeUtility.encodeText method will be used to encode the filename. While such encoding is not supported by the MIME spec, many mailers use this technique to support non-ASCII characters in filenames. The default value of this property is false.

Parameters

filename	Filename to associate with this part

Throws

MessagingException

public synchronized void setFlags (Flags flag, boolean set)

Set/Unset the given flags in this message.

Parameters

flag	Flags object containing the flags to be set
set	The value to be set

Throws

MessagingException

public void setFrom (Address address)

Set the RFC 822 "From" header field. Any existing values are replaced with the given address. If address is null, this header is removed.

Parameters

address	The sender of this message

Throws

MessagingException

public void setGoogleMessageId (long x_gm_msgid)

Parameters

x_gm_msgid

public synchronized void setGoogleMessageLabels (String[] labels, boolean set)

Parameters

labels
set

Throws

MessagingException

public void setGoogleMessageThreadId (long x_gm_thrid)

Parameters

x_gm_thrid

public void setHeader (String name, String value)

Set the value for this header_name. Replaces all existing header values with this new value. Note that RFC 822 headers must contain only US-ASCII characters, so a header that contains non US-ASCII characters must have been encoded by the caller as per the rules of RFC 2047.

Parameters

name	Header name
value	Header value

Throws

MessagingException

public synchronized void setPeek (boolean peek)

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

Parameters

peek

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

Set the specified recipient type to the given addresses. If the address parameter is null, the corresponding recipient field is removed.

Parameters

type	Recipient type
addresses	Addresses

Throws

MessagingException

public void setReplyTo (Address[] addresses)

Set the RFC 822 "Reply-To" header field. If the address parameter is null, this header is removed.

Parameters

addresses	Addresses to which replies should be directed

Throws

MessagingException

public void setSender (Address address)

Set the RFC 822 "Sender" header field. Any existing values are replaced with the given address. If address is null, this header is removed.

Parameters

address	The sender of this message

Throws

MessagingException

public void setSentDate (Date d)

Set the RFC 822 "Date" header field. This is the date on which the creator of the message indicates that the message is complete and ready for delivery. If the date parameter is null, the existing "Date" field is removed.

Parameters

d	The sent date of this message

Throws

MessagingException

public void setSubject (String subject, String charset)

Set the "Subject" header field. If the subject contains non US-ASCII characters, it will be encoded using the specified charset. If the subject contains only US-ASCII characters, no encoding is done and it is used as-is. If the subject is null, the existing "Subject" header field is removed.

The application must ensure that the subject does not contain any line breaks.

Note that if the charset encoding process fails, a MessagingException is thrown, and an UnsupportedEncodingException is included in the chain of nested exceptions within the MessagingException.

Parameters

subject	The subject
charset	The charset

Throws

MessagingException

public void writeTo (OutputStream os)

Write out the bytes into the given outputstream.

Parameters

os

Throws

IOException
MessagingException

Protected Methods

protected void checkExpunged ()

Throws

MessageRemovedException

protected void forceCheckExpunged ()

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

Throws

FolderClosedException
MessageRemovedException

protected InputStream getContentStream ()

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.

Throws

MessagingException

protected int getFetchBlockSize ()

protected Object getMessageCacheLock ()

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

protected IMAPProtocol getProtocol ()

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

Throws

FolderClosedException
ProtocolException

protected int getSequenceNumber ()

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

protected long getUID ()

protected boolean isREV1 ()

Throws

FolderClosedException

protected void setExpunged (boolean set)

Sets the expunged flag for this Message. This method is to be used only by the implementation classes.

Parameters

set	The expunged flag

protected void setMessageNumber (int msgnum)

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

Parameters

msgnum

protected void setUID (long uid)

Parameters

uid

Interfaces

Classes

IMAPMessage

Class Overview

Summary

Fields

private static String EnvelopeCmd

protected BODYSTRUCTURE bs

private String description

protected ENVELOPE envelope

private boolean headersLoaded

private Hashtable loadedHeaders

private boolean peek

private Date receivedDate

protected String sectionId

private int size

private String subject

private String type

private long uid

private String[] x_gm_labels

private long x_gm_msgid

private long x_gm_thrid

Protected Constructors

protected IMAPMessage (IMAPFolder folder, int msgnum)

Parameters

protected IMAPMessage (Session session)

Parameters

Public Methods

public void _setGoogleMessageLabels (String[] x_gm_labels)

Parameters

public void addFrom (Address[] addresses)

Parameters

Throws

public void addHeader (String name, String value)

Parameters

Throws

public void addHeaderLine (String line)

Parameters

Throws

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

Parameters

Throws

public Enumeration getAllHeaderLines ()

Throws

public Enumeration getAllHeaders ()

Returns

Throws

public String getContentID ()

Returns

Throws

public String[] getContentLanguage ()

Returns

Throws

public String getContentMD5 ()

Returns

Throws

public String getContentType ()

Returns

Throws

public synchronized DataHandler getDataHandler ()

Returns

Throws

public String getDescription ()

Returns

Throws

public String getDisposition ()

Returns

Throws

public String getEncoding ()

Returns

Throws

public String getFileName ()

Returns

Throws

public synchronized Flags getFlags ()

Returns

Throws

public Address[] getFrom ()

Returns

Throws