public class

POP3Message

extends MimeMessage

java.lang.Object
↳	com.google.code.javax.mail.Message
	↳	com.google.code.javax.mail.internet.MimeMessage
		↳	com.google.code.com.sun.mail.pop3.POP3Message

Class Overview

A POP3 Message. Just like a MimeMessage except that some things are not supported.

Summary

Constants
String	UNKNOWN

[Expand]

Inherited Constants

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

Fields
private SoftReference	contentData
private POP3Folder	folder
private int	hdrSize
private int	msgSize
String	uid

[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

Public Constructors
	POP3Message(Folder folder, int msgno)

Public Methods
void	addHeader(String name, String value) Add this value to the existing values for this header_name.
void	addHeaderLine(String line) Add a raw RFC822 header-line.
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.
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.
String[]	getHeader(String name) Get all the headers for this header_name.
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.
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.
int	getSize() Return the size of the content of this message in bytes.
synchronized void	invalidate(boolean invalidateHeaders) Invalidate the cache of content for this message object, causing it to be fetched again from the server the next time it is needed.
void	removeHeader(String name) Remove all headers with this name.
void	saveChanges() POP3 message can't be changed.
void	setFlags(Flags newFlags, boolean set) Set the specified flags on this message to the specified value.
void	setHeader(String name, String value) Set the value for this header_name.
InputStream	top(int n) Fetch the header of the message and the first `n` lines of the raw content of the message.
synchronized void	writeTo(OutputStream os, String[] ignoreList) Output the message as an RFC 822 format stream, without specified headers.

Protected Methods
InputStream	getContentStream() Produce the raw bytes of the content.

[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.

Constants

static final String UNKNOWN

Constant Value: "UNKNOWN"

Fields

private SoftReference contentData

private POP3Folder folder

private int hdrSize

private int msgSize

String uid

Public Constructors

public POP3Message (Folder folder, int msgno)

Parameters

folder
msgno

Throws

MessagingException

Public Methods

public void addHeader (String name, String value)

Add this value to the existing values for this header_name. Throws IllegalWriteException because POP3 messages are read-only.

Parameters

name	Header name
value	Header value

Throws

IllegalWriteException	because the underlying implementation does not support modification
IllegalStateException	if this message is obtained from a READ_ONLY folder.
MessagingException

public void addHeaderLine (String line)

Add a raw RFC822 header-line. Throws IllegalWriteException because POP3 messages are read-only.

Parameters

line

Throws

IllegalWriteException	because the underlying implementation does not support modification
IllegalStateException	if this message is obtained from a READ_ONLY folder.
MessagingException

public Enumeration getAllHeaderLines ()

Get all header lines as an Enumeration of Strings. A Header line is a raw RFC822 header-line, containing both the "name" and "value" field.

Throws

MessagingException

public Enumeration getAllHeaders ()

Return all the headers from this Message as an enumeration of Header objects.

Note that certain headers may be encoded as per RFC 2047 if they contain non US-ASCII characters and these should be decoded.

Returns

array of header objects

Throws

MessagingException

public 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. If the delimiter is null, only the first header is returned.

Parameters

name	The name of this header
delimiter	Delimiter between returned headers

Returns

the value fields for all headers with this name

Throws

MessagingException

public String[] getHeader (String name)

Get all the headers for this header_name. Note that certain headers may be encoded as per RFC 2047 if they contain non US-ASCII characters and these should be decoded.

Parameters

name	Name of header

Returns

array of headers

Throws

MessagingException

public Enumeration getMatchingHeaderLines (String[] names)

Get matching header lines as an Enumeration of Strings. A Header line is a raw RFC822 header-line, containing both the "name" and "value" field.

Parameters

names

Throws

MessagingException

public Enumeration getMatchingHeaders (String[] names)

Return matching headers from this Message as an Enumeration of Header objects.

Parameters

names

Returns

enumeration of Header objects

Throws

MessagingException

public Enumeration getNonMatchingHeaderLines (String[] names)

Get non-matching header lines as an Enumeration of Strings. A Header line is a raw RFC822 header-line, containing both the "name" and "value" field.

Parameters

names

Throws

MessagingException

public Enumeration getNonMatchingHeaders (String[] names)

Return non-matching headers from this Message as an Enumeration of Header objects.

Parameters

names

Returns

enumeration of Header objects

Throws

MessagingException

public int getSize ()

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

Note that this number may not be an exact measure of the content size and may or may not account for any transfer encoding of the content.

Returns

size of content in bytes

Throws

MessagingException

public synchronized void invalidate (boolean invalidateHeaders)

Invalidate the cache of content for this message object, causing it to be fetched again from the server the next time it is needed. If invalidateHeaders is true, invalidate the headers as well.

Parameters

invalidateHeaders	Invalidate the headers as well?

public void removeHeader (String name)

Remove all headers with this name. Throws IllegalWriteException because POP3 messages are read-only.

Parameters

name	The name of this header

Throws

IllegalWriteException	because the underlying implementation does not support modification
IllegalStateException	if this message is obtained from a READ_ONLY folder.
MessagingException

public void saveChanges ()

POP3 message can't be changed. This method throws IllegalWriteException.

Throws

IllegalWriteException	because the underlying implementation does not support modification
MessagingException

public void setFlags (Flags newFlags, boolean set)

Set the specified flags on this message to the specified value.

Parameters

newFlags	The flags to be set
set	The value to be set

Throws

MessagingException

public void setHeader (String name, String value)

Set the value for this header_name. Throws IllegalWriteException because POP3 messages are read-only.

Parameters

name	Header name
value	Header value

Throws

IllegalWriteException	because the underlying implementation does not support modification
IllegalStateException	if this message is obtained from a READ_ONLY folder.
MessagingException

public InputStream top (int n)

Fetch the header of the message and the first n lines of the raw content of the message. The headers and data are available in the returned InputStream.

Parameters

n	Number of lines of content to fetch

Returns

InputStream containing the message headers and n content lines

Throws

MessagingException

public synchronized void writeTo (OutputStream os, String[] ignoreList)

Output the message as an RFC 822 format stream, without specified headers. If the property "mail.pop3.cachewriteto" is set to "true", and ignoreList is null, and the message hasn't already been cached as a side effect of other operations, the message content is cached before being written. Otherwise, the message is streamed directly to the output stream without being cached.

Parameters

os
ignoreList

Throws

IOException	if an error occurs writing to the stream or if an error is generated by the javax.activation layer.
MessagingException

Protected Methods

protected InputStream getContentStream ()

Produce the raw bytes of the content. The data is fetched using the POP3 RETR command.

Throws

MessagingException

Classes

POP3Message

Class Overview

Summary

Constants

static final String UNKNOWN

Fields

private SoftReference contentData

private POP3Folder folder

private int hdrSize

private int msgSize

String uid

Public Constructors

public POP3Message (Folder folder, int msgno)

Parameters

Throws

Public Methods

public void addHeader (String name, String value)

Parameters

Throws

See Also

public void addHeaderLine (String line)

Parameters

Throws

public Enumeration getAllHeaderLines ()

Throws

public Enumeration getAllHeaders ()

Returns

Throws

See Also

public String getHeader (String name, String delimiter)

Parameters

Returns

Throws

public String[] getHeader (String name)

Parameters

Returns

Throws

See Also

public Enumeration getMatchingHeaderLines (String[] names)

Parameters

Throws

public Enumeration getMatchingHeaders (String[] names)

Parameters

Returns

Throws

public Enumeration getNonMatchingHeaderLines (String[] names)

Parameters

Throws

public Enumeration getNonMatchingHeaders (String[] names)

Parameters

Returns

Throws

public int getSize ()

Returns

Throws

public synchronized void invalidate (boolean invalidateHeaders)

Parameters

public void removeHeader (String name)

Parameters

Throws

public void saveChanges ()

Throws

public void setFlags (Flags newFlags, boolean set)

Parameters

Throws

public void setHeader (String name, String value)

Parameters

Throws

See Also

public InputStream top (int n)

Parameters

Returns

Throws

public synchronized void writeTo (OutputStream os, String[] ignoreList)

Parameters

Throws

See Also

Protected Methods

protected InputStream getContentStream ()