Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

gnu.mail.providers.pop3

Class POP3Message

Implemented Interfaces:
MimePart, Part
public final class POP3Message
extends gnu.mail.providers.ReadOnlyMessage
The message class implementing the POP3 mail protocol.

Nested Class Summary

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

MimeMessage.RecipientType

Nested classes/interfaces inherited from class javax.mail.Message

Message.RecipientType

Field Summary

Fields inherited from class javax.mail.internet.MimeMessage

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

Enumeration
getAllHeaderLines()
Causes the headers to be read.
Enumeration
getAllHeaders()
Causes the headers to be read.
protected InputStream
getContentStream()
Causes the content to be read in.
DataHandler
getDataHandler()
Causes the content to be read in.
String[]
getHeader(String name)
Causes the headers to be read.
String
getHeader(String name, String delimiter)
Causes the headers to be read.
Enumeration
getMatchingHeaderLines(String[] names)
Causes the headers to be read.
Enumeration
getMatchingHeaders(String[] names)
Causes the headers to be read.
Enumeration
getNonMatchingHeaderLines(String[] names)
Causes the headers to be read.
Enumeration
getNonMatchingHeaders(String[] names)
Causes the headers to be read.
int
getSize()
Gets the size of the message.
String
getUID()
Returns the unique ID for this message.
void
setFlags(Flags flags, boolean set)
Set flags (but only DELETED is supported) add or remove the message from the folder deleted message list.
void
writeTo(OutputStream msgStream)
Output the message as an RFC 822 format stream.
void
writeTo(OutputStream msgStream, String[] ignoreList)
Output the message as an RFC 822 format stream, without specified headers.

Methods inherited from class gnu.mail.providers.ReadOnlyMessage

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

Methods inherited from class javax.mail.internet.MimeMessage

addFrom, addHeader, addHeaderLine, addRecipients, addRecipients, createInternetHeaders, getAllHeaderLines, getAllHeaders, getAllRecipients, getContent, getContentID, getContentLanguage, getContentMD5, getContentStream, getContentType, getDataHandler, getDescription, getDisposition, getEncoding, getFileName, getFlags, getFrom, getHeader, getHeader, getInputStream, getLineCount, getMatchingHeaderLines, getMatchingHeaders, getMessageID, getNonMatchingHeaderLines, getNonMatchingHeaders, getRawInputStream, getReceivedDate, getRecipients, getReplyTo, getSender, getSentDate, getSize, getSubject, isMimeType, isSet, parse, removeHeader, reply, saveChanges, setContent, setContent, setContentID, setContentLanguage, setContentMD5, setDataHandler, setDescription, setDescription, setDisposition, setFileName, setFlags, setFrom, setFrom, setHeader, setRecipients, setRecipients, setReplyTo, setSender, setSentDate, setSubject, setSubject, setText, setText, updateHeaders, writeTo, writeTo

Methods inherited from class javax.mail.Message

addFrom, addRecipient, addRecipients, getAllRecipients, getFlags, getFolder, getFrom, getMessageNumber, getReceivedDate, getRecipients, getReplyTo, getSentDate, getSubject, isExpunged, isSet, match, reply, saveChanges, setExpunged, setFlag, setFlags, setFrom, setFrom, setMessageNumber, setRecipient, setRecipients, setReplyTo, setSentDate, setSubject

Method Details

getAllHeaderLines

public Enumeration getAllHeaderLines()
            throws MessagingException
Causes the headers to be read.
Specified by:
getAllHeaderLines in interface MimePart
Overrides:
getAllHeaderLines in interface MimeMessage

getAllHeaders

public Enumeration getAllHeaders()
            throws MessagingException
Causes the headers to be read.
Specified by:
getAllHeaders in interface Part
Overrides:
getAllHeaders in interface MimeMessage

getContentStream

protected InputStream getContentStream()
            throws MessagingException
Causes the content to be read in.
Overrides:
getContentStream in interface MimeMessage

getDataHandler

public DataHandler getDataHandler()
            throws MessagingException
Causes the content to be read in.
Specified by:
getDataHandler in interface Part
Overrides:
getDataHandler in interface MimeMessage

getHeader

public String[] getHeader(String name)
            throws MessagingException
Causes the headers to be read.
Specified by:
getHeader in interface Part
Overrides:
getHeader in interface MimeMessage

getHeader

public String getHeader(String name,
                        String delimiter)
            throws MessagingException
Causes the headers to be read.
Specified by:
getHeader in interface MimePart
Overrides:
getHeader in interface MimeMessage

getMatchingHeaderLines

public Enumeration getMatchingHeaderLines(String[] names)
            throws MessagingException
Causes the headers to be read.
Specified by:
getMatchingHeaderLines in interface MimePart
Overrides:
getMatchingHeaderLines in interface MimeMessage

getMatchingHeaders

public Enumeration getMatchingHeaders(String[] names)
            throws MessagingException
Causes the headers to be read.
Specified by:
getMatchingHeaders in interface Part
Overrides:
getMatchingHeaders in interface MimeMessage

getNonMatchingHeaderLines

public Enumeration getNonMatchingHeaderLines(String[] names)
            throws MessagingException
Causes the headers to be read.
Specified by:
getNonMatchingHeaderLines in interface MimePart
Overrides:
getNonMatchingHeaderLines in interface MimeMessage

getNonMatchingHeaders

public Enumeration getNonMatchingHeaders(String[] names)
            throws MessagingException
Causes the headers to be read.
Specified by:
getNonMatchingHeaders in interface Part
Overrides:
getNonMatchingHeaders in interface MimeMessage

getSize

public int getSize()
            throws MessagingException
Gets the size of the message. Uses the cached size if it's available to us.
Specified by:
getSize in interface Part
Overrides:
getSize in interface MimeMessage

getUID

public String getUID()
            throws MessagingException
Returns the unique ID for this message.

setFlags

public void setFlags(Flags flags,
                     boolean set)
            throws MessagingException
Set flags (but only DELETED is supported) add or remove the message from the folder deleted message list.
Overrides:
setFlags in interface gnu.mail.providers.ReadOnlyMessage

writeTo

public void writeTo(OutputStream msgStream)
            throws IOException,
                   MessagingException
Output the message as an RFC 822 format stream.

Note that, depending on how the message was constructed, it may use a variety of line termination conventions. Generally the output should be sent through an appropriate FilterOutputStream that converts the line terminators to the desired form, either CRLF for MIME compatibility and for use in Internet protocols, or the local platform's line terminator for storage in a local text file.

This implementation calls the writeTo(OutputStream, String[]) method with a null ignore list.

Specified by:
writeTo in interface Part
Overrides:
writeTo in interface MimeMessage

writeTo

public void writeTo(OutputStream msgStream,
                    String[] ignoreList)
            throws IOException,
                   MessagingException
Output the message as an RFC 822 format stream, without specified headers. If the saved flag is not set, the saveChanges method is called. If the modified flag is not set and the content array is not null, the content array is written directly, after writing the appropriate message headers.
Overrides:
writeTo in interface MimeMessage

Overview Package Tree Index Deprecated About