com.sun.mail.pop3

Class POP3Message

java.lang.Object

MimeMessage

com.sun.mail.pop3.POP3Message

All Implemented Interfaces:

ReadableMime

public class POP3Message
extends MimeMessage
implements ReadableMime

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

Constructor Summary

Constructors

Constructor and Description
POP3Message(Folder folder, int msgno)

Method Summary

Modifier and Type	Method and Description
void	addHeader(java.lang.String name, java.lang.String value) Add this value to the existing values for this header_name.
void	addHeaderLine(java.lang.String line) Add a raw RFC822 header-line.
java.util.Enumeration	getAllHeaderLines() Get all header lines as an Enumeration of Strings.
java.util.Enumeration	getAllHeaders() Return all the headers from this Message as an enumeration of Header objects.
java.lang.String[]	getHeader(java.lang.String name) Get all the headers for this header_name.
java.lang.String	getHeader(java.lang.String name, java.lang.String delimiter) Get all the headers for this header name, returned as a single String, with headers separated by the delimiter.
java.util.Enumeration	getMatchingHeaderLines(java.lang.String[] names) Get matching header lines as an Enumeration of Strings.
java.util.Enumeration	getMatchingHeaders(java.lang.String[] names) Return matching headers from this Message as an Enumeration of Header objects.
java.io.InputStream	getMimeStream() Return the MIME format stream corresponding to this message part.
java.util.Enumeration	getNonMatchingHeaderLines(java.lang.String[] names) Get non-matching header lines as an Enumeration of Strings.
java.util.Enumeration	getNonMatchingHeaders(java.lang.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.
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(java.lang.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(java.lang.String name, java.lang.String value) Set the value for this header_name.
java.io.InputStream	top(int n) Fetch the header of the message and the first n lines of the raw content of the message.
void	writeTo(java.io.OutputStream os, java.lang.String[] ignoreList) Output the message as an RFC 822 format stream, without specified headers.

Methods inherited from class java.lang.Object

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

Constructor Detail

POP3Message

public POP3Message(Folder folder,
                   int msgno)
            throws MessagingException

Throws:

MessagingException

Method Detail

setFlags

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

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

getSize

public int getSize()
            throws MessagingException

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

getMimeStream

public java.io.InputStream getMimeStream()
                                  throws MessagingException

Return the MIME format stream corresponding to this message part.

Specified by:

getMimeStream in interface ReadableMime

Returns:

the MIME format stream

Throws:

MessagingException

Since:

JavaMail 1.4.5

invalidate

public 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?

top

public java.io.InputStream top(int n)
                        throws MessagingException

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

getHeader

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

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

See Also:

javax.mail.internet.MimeUtility

getHeader

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

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

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)
               throws MessagingException

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

java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.

MessagingException

See Also:

javax.mail.internet.MimeUtility

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)
               throws MessagingException

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

java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.

MessagingException

See Also:

javax.mail.internet.MimeUtility

removeHeader

public void removeHeader(java.lang.String name)
                  throws MessagingException

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

Throws:

IllegalWriteException - because the underlying implementation does not support modification

java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.

MessagingException

getAllHeaders

public java.util.Enumeration getAllHeaders()
                                    throws MessagingException

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

See Also:

javax.mail.internet.MimeUtility

getMatchingHeaders

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

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

Throws:

MessagingException

getNonMatchingHeaders

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

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

Throws:

MessagingException

addHeaderLine

public void addHeaderLine(java.lang.String line)
                   throws MessagingException

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

Throws:

IllegalWriteException - because the underlying implementation does not support modification

java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.

MessagingException

getAllHeaderLines

public java.util.Enumeration getAllHeaderLines()
                                        throws MessagingException

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

getMatchingHeaderLines

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

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.

Throws:

MessagingException

getNonMatchingHeaderLines

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

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.

Throws:

MessagingException

saveChanges

public void saveChanges()
                 throws MessagingException

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

Throws:

IllegalWriteException - because the underlying implementation does not support modification

MessagingException

writeTo

public void writeTo(java.io.OutputStream os,
                    java.lang.String[] ignoreList)
             throws java.io.IOException,
                    MessagingException

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.

Throws:

javax.mail.MessagingException

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

MessagingException

See Also:

DataHandler.writeTo(java.io.OutputStream)