gnu.mail.providers.pop3
Class POP3Message

java.lang.Object
  extended by javax.mail.Message
      extended by javax.mail.internet.MimeMessage
          extended by gnu.mail.providers.ReadOnlyMessage
              extended by gnu.mail.providers.pop3.POP3Message
All 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
 
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
 java.util.Enumeration getAllHeaderLines()
          Causes the headers to be read.
 java.util.Enumeration getAllHeaders()
          Causes the headers to be read.
protected  java.io.InputStream getContentStream()
          Causes the content to be read in.
 DataHandler getDataHandler()
          Causes the content to be read in.
 java.lang.String[] getHeader(java.lang.String name)
          Causes the headers to be read.
 java.lang.String getHeader(java.lang.String name, java.lang.String delimiter)
          Causes the headers to be read.
 java.util.Enumeration getMatchingHeaderLines(java.lang.String[] names)
          Causes the headers to be read.
 java.util.Enumeration getMatchingHeaders(java.lang.String[] names)
          Causes the headers to be read.
 java.util.Enumeration getNonMatchingHeaderLines(java.lang.String[] names)
          Causes the headers to be read.
 java.util.Enumeration getNonMatchingHeaders(java.lang.String[] names)
          Causes the headers to be read.
 int getSize()
          Gets the size of the message.
 java.lang.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(java.io.OutputStream msgStream)
          Writes this message to the specified stream in RFC 822 format.
 void writeTo(java.io.OutputStream msgStream, java.lang.String[] ignoreList)
          Writes this message to the specified stream in RFC 822 format, without the specified headers.
 
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, getAllRecipients, getContent, getContentID, getContentLanguage, getContentMD5, getContentType, getDescription, getDisposition, getEncoding, getFileName, getFlags, getFrom, getInputStream, getLineCount, getMessageID, getRawInputStream, getReceivedDate, getRecipients, getReplyTo, getSender, getSentDate, getSubject, isMimeType, isSet, parse, reply, setContentID, setContentLanguage, setContentMD5, setDataHandler, setDescription, setDescription, setDisposition, setFileName, setFrom, setFrom, setRecipients, setRecipients, setReplyTo, setSender, setSentDate, setSubject, setSubject, setText, setText, updateHeaders
 
Methods inherited from class javax.mail.Message
addRecipient, getFolder, getMessageNumber, 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

getDataHandler

public DataHandler getDataHandler()
                           throws MessagingException
Causes the content to be read in.

Specified by:
getDataHandler in interface Part
Overrides:
getDataHandler in class MimeMessage
Throws:
MessagingException

getContentStream

protected java.io.InputStream getContentStream()
                                        throws MessagingException
Causes the content to be read in.

Overrides:
getContentStream in class MimeMessage
Throws:
MessagingException
See Also:
MimeBodyPart.getContentStream()

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 class MimeMessage
Throws:
MessagingException

getHeader

public java.lang.String[] getHeader(java.lang.String name)
                             throws MessagingException
Causes the headers to be read.

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
Causes the headers to be read.

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
Causes the headers to be read.

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
Causes the headers to be read.

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
Causes the headers to be read.

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
Causes the headers to be read.

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
Causes the headers to be read.

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
Causes the headers to be read.

Specified by:
getNonMatchingHeaderLines in interface MimePart
Overrides:
getNonMatchingHeaderLines in class MimeMessage
Returns:
an Enumeration of Strings
Throws:
MessagingException

writeTo

public void writeTo(java.io.OutputStream msgStream)
             throws java.io.IOException,
                    MessagingException
Description copied from class: MimeMessage
Writes this message to the specified stream in RFC 822 format.

Specified by:
writeTo in interface Part
Overrides:
writeTo in class MimeMessage
Throws:
java.io.IOException - if an error occurs writing to the stream or in the data handler layer
MessagingException - if an error occurs fetching the data to be written

writeTo

public void writeTo(java.io.OutputStream msgStream,
                    java.lang.String[] ignoreList)
             throws java.io.IOException,
                    MessagingException
Description copied from class: MimeMessage
Writes this message to the specified stream in RFC 822 format, without the specified headers.

Overrides:
writeTo in class MimeMessage
Throws:
java.io.IOException - if an error occurs writing to the stream or in the data handler layer
MessagingException

getUID

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

Throws:
MessagingException

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 class gnu.mail.providers.ReadOnlyMessage
Parameters:
flags - 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