Movatterモバイル変換

Class MimeMessage

java.lang.Object  |  +--javax.mail.Message        |        +--javax.mail.internet.MimeMessage

All Implemented Interfaces:

MimePart,Part

public classMimeMessage

extendsMessage

implementsMimePart

This class represents a MIME style email message. It implements theMessage abstract class and theMimePart interface.

Clients wanting to create new MIME style messages will instantiate an empty MimeMessage object and then fill it with appropriate attributes and content.

Service providers that implement MIME compliant backend stores may want to subclass MimeMessage and override certain methods to provide specific implementations. The simplest case is probably a provider that generates a MIME style input stream and leaves the parsing of the stream to this class.

MimeMessage uses theInternetHeaders class to parse and store the toplevel RFC 822 headers of a message.

RFC 822 header fieldsmust contain only US-ASCII characters. MIME allows non ASCII characters to be present in certain portions of certain headers, by encoding those characters. RFC 2047 specifies the rules for doing this. The MimeUtility class provided in this package can be used to to achieve this.

See Also:

MimeUtility,Part,Message,MimePart

dh

protectedDataHandlerdh

The DataHandler object representing this Message's content.

content

protected byte[]content

Byte array that holds the bytes of this Message's content.

headers

protectedInternetHeadersheaders

The InternetHeaders object that stores the header of this message.

flags

protectedFlagsflags

The Flags for this message.

MimeMessage

publicMimeMessage(Session session)

Default constructor. An empty message object is created. Theheaders field is set to an empty InternetHeaders object. Theflags field is set to an empty Flags object.

MimeMessage

publicMimeMessage(Session session,                   java.io.InputStream is)            throwsMessagingException

Constructs a MimeMessage by reading and parsing the data from the specified MIME InputStream. The InputStream will be left positioned at the end of the data for the message. Note that the input stream parse is done within this constructor itself.

Parameters:

session - Session object for this message

is - the message input stream

Throws:

MessagingException -  

MimeMessage

protectedMimeMessage(Folder folder,                      int msgnum)

Constructs an empty MimeMessage object with the given Folder and message number.

This method is for providers subclassingMimeMessage.

MimeMessage

protectedMimeMessage(Folder folder,                      java.io.InputStream is,                      int msgnum)               throwsMessagingException

Constructs a MimeMessage by reading and parsing the data from the specified MIME InputStream. The InputStream will be left positioned at the end of the data for the message. Note that the input stream parse is done within this constructor itself.

This method is for providers subclassingMimeMessage.

Parameters:

folder - The containing folder.

is - the message input stream

msgnum - Message number of this message within its folder

Throws:

MessagingException -  

MimeMessage

protectedMimeMessage(Folder folder,InternetHeaders headers,                      byte[] content,                      int msgnum)               throwsMessagingException

Constructs a MimeMessage from the given InternetHeaders object and content. This method is for providers subclassingMimeMessage.

Parameters:

folder - The containing folder.

is - the message input stream

msgnum - Message number of this message within its folder

Throws:

MessagingException -  

getFrom

publicAddress[]getFrom()                  throwsMessagingException

Returns the value of the RFC 822 "From" header fields. If this header field is absent, the "Sender" header field is used. If the "Sender" header field is also absent,null is returned.

This implementation uses thegetHeader method to obtain the requisite header field.

Overrides:

getFrom in classMessage

Returns:

Address object

Throws:

MessagingException -  

See Also:

headers

setFrom

public voidsetFrom(Address address)             throwsMessagingException

Set the RFC 822 "From" header field. Any existing values are replaced with the given address. If address isnull, this header is removed.

Overrides:

setFrom in classMessage

Parameters:

address - the sender of this message

Throws:

IllegalWriteException - if the underlyingimplementation does not support modificationof existing values

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

MessagingException -  

setFrom

public voidsetFrom()             throwsMessagingException

Set the RFC 822 "From" header field using the value of theInternetAddress.getLocalAddress method.

Overrides:

setFrom in classMessage

Throws:

IllegalWriteException - if the underlyingimplementation does not support modificationof existing values

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

MessagingException -  

addFrom

public voidaddFrom(Address[] addresses)             throwsMessagingException

Add the specified addresses to the existing "From" field. If the "From" field does not already exist, it is created.

Overrides:

addFrom in classMessage

Parameters:

addresses - the senders of this message

Throws:

IllegalWriteException - if the underlyingimplementation does not support modificationof existing values

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

MessagingException -  

getRecipients

publicAddress[]getRecipients(Message.RecipientType type)                        throwsMessagingException

Returns the recepients specified by the type. The mapping between the type and the corresponding RFC 822 header is as follows:

Message.RecipientType.TO"To"Message.RecipientType.CC"Cc"Message.RecipientType.BCC"Bcc"MimeMessage.RecipientType.NEWSGROUPS"Newsgroups"

Returns null if the header specified by the type is not found or if its value is empty.

This implementation uses thegetHeader method to obtain the requisite header field.

Overrides:

getRecipients in classMessage

Parameters:

Type - of recepient

Returns:

array of Address objects

Throws:

MessagingException - if header could not be retrieved

AddressException - if the header is misformatted

See Also:

headers,Message.RecipientType.TO,Message.RecipientType.CC,Message.RecipientType.BCC,MimeMessage.RecipientType.NEWSGROUPS

getAllRecipients

publicAddress[]getAllRecipients()                           throwsMessagingException

Get all the recipient addresses for the message. Extracts the TO, CC, BCC, and NEWSGROUPS recipients.

Overrides:

getAllRecipients in classMessage

Returns:

array of Address objects

Throws:

MessagingException -  

See Also:

Message.RecipientType.TO,Message.RecipientType.CC,Message.RecipientType.BCC,MimeMessage.RecipientType.NEWSGROUPS

setRecipients

public voidsetRecipients(Message.RecipientType type,Address[] addresses)                   throwsMessagingException

Set the specified recipient type to the given addresses. If the address parameter isnull, the corresponding recipient field is removed.

Overrides:

setRecipients in classMessage

Parameters:

type - Recipient type

addresses - Addresses

Throws:

IllegalWriteException - if the underlyingimplementation does not support modificationof existing values

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

MessagingException -  

See Also:

getRecipients(javax.mail.Message.RecipientType)

addRecipients

public voidaddRecipients(Message.RecipientType type,Address[] addresses)                   throwsMessagingException

Add the given addresses to the specified recipient type.

Overrides:

addRecipients in classMessage

Parameters:

type - Recipient type

addresses - Addresses

Throws:

IllegalWriteException - if the underlyingimplementation does not support modificationof existing values

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

MessagingException -  

getReplyTo

publicAddress[]getReplyTo()                     throwsMessagingException

Return the value of the RFC 822 "Reply-To" header field. If this header is unavailable or its value is absent, then thegetFrom method is called and its value is returned. This implementation uses thegetHeader method to obtain the requisite header field.

Overrides:

getReplyTo in classMessage

Throws:

MessagingException -  

See Also:

headers

setReplyTo

public voidsetReplyTo(Address[] addresses)                throwsMessagingException

Set the RFC 822 "Reply-To" header field. If the address parameter isnull, this header is removed.

Overrides:

setReplyTo in classMessage

Throws:

IllegalWriteException - if the underlyingimplementation does not support modificationof existing values

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

MessagingException -  

getSubject

public java.lang.StringgetSubject()                            throwsMessagingException

Returns the value of the "Subject" header field. Returns null if the subject field is unavailable or its value is absent.

If the subject is encoded as per RFC 2047, it is decoded and converted into Unicode. If the decoding or conversion fails, the raw data is returned as is.

This implementation uses thegetHeader method to obtain the requisite header field.

Overrides:

getSubject in classMessage

Returns:

Subject

Throws:

MessagingException -  

See Also:

headers

setSubject

public voidsetSubject(java.lang.String subject)                throwsMessagingException

Set the "Subject" header field. If the subject contains non US-ASCII characters, it will be encoded using the platform's default charset. If the subject contains only US-ASCII characters, no encoding is done and it is used as-is. If the subject is null, the existing "Subject" field is removed.

Note that if the charset encoding process fails, a MessagingException is thrown, and an UnsupportedEncodingException is included in the chain of nested exceptions within the MessagingException.

Overrides:

setSubject in classMessage

Parameters:

subject - The subject

Throws:

IllegalWriteException - if the underlyingimplementation does not support modificationof existing values

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

MessagingException. - An UnsupportedEncodingException may be includedin the exception chain if the charsetconversion fails.

setSubject

public voidsetSubject(java.lang.String subject,                       java.lang.String charset)                throwsMessagingException

Set the "Subject" header field. If the subject contains non US-ASCII characters, it will be encoded using the specified charset. If the subject contains only US-ASCII characters, no encoding is done and it is used as-is. If the subject is null, the existing "Subject" header field is removed.

Note that if the charset encoding process fails, a MessagingException is thrown, and an UnsupportedEncodingException is included in the chain of nested exceptions within the MessagingException.

Parameters:

subject - The subject

charset - The charset

Throws:

IllegalWriteException - if the underlyingimplementation does not support modificationof existing values

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

MessagingException. - An UnsupportedEncodingException may be includedin the exception chain if the charsetconversion fails.

getSentDate

public java.util.DategetSentDate()                           throwsMessagingException

Returns the value of the RFC 822 "Date" field. This is the date on which this message was sent. Returns null if this field is unavailable or its value is absent.

This implementation uses thegetHeader method to obtain the requisite header field.

Overrides:

getSentDate in classMessage

Returns:

The sent Date

Throws:

MessagingException -  

setSentDate

public voidsetSentDate(java.util.Date d)                 throwsMessagingException

Set the RFC 822 "Date" header field. This is the date on which the creator of the message indicates that the message is complete and ready for delivery. If the date parameter isnull, the existing "Date" field is removed.

Overrides:

setSentDate in classMessage

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -  

getReceivedDate

public java.util.DategetReceivedDate()                               throwsMessagingException

Returns the Date on this message was received. Returnsnull if this date cannot be obtained.

Note that RFC 822 does not define a field for the received date. Hence only implementations that can provide this date need return a valid value.

This implementation returnsnull.

Overrides:

getReceivedDate in classMessage

Returns:

the date this message was received

Throws:

MessagingException -  

getSize

public intgetSize()            throwsMessagingException

Return the size of the content of this message in bytes. Return -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.

This implementation returns the size of the content byte array, or -1 if there is no content byte array.

Specified by:

getSize in interfacePart

Returns:

size of content in bytes

Throws:

MessagingException -  

getLineCount

public intgetLineCount()                 throwsMessagingException

Return the number of lines for the content of this message. Return -1 if this number cannot be determined.

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

This implementation returns -1.

Specified by:

getLineCount in interfacePart

Returns:

number of lines in the content.

Throws:

MessagingException -  

getContentType

public java.lang.StringgetContentType()                                throwsMessagingException

Returns the value of the RFC 822 "Content-Type" header field. This represents the content-type of the content of this message. This value must not be null. If this field is unavailable, "text/plain" should be returned.

This implementation uses thegetHeader method to obtain the requisite header field.

Specified by:

getContentType in interfacePart

Returns:

The ContentType of this part

Throws:

MessagingException -  

See Also:

DataHandler

isMimeType

public booleanisMimeType(java.lang.String mimeType)                   throwsMessagingException

Is this Part of the specified MIME type? This method comparesonly theprimaryType andsubType. The parameters of the content types are ignored.

For example, this method will returntrue when comparing a Part of content type"text/plain" with"text/plain; charset=foobar".

If thesubType ofmimeType is the special character '*', then the subtype is ignored during the comparison.

Specified by:

isMimeType in interfacePart

getDisposition

public java.lang.StringgetDisposition()                                throwsMessagingException

Returns the value of the "Content-Disposition" header field. This represents the disposition of this part. The disposition describes how the part should be presented to the user.

If the Content-Disposition field is unavailable,null is returned.

This implementation uses thegetHeader method to obtain the requisite header field.

Specified by:

getDisposition in interfacePart

Returns:

disposition of this part, or null if unknown

Throws:

MessagingException -  

setDisposition

public voidsetDisposition(java.lang.String disposition)                    throwsMessagingException

Set the "Content-Disposition" header field of this Message. Ifdisposition is null, any existing "Content-Disposition" header field is removed.

Specified by:

setDisposition in interfacePart

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -  

getEncoding

public java.lang.StringgetEncoding()                             throwsMessagingException

Returns the content transfer encoding from the "Content-Transfer-Encoding" header field. Returnsnull if the header is unavailable or its value is absent.

This implementation uses thegetHeader method to obtain the requisite header field.

Specified by:

getEncoding in interfaceMimePart

Returns:

content-transfer-encoding

Throws:

MessagingException -  

getContentID

public java.lang.StringgetContentID()                              throwsMessagingException

Returns the value of the "Content-ID" header field. Returnsnull if the field is unavailable or its value is absent.

This implementation uses thegetHeader method to obtain the requisite header field.

Specified by:

getContentID in interfaceMimePart

Returns:

content-ID

Throws:

MessagingException -  

setContentID

public voidsetContentID(java.lang.String cid)                  throwsMessagingException

Set the "Content-ID" header field of this Message. If thecid parameter is null, any existing "Content-ID" is removed.

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -  

getContentMD5

public java.lang.StringgetContentMD5()                               throwsMessagingException

Return the value of the "Content-MD5" header field. Returnsnull if this field is unavailable or its value is absent.

This implementation uses thegetHeader method to obtain the requisite header field.

Specified by:

getContentMD5 in interfaceMimePart

Returns:

content-MD5

Throws:

MessagingException -  

setContentMD5

public voidsetContentMD5(java.lang.String md5)                   throwsMessagingException

Set the "Content-MD5" header field of this Message.

Specified by:

setContentMD5 in interfaceMimePart

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -  

getDescription

public java.lang.StringgetDescription()                                throwsMessagingException

Returns the "Content-Description" header field of this Message. This typically associates some descriptive information with this part. Returns null if this field is unavailable or its value is absent.

If the Content-Description field is encoded as per RFC 2047, it is decoded and converted into Unicode. If the decoding or conversion fails, the raw data is returned as-is

This implementation uses thegetHeader method to obtain the requisite header field.

Specified by:

getDescription in interfacePart

Returns:

content-description

Throws:

MessagingException -  

setDescription

public voidsetDescription(java.lang.String description)                    throwsMessagingException

Set the "Content-Description" header field for this Message. If the description parameter isnull, then any existing "Content-Description" fields are removed.

If the description contains non US-ASCII characters, it will be encoded using the platform's default charset. If the description contains only US-ASCII characters, no encoding is done and it is used as-is.

Note that if the charset encoding process fails, a MessagingException is thrown, and an UnsupportedEncodingException is included in the chain of nested exceptions within the MessagingException.

Specified by:

setDescription in interfacePart

Parameters:

description - content-description

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException. - An UnsupportedEncodingException may be includedin the exception chain if the charsetconversion fails.

setDescription

public voidsetDescription(java.lang.String description,                           java.lang.String charset)                    throwsMessagingException

Set the "Content-Description" header field for this Message. If the description parameter isnull, then any existing "Content-Description" fields are removed.

If the description contains non US-ASCII characters, it will be encoded using the specified charset. If the description contains only US-ASCII characters, no encoding is done and it is used as-is.

Note that if the charset encoding process fails, a MessagingException is thrown, and an UnsupportedEncodingException is included in the chain of nested exceptions within the MessagingException.

Parameters:

description - Description

charset - Charset for encoding

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException. - An UnsupportedEncodingException may be includedin the exception chain if the charsetconversion fails.

getContentLanguage

public java.lang.String[]getContentLanguage()                                      throwsMessagingException

Get the languages specified in the "Content-Language" header field of this message. The Content-Language header is defined by RFC 1766. Returnsnull if this field is unavailable or its value is absent.

This implementation uses thegetHeader method to obtain the requisite header field.

Specified by:

getContentLanguage in interfaceMimePart

Returns:

value of content-language header.

Throws:

MessagingException -  

setContentLanguage

public voidsetContentLanguage(java.lang.String[] languages)                        throwsMessagingException

Set the "Content-Language" header of this MimePart. The Content-Language header is defined by RFC 1766.

Specified by:

setContentLanguage in interfaceMimePart

Parameters:

languages - array of language tags

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -  

getMessageID

public java.lang.StringgetMessageID()                              throwsMessagingException

Returns the value of the "Message-ID" header field. Returns null if this field is unavailable or its value is absent.

The default implementation provided here uses thegetHeader method to return the value of the "Message-ID" field.

Returns:

Message-ID

Throws:

MessagingException, - if the retrieval of this fieldcauses any exception.

Since:

JavaMail 1.1

See Also:

MessageIDTerm

getFileName

public java.lang.StringgetFileName()                             throwsMessagingException

Get the filename associated with this Message.

Returns the value of the "filename" parameter from the "Content-Disposition" header field of this message. If it's not available, returns the value of the "name" parameter from the "Content-Type" header field of this BodyPart. Returnsnull if both are absent.

Specified by:

getFileName in interfacePart

Returns:

filename

Throws:

MessagingException -  

setFileName

public voidsetFileName(java.lang.String filename)                 throwsMessagingException

Set the filename associated with this part, if possible.

Sets the "filename" parameter of the "Content-Disposition" header field of this message.

Specified by:

setFileName in interfacePart

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -  

getInputStream

public java.io.InputStreamgetInputStream()                                   throws java.io.IOException,MessagingException

Return a decoded input stream for this Message's "content".

This implementation obtains the input stream from the DataHandler, that is, it invokesgetDataHandler().getInputStream().

Specified by:

getInputStream in interfacePart

Returns:

an InputStream

Throws:

MessagingException -  

java.io.IOException - this is typically thrown by theDataHandler. Refer to the documentation forjavax.activation.DataHandler for more details.

See Also:

getContentStream(),DataHandler.getInputStream()

getContentStream

protected java.io.InputStreamgetContentStream()                                        throwsMessagingException

Produce the raw bytes of the content. This method is used during parsing, to create a DataHandler object for the content. Subclasses that can provide a separate input stream for just the message content might want to override this method.

This implementation just returns a ByteArrayInputStream constructed out of thecontent byte array.

See Also:

content

getDataHandler

publicDataHandlergetDataHandler()                           throwsMessagingException

Return a DataHandler for this Message's content.

The implementation provided here works as follows. Note the use of thegetContentStream method to generate the byte stream for the content. Also note that any transfer-decoding is done automatically within this method.

  getDataHandler() {      if (dh == null) {          dh = new DataHandler(new MimePartDataSource(this));      }      return dh;  }
  class MimePartDataSource implements DataSource {      public getInputStream() {          return MimeUtility.decode(     getContentStream(), getEncoding());      }....  }

Specified by:

getDataHandler in interfacePart

Throws:

MessagingException -  

getContent

public java.lang.ObjectgetContent()                            throws java.io.IOException,MessagingException

Return the content as a Java object. The type of this object is dependent on the content itself. For example, the native format of a "text/plain" content is usually a String object. The native format for a "multipart" message is always a Multipart subclass. For content types that are unknown to the DataHandler system, an input stream is returned as the content.

This implementation obtains the content from the DataHandler, that is, it invokesgetDataHandler().getContent().

Specified by:

getContent in interfacePart

Returns:

Object

Throws:

MessagingException -  

java.io.IOException - this is typically thrown by theDataHandler. Refer to the documentation forjavax.activation.DataHandler for more details.

See Also:

Part,DataHandler.getContent()

setDataHandler

public voidsetDataHandler(DataHandler dh)                    throwsMessagingException

This method provides the mechanism to set this part's content. The given DataHandler object should wrap the actual content.

Specified by:

setDataHandler in interfacePart

Parameters:

dh - The DataHandler for the content.

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -  

setContent

public voidsetContent(java.lang.Object o,                       java.lang.String type)                throwsMessagingException

A convenience method for setting this Message's content.

The content is wrapped in a DataHandler object. Note that a DataContentHandler class for the specified type should be available to the JavaMail implementation for this to work right. i.e., to dosetContent(foobar, "application/x-foobar"), a DataContentHandler for "application/x-foobar" should be installed. Refer to the Java Activation Framework for more information.

Specified by:

setContent in interfacePart

Parameters:

o - the content object

type - Mime type of the object

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification ofexisting values

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

MessagingException -  

setText

public voidsetText(java.lang.String text)             throwsMessagingException

Convenience method that sets the given String as this part's content, with a MIME type of "text/plain". If the string contains non US-ASCII characters. it will be encoded using the platform's default charset. The charset is also used to set the "charset" parameter.

Note that there may be a performance penalty iftext is large, since this method may have to scan all the characters to determine what charset to use.

If the charset is already known, use thesetText method that takes the charset parameter.

Specified by:

setText in interfaceMimePart

See Also:

setText(String text, String charset)

setText

public voidsetText(java.lang.String text,                    java.lang.String charset)             throwsMessagingException

Convenience method that sets the given String as this part's content, with a MIME type of "text/plain" and the specified charset. The given Unicode string will be charset-encoded using the specified charset. The charset is also used to set the "charset" parameter.

Specified by:

setText in interfaceMimePart

setContent

public voidsetContent(Multipart mp)                throwsMessagingException

This method sets the Message's content to a Multipart object.

Specified by:

setContent in interfacePart

Parameters:

mp - The multipart object that is the Message's content

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification ofexisting values

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

MessagingException -  

reply

publicMessagereply(boolean replyToAll)              throwsMessagingException

Get a new Message suitable for a reply to this message. The new Message will have its attributes and headers set up appropriately. Note that this new message object will be empty, i.e., it willnot have a "content". These will have to be suitably filled in by the client.

IfreplyToAll is set, the new Message will be addressed to all recipients of this message. Otherwise, the reply will be addressed to only the sender of this message (using the value of thegetReplyTo method).

The "Subject" field is filled in with the original subject prefixed with "Re:" (unless it already starts with "Re:"). The "In-Reply-To" header is set in the new message if this message has a "Message-Id" header. TheANSWERED flag is set in this message.

Overrides:

reply in classMessage

Parameters:

replyToAll - reply should be sent to all recipientsof this message

Returns:

the reply Message

Throws:

MessagingException -  

writeTo

public voidwriteTo(java.io.OutputStream os)             throws java.io.IOException,MessagingException

Output the message as an RFC 822 format stream.

Note that, depending on how the messag 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.

Specified by:

writeTo in interfacePart

Throws:

java.io.IOException - if an error occurs writing to the streamor if an error is generated by thejavax.activation layer.

MessagingException -  

See Also:

DataHandler.writeTo(java.io.OutputStream)

writeTo

public voidwriteTo(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.

Throws:

MessagingException -  

java.io.IOException - if an error occurs writing to the streamor if an error is generated by thejavax.activation layer.

See Also:

DataHandler.writeTo(java.io.OutputStream)

getHeader

public java.lang.String[]getHeader(java.lang.String name)                             throwsMessagingException

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.

This implementation obtains the headers from theheaders InternetHeaders object.

Specified by:

getHeader in interfacePart

Parameters:

name - name of header

Returns:

array of headers

Throws:

MessagingException -  

See Also:

MimeUtility

getHeader

public java.lang.StringgetHeader(java.lang.String name,                                  java.lang.String delimiter)                           throwsMessagingException

Get all the headers for this header name, returned as a single String, with headers separated by the delimiter. If the delimiter isnull, only the first header is returned.

Specified by:

getHeader in interfaceMimePart

Parameters:

header_name - the name of this header

Returns:

the value fields for all headers with this name

Throws:

MessagingException -  

setHeader

public voidsetHeader(java.lang.String name,                      java.lang.String value)               throwsMessagingException

Set the value for this header_name. Replaces all existing header values with this new value. Note that RFC 822 headers must contain only US-ASCII characters, so a header that contains non US-ASCII characters must have been encoded by the caller as per the rules of RFC 2047.

Specified by:

setHeader in interfacePart

Parameters:

name - header name

value - header value

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -  

See Also:

MimeUtility

addHeader

public voidaddHeader(java.lang.String name,                      java.lang.String value)               throwsMessagingException

Add this value to the existing values for this header_name. Note that RFC 822 headers must contain only US-ASCII characters, so a header that contains non US-ASCII characters must have been encoded as per the rules of RFC 2047.

Specified by:

addHeader in interfacePart

Parameters:

name - header name

value - header value

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -  

See Also:

MimeUtility

removeHeader

public voidremoveHeader(java.lang.String name)                  throwsMessagingException

Remove all headers with this name.

Specified by:

removeHeader in interfacePart

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -  

getAllHeaders

public java.util.EnumerationgetAllHeaders()                                    throwsMessagingException

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.

This implementation obtains the headers from theheaders InternetHeaders object.

Specified by:

getAllHeaders in interfacePart

Returns:

array of header objects

Throws:

MessagingException -  

See Also:

MimeUtility

getMatchingHeaders

public java.util.EnumerationgetMatchingHeaders(java.lang.String[] names)                                         throwsMessagingException

Return matching headers from this Message as an Enumeration of Header objects. This implementation obtains the headers from theheaders InternetHeaders object.

Specified by:

getMatchingHeaders in interfacePart

Throws:

MessagingException -  

getNonMatchingHeaders

public java.util.EnumerationgetNonMatchingHeaders(java.lang.String[] names)                                            throwsMessagingException

Return non-matching headers from this Message as an Enumeration of Header objects. This implementation obtains the header from theheaders InternetHeaders object.

Specified by:

getNonMatchingHeaders in interfacePart

Throws:

MessagingException -  

addHeaderLine

public voidaddHeaderLine(java.lang.String line)                   throwsMessagingException

Add a raw RFC 822 header-line.

Specified by:

addHeaderLine in interfaceMimePart

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -  

getAllHeaderLines

public java.util.EnumerationgetAllHeaderLines()                                        throwsMessagingException

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

Specified by:

getAllHeaderLines in interfaceMimePart

Throws:

MessagingException -  

getMatchingHeaderLines

public java.util.EnumerationgetMatchingHeaderLines(java.lang.String[] names)                                             throwsMessagingException

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

Specified by:

getMatchingHeaderLines in interfaceMimePart

Throws:

MessagingException -  

getNonMatchingHeaderLines

public java.util.EnumerationgetNonMatchingHeaderLines(java.lang.String[] names)                                                throwsMessagingException

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

Specified by:

getNonMatchingHeaderLines in interfaceMimePart

Throws:

MessagingException -  

getFlags

publicFlagsgetFlags()               throwsMessagingException

Return aFlags object containing the flags for this message.

Note that a clone of the internal Flags object is returned, so modifying the returned Flags object will not affect the flags of this message.

Overrides:

getFlags in classMessage

Returns:

Flags object containing the flags for this message

Throws:

MessagingException -  

See Also:

Flags

isSet

public booleanisSet(Flags.Flag flag)              throwsMessagingException

Check whether the flag specified in theflag argument is set in this message.

This implementation checks this message's internalflags object.

Overrides:

isSet in classMessage

Parameters:

flag - the flag

Returns:

value of the specified flag for this message

Throws:

MessagingException -  

See Also:

Flags.Flag,Flags.Flag.ANSWERED,Flags.Flag.DELETED,Flags.Flag.DRAFT,Flags.Flag.FLAGGED,Flags.Flag.RECENT,Flags.Flag.SEEN

setFlags

public voidsetFlags(Flags flag,                     boolean set)              throwsMessagingException

Set the flags for this message.

This implementation modifies theflags field.

Overrides:

setFlags in classMessage

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -  

saveChanges

public voidsaveChanges()                 throwsMessagingException

Updates the appropriate header fields of this message to be consistent with the message's contents. If this message is contained in a Folder, any changes made to this message are committed to the containing folder.

If any part of a message's headers or contents are changed,saveChanges must be called to ensure that those changes are permanent. Else, any such modifications may or may not be saved, depending on the folder implementation.

Messages obtained from folders opened READ_ONLY should not be modified and saveChanges should not be called on such messages.

Overrides:

saveChanges in classMessage

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -  

updateHeaders

protected voidupdateHeaders()                      throwsMessagingException

Called by thesaveChanges method to actually update the MIME headers. The implementation here sets theContent-Transfer-Encoding header (if needed and not already set), theMime-Version header and theMessage-ID header. Also, if the content of this message is aMimeMultipart, it'supdateHeaders method is called.

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

MessagingException -