gnu.mail.providers.maildir

Class MaildirMessage

java.lang.Object

javax.mail.Message

javax.mail.internet.MimeMessage

gnu.mail.providers.ReadOnlyMessage

gnu.mail.providers.maildir.MaildirMessage

All Implemented Interfaces:

MimePart, Part

public final class MaildirMessage
extends gnu.mail.providers.ReadOnlyMessage

The message class implementing the Maildir mail protocol.

Author:

Chris Burdess

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

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
Enumeration	getAllHeaderLines() Returns all the header-lines.
Enumeration	getAllHeaders() Returns all the headers.
protected InputStream	getContentStream() Returns the unencoded bytes of the content.
DataHandler	getDataHandler() Returns a data handler for accessing this message's content.
String[]	getHeader(String name) Returns all the values for the specified header name.
String	getHeader(String name, String delimiter) Returns all the values for the specified header name as a single string, with headers separated by the given delimiter.
Enumeration	getMatchingHeaderLines(String[] names) Returns all the header-lines with any of the given names.
Enumeration	getMatchingHeaders(String[] names) Returns all the headers with any of the given names.
Enumeration	getNonMatchingHeaderLines(String[] names) Returns all the header-lines without any of the given names.
Enumeration	getNonMatchingHeaders(String[] names) Returns all the headers without any of the given names.
protected void	setExpunged(boolean expunged) Allow MaildirFolder access to set the expunged flag after expunge.
void	setFlags(Flags flag, boolean set) Set the specified flags(reflected in the info field).

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, createMimeMessage, getAllRecipients, getContent, getContentID, getContentLanguage, getContentMD5, getContentType, getDescription, getDisposition, getEncoding, getFileName, getFlags, getFrom, getInputStream, getLineCount, getMessageID, getRawInputStream, getReceivedDate, getRecipients, getReplyTo, getSender, getSentDate, getSize, getSubject, isMimeType, isSet, parse, reply, setContentID, setContentLanguage, setContentMD5, setDataHandler, setDescription, setDescription, setDisposition, setFileName, setFrom, setFrom, setRecipients, setRecipients, setReplyTo, setSender, setSentDate, setSubject, setSubject, setText, setText, setText, updateHeaders, updateMessageId, writeTo, writeTo

Methods inherited from class javax.mail.Message

addRecipient, getFolder, getMessageNumber, isExpunged, match, setFlag, setMessageNumber, setRecipient

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setExpunged

protected void setExpunged(boolean expunged)

Allow MaildirFolder access to set the expunged flag after expunge.

Overrides:

setExpunged in class Message

setFlags

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

Set the specified flags(reflected in the info field).

Overrides:

setFlags in class gnu.mail.providers.ReadOnlyMessage

Parameters:

flag - 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

getHeader

public String[] getHeader(String name)
                   throws MessagingException

Description copied from class: MimeMessage

Returns all the values for the specified header name. Note that headers may be encoded as per RFC 2047 if they contain non-US-ASCII characters: these should be decoded.

Specified by:

getHeader in interface Part

Overrides:

getHeader in class MimeMessage

Parameters:

name - the header name

Throws:

MessagingException

getHeader

public String getHeader(String name,
               String delimiter)
                 throws MessagingException

Description copied from class: MimeMessage

Returns all the values for the specified header name as a single string, with headers separated by the given delimiter. If the delimiter is null, only the first header is returned.

Specified by:

getHeader in interface MimePart

Overrides:

getHeader in class MimeMessage

Parameters:

name - the header name

delimiter - the delimiter

Throws:

MessagingException

getAllHeaders

public Enumeration getAllHeaders()
                          throws MessagingException

Description copied from class: MimeMessage

Returns all the headers.

Specified by:

getAllHeaders in interface Part

Overrides:

getAllHeaders in class MimeMessage

Returns:

an Enumeration of Header objects

Throws:

MessagingException

getAllHeaderLines

public Enumeration getAllHeaderLines()
                              throws MessagingException

Description copied from class: MimeMessage

Returns all the header-lines.

Specified by:

getAllHeaderLines in interface MimePart

Overrides:

getAllHeaderLines in class MimeMessage

Returns:

an Enumeration of Strings

Throws:

MessagingException

getMatchingHeaders

public Enumeration getMatchingHeaders(String[] names)
                               throws MessagingException

Description copied from class: MimeMessage

Returns all the headers with any of the given names.

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 Enumeration getMatchingHeaderLines(String[] names)
                                   throws MessagingException

Description copied from class: MimeMessage

Returns all the header-lines with any of the given names.

Specified by:

getMatchingHeaderLines in interface MimePart

Overrides:

getMatchingHeaderLines in class MimeMessage

Returns:

an Enumeration of Strings

Throws:

MessagingException

getNonMatchingHeaders

public Enumeration getNonMatchingHeaders(String[] names)
                                  throws MessagingException

Description copied from class: MimeMessage

Returns all the headers without any of the given names.

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 Enumeration getNonMatchingHeaderLines(String[] names)
                                      throws MessagingException

Description copied from class: MimeMessage

Returns all the header-lines without any of the given names.

Specified by:

getNonMatchingHeaderLines in interface MimePart

Overrides:

getNonMatchingHeaderLines in class MimeMessage

Returns:

an Enumeration of Strings

Throws:

MessagingException

getDataHandler

public DataHandler getDataHandler()
                           throws MessagingException

Description copied from class: MimeMessage

Returns a data handler for accessing this message's content.

Specified by:

getDataHandler in interface Part

Overrides:

getDataHandler in class MimeMessage

Throws:

MessagingException

getContentStream

protected InputStream getContentStream()
                                throws MessagingException

Description copied from class: MimeMessage

Returns the unencoded bytes of the content.

Overrides:

getContentStream in class MimeMessage

Throws:

MessagingException

See Also:

MimeBodyPart.getContentStream()

equals

public boolean equals(Object other)

Overrides:

equals in class Object