站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > Java Platform, Enterprise Edition v1.3.1 API Specifications

Java 2 Platform EE v1.3: Class MimeMessage - Java Platform, Enterprise Edition v1.3.1 API Specifications

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

javax.mail.internet
Class MimeMessage

java.lang.Object
  |
  +--javax.mail.Message
        |
        +--javax.mail.internet.MimeMessage
All Implemented Interfaces:
MimePart, Part
public class MimeMessage
extends Message
implements MimePart

This class represents a MIME style email message. It implements the Message abstract class and the MimePart 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 the InternetHeaders class to parse and store the toplevel RFC 822 headers of a message.

A note on RFC 822 and MIME headers

RFC 822 header fields must 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

Inner Class Summary
static class MimeMessage.RecipientType
          This inner class extends the javax.mail.Message.RecipientType class to add additional RecipientTypes.
 
Inner classes inherited from class javax.mail.Message
Message.RecipientType
 
Field Summary
protected  byte[] content
          Byte array that holds the bytes of this Message's content.
protected  DataHandler dh
          The DataHandler object representing this Message's content.
protected  Flags flags
          The Flags for this message.
protected  InternetHeaders headers
          The InternetHeaders object that stores the header of this message.
 
Fields inherited from class javax.mail.Message
expunged, folder, msgnum, session
 
Fields inherited from interface javax.mail.Part
ATTACHMENT, INLINE
 
Constructor Summary
protected MimeMessage(Folder folder, java.io.InputStream is, int msgnum)
          Constructs a MimeMessage by reading and parsing the data from the specified MIME InputStream.
protected MimeMessage(Folder folder, int msgnum)
          Constructs an empty MimeMessage object with the given Folder and message number.
protected MimeMessage(Folder folder, InternetHeaders headers, byte[] content, int msgnum)
          Constructs a MimeMessage from the given InternetHeaders object and content.
  MimeMessage(Session session)
          Default constructor.
  MimeMessage(Session session, java.io.InputStream is)
          Constructs a MimeMessage by reading and parsing the data from the specified MIME InputStream.
 
Method Summary
 void addFrom(Address[] addresses)
          Add the specified addresses to the existing "From" field.
 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 RFC 822 header-line.
 void addRecipients(Message.RecipientType type, Address[] addresses)
          Add the given addresses to the specified recipient type.
 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.
 Address[] getAllRecipients()
          Get all the recipient addresses for the message.
 java.lang.Object getContent()
          Return the content as a Java object.
 java.lang.String getContentID()
          Returns the value of the "Content-ID" header field.
 java.lang.String[] getContentLanguage()
          Get the languages specified in the "Content-Language" header field of this message.
 java.lang.String getContentMD5()
          Return the value of the "Content-MD5" header field.
protected  java.io.InputStream getContentStream()
          Produce the raw bytes of the content.
 java.lang.String getContentType()
          Returns the value of the RFC 822 "Content-Type" header field.
 DataHandler getDataHandler()
          Return a DataHandler for this Message's content.
 java.lang.String getDescription()
          Returns the "Content-Description" header field of this Message.
 java.lang.String getDisposition()
          Returns the value of the "Content-Disposition" header field.
 java.lang.String getEncoding()
          Returns the content transfer encoding from the "Content-Transfer-Encoding" header field.
 java.lang.String getFileName()
          Get the filename associated with this Message.
 Flags getFlags()
          Return a Flags object containing the flags for this message.
 Address[] getFrom()
          Returns the value of the RFC 822 "From" header fields.
 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.io.InputStream getInputStream()
          Return a decoded input stream for this Message's "content".
 int getLineCount()
          Return the number of lines for the content of this message.
 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.lang.String getMessageID()
          Returns the value of the "Message-ID" header field.
 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.
 java.util.Date getReceivedDate()
          Returns the Date on this message was received.
 Address[] getRecipients(Message.RecipientType type)
          Returns the recepients specified by the type.
 Address[] getReplyTo()
          Return the value of the RFC 822 "Reply-To" header field.
 java.util.Date getSentDate()
          Returns the value of the RFC 822 "Date" field.
 int getSize()
          Return the size of the content of this message in bytes.
 java.lang.String getSubject()
          Returns the value of the "Subject" header field.
 boolean isMimeType(java.lang.String mimeType)
          Is this Part of the specified MIME type? This method compares only the primaryType and subType.
 boolean isSet(Flags.Flag flag)
          Check whether the flag specified in the flag argument is set in this message.
 void removeHeader(java.lang.String name)
          Remove all headers with this name.
 Message reply(boolean replyToAll)
          Get a new Message suitable for a reply to this message.
 void saveChanges()
          Updates the appropriate header fields of this message to be consistent with the message's contents.
 void setContent(Multipart mp)
          This method sets the Message's content to a Multipart object.
 void setContent(java.lang.Object o, java.lang.String type)
          A convenience method for setting this Message's content.
 void setContentID(java.lang.String cid)
          Set the "Content-ID" header field of this Message.
 void setContentLanguage(java.lang.String[] languages)
          Set the "Content-Language" header of this MimePart.
 void setContentMD5(java.lang.String md5)
          Set the "Content-MD5" header field of this Message.
 void setDataHandler(DataHandler dh)
          This method provides the mechanism to set this part's content.
 void setDescription(java.lang.String description)
          Set the "Content-Description" header field for this Message.
 void setDescription(java.lang.String description, java.lang.String charset)
          Set the "Content-Description" header field for this Message.
 void setDisposition(java.lang.String disposition)
          Set the "Content-Disposition" header field of this Message.
 void setFileName(java.lang.String filename)
          Set the filename associated with this part, if possible.
 void setFlags(Flags flag, boolean set)
          Set the flags for this message.
 void setFrom()
          Set the RFC 822 "From" header field using the value of the InternetAddress.getLocalAddress method.
 void setFrom(Address address)
          Set the RFC 822 "From" header field.
 void setHeader(java.lang.String name, java.lang.String value)
          Set the value for this header_name.
 void setRecipients(Message.RecipientType type, Address[] addresses)
          Set the specified recipient type to the given addresses.
 void setReplyTo(Address[] addresses)
          Set the RFC 822 "Reply-To" header field.
 void setSentDate(java.util.Date d)
          Set the RFC 822 "Date" header field.
 void setSubject(java.lang.String subject)
          Set the "Subject" header field.
 void setSubject(java.lang.String subject, java.lang.String charset)
          Set the "Subject" header field.
 void setText(java.lang.String text)
          Convenience method that sets the given String as this part's content, with a MIME type of "text/plain".
 void setText(java.lang.String text, java.lang.String charset)
          Convenience method that sets the given String as this part's content, with a MIME type of "text/plain" and the specified charset.
protected  void updateHeaders()
          Called by the saveChanges method to actually update the MIME headers.
 void writeTo(java.io.OutputStream os)
          Output the message as an RFC 822 format stream.
 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 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
 

Field Detail

dh

protected DataHandler dh
The DataHandler object representing this Message's content.

content

protected byte[] content
Byte array that holds the bytes of this Message's content.

headers

protected InternetHeaders headers
The InternetHeaders object that stores the header of this message.

flags

protected Flags flags
The Flags for this message.
Constructor Detail

MimeMessage

public MimeMessage(Session session)
Default constructor. An empty message object is created. The headers field is set to an empty InternetHeaders object. The flags field is set to an empty Flags object.

MimeMessage

public MimeMessage(Session session,
                   java.io.InputStream is)
            throws MessagingException
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

protected MimeMessage(Folder folder,
                      int msgnum)
Constructs an empty MimeMessage object with the given Folder and message number.

This method is for providers subclassing MimeMessage.

MimeMessage

protected MimeMessage(Folder folder,
                      java.io.InputStream is,
                      int msgnum)
               throws MessagingException
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 subclassing MimeMessage.

Parameters:
folder - The containing folder.
is - the message input stream
msgnum - Message number of this message within its folder
Throws:
MessagingException -  

MimeMessage

protected MimeMessage(Folder folder,
                      InternetHeaders headers,
                      byte[] content,
                      int msgnum)
               throws MessagingException
Constructs a MimeMessage from the given InternetHeaders object and content. This method is for providers subclassing MimeMessage.
Parameters:
folder - The containing folder.
is - the message input stream
msgnum - Message number of this message within its folder
Throws:
MessagingException -  
Method Detail

getFrom

public Address[] getFrom()
                  throws MessagingException
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 the getHeader method to obtain the requisite header field.

Overrides:
getFrom in class Message
Returns:
Address object
Throws:
MessagingException -  
See Also:
headers

setFrom

public void setFrom(Address address)
             throws MessagingException
Set the RFC 822 "From" header field. Any existing values are replaced with the given address. If address is null, this header is removed.
Overrides:
setFrom in class Message
Parameters:
address - the sender of this message
Throws:
IllegalWriteException - if the underlying implementation does not support modification of existing values
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

setFrom

public void setFrom()
             throws MessagingException
Set the RFC 822 "From" header field using the value of the InternetAddress.getLocalAddress method.
Overrides:
setFrom in class Message
Throws:
IllegalWriteException - if the underlying implementation does not support modification of existing values
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

addFrom

public void addFrom(Address[] addresses)
             throws MessagingException
Add the specified addresses to the existing "From" field. If the "From" field does not already exist, it is created.
Overrides:
addFrom in class Message
Parameters:
addresses - the senders of this message
Throws:
IllegalWriteException - if the underlying implementation does not support modification of existing values
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

getRecipients

public Address[] getRecipients(Message.RecipientType type)
                        throws MessagingException
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 the getHeader method to obtain the requisite header field.

Overrides:
getRecipients in class Message
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

public Address[] getAllRecipients()
                           throws MessagingException
Get all the recipient addresses for the message. Extracts the TO, CC, BCC, and NEWSGROUPS recipients.
Overrides:
getAllRecipients in class Message
Returns:
array of Address objects
Throws:
MessagingException -  
See Also:
Message.RecipientType.TO, Message.RecipientType.CC, Message.RecipientType.BCC, MimeMessage.RecipientType.NEWSGROUPS

setRecipients

public void setRecipients(Message.RecipientType type,
                          Address[] addresses)
                   throws MessagingException
Set the specified recipient type to the given addresses. If the address parameter is null, the corresponding recipient field is removed.
Overrides:
setRecipients in class Message
Parameters:
type - Recipient type
addresses - Addresses
Throws:
IllegalWriteException - if the underlying implementation does not support modification of existing values
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  
See Also:
getRecipients(javax.mail.Message.RecipientType)

addRecipients

public void addRecipients(Message.RecipientType type,
                          Address[] addresses)
                   throws MessagingException
Add the given addresses to the specified recipient type.
Overrides:
addRecipients in class Message
Parameters:
type - Recipient type
addresses - Addresses
Throws:
IllegalWriteException - if the underlying implementation does not support modification of existing values
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

getReplyTo

public Address[] getReplyTo()
                     throws MessagingException
Return the value of the RFC 822 "Reply-To" header field. If this header is unavailable or its value is absent, then the getFrom method is called and its value is returned. This implementation uses the getHeader method to obtain the requisite header field.
Overrides:
getReplyTo in class Message
Throws:
MessagingException -  
See Also:
headers

setReplyTo

public void setReplyTo(Address[] addresses)
                throws MessagingException
Set the RFC 822 "Reply-To" header field. If the address parameter is null, this header is removed.
Overrides:
setReplyTo in class Message
Throws:
IllegalWriteException - if the underlying implementation does not support modification of existing values
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

getSubject

public java.lang.String getSubject()
                            throws MessagingException
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 the getHeader method to obtain the requisite header field.

Overrides:
getSubject in class Message
Returns:
Subject
Throws:
MessagingException -  
See Also:
headers

setSubject

public void setSubject(java.lang.String subject)
                throws MessagingException
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 class Message
Parameters:
subject - The subject
Throws:
IllegalWriteException - if the underlying implementation does not support modification of existing values
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException. - An UnsupportedEncodingException may be included in the exception chain if the charset conversion fails.

setSubject

public void setSubject(java.lang.String subject,
                       java.lang.String charset)
                throws MessagingException
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 underlying implementation does not support modification of existing values
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException. - An UnsupportedEncodingException may be included in the exception chain if the charset conversion fails.

getSentDate

public java.util.Date getSentDate()
                           throws MessagingException
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 the getHeader method to obtain the requisite header field.

Overrides:
getSentDate in class Message
Returns:
The sent Date
Throws:
MessagingException -  

setSentDate

public void setSentDate(java.util.Date d)
                 throws MessagingException
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 is null, the existing "Date" field is removed.
Overrides:
setSentDate in class Message
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

getReceivedDate

public java.util.Date getReceivedDate()
                               throws MessagingException
Returns the Date on this message was received. Returns null 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 returns null.

Overrides:
getReceivedDate in class Message
Returns:
the date this message was received
Throws:
MessagingException -  

getSize

public int getSize()
            throws MessagingException
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 interface Part
Returns:
size of content in bytes
Throws:
MessagingException -  

getLineCount

public int getLineCount()
                 throws MessagingException
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 interface Part
Returns:
number of lines in the content.
Throws:
MessagingException -  

getContentType

public java.lang.String getContentType()
                                throws MessagingException
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 the getHeader method to obtain the requisite header field.

Specified by:
getContentType in interface Part
Returns:
The ContentType of this part
Throws:
MessagingException -  
See Also:
DataHandler

isMimeType

public boolean isMimeType(java.lang.String mimeType)
                   throws MessagingException
Is this Part of the specified MIME type? This method compares only the primaryType and subType. The parameters of the content types are ignored.

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

If the subType of mimeType is the special character '*', then the subtype is ignored during the comparison.

Specified by:
isMimeType in interface Part

getDisposition

public java.lang.String getDisposition()
                                throws MessagingException
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 the getHeader method to obtain the requisite header field.

Specified by:
getDisposition in interface Part
Returns:
disposition of this part, or null if unknown
Throws:
MessagingException -  

setDisposition

public void setDisposition(java.lang.String disposition)
                    throws MessagingException
Set the "Content-Disposition" header field of this Message. If disposition is null, any existing "Content-Disposition" header field is removed.
Specified by:
setDisposition in interface Part
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

getEncoding

public java.lang.String getEncoding()
                             throws MessagingException
Returns the content transfer encoding from the "Content-Transfer-Encoding" header field. Returns null if the header is unavailable or its value is absent.

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

Specified by:
getEncoding in interface MimePart
Returns:
content-transfer-encoding
Throws:
MessagingException -  

getContentID

public java.lang.String getContentID()
                              throws MessagingException
Returns the value of the "Content-ID" header field. Returns null if the field is unavailable or its value is absent.

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

Specified by:
getContentID in interface MimePart
Returns:
content-ID
Throws:
MessagingException -  

setContentID

public void setContentID(java.lang.String cid)
                  throws MessagingException
Set the "Content-ID" header field of this Message. If the cid parameter is null, any existing "Content-ID" is removed.
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

getContentMD5

public java.lang.String getContentMD5()
                               throws MessagingException
Return the value of the "Content-MD5" header field. Returns null if this field is unavailable or its value is absent.

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

Specified by:
getContentMD5 in interface MimePart
Returns:
content-MD5
Throws:
MessagingException -  

setContentMD5

public void setContentMD5(java.lang.String md5)
                   throws MessagingException
Set the "Content-MD5" header field of this Message.
Specified by:
setContentMD5 in interface MimePart
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

getDescription

public java.lang.String getDescription()
                                throws MessagingException
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 the getHeader method to obtain the requisite header field.

Specified by:
getDescription in interface Part
Returns:
content-description
Throws:
MessagingException -  

setDescription

public void setDescription(java.lang.String description)
                    throws MessagingException
Set the "Content-Description" header field for this Message. If the description parameter is null, 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 interface Part
Parameters:
description - content-description
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException. - An UnsupportedEncodingException may be included in the exception chain if the charset conversion fails.

setDescription

public void setDescription(java.lang.String description,
                           java.lang.String charset)
                    throws MessagingException
Set the "Content-Description" header field for this Message. If the description parameter is null, 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 underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException. - An UnsupportedEncodingException may be included in the exception chain if the charset conversion fails.

getContentLanguage

public java.lang.String[] getContentLanguage()
                                      throws MessagingException
Get the languages specified in the "Content-Language" header field of this message. The Content-Language header is defined by RFC 1766. Returns null if this field is unavailable or its value is absent.

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

Specified by:
getContentLanguage in interface MimePart
Returns:
value of content-language header.
Throws:
MessagingException -  

setContentLanguage

public void setContentLanguage(java.lang.String[] languages)
                        throws MessagingException
Set the "Content-Language" header of this MimePart. The Content-Language header is defined by RFC 1766.
Specified by:
setContentLanguage in interface MimePart
Parameters:
languages - array of language tags
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

getMessageID

public java.lang.String getMessageID()
                              throws MessagingException
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 the getHeader method to return the value of the "Message-ID" field.

Returns:
Message-ID
Throws:
MessagingException, - if the retrieval of this field causes any exception.
Since:
JavaMail 1.1
See Also:
MessageIDTerm

getFileName

public java.lang.String getFileName()
                             throws MessagingException
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. Returns null if both are absent.

Specified by:
getFileName in interface Part
Returns:
filename
Throws:
MessagingException -  

setFileName

public void setFileName(java.lang.String filename)
                 throws MessagingException
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 interface Part
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

getInputStream

public java.io.InputStream getInputStream()
                                   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 invokes getDataHandler().getInputStream().

Specified by:
getInputStream in interface Part
Returns:
an InputStream
Throws:
MessagingException -  
java.io.IOException - this is typically thrown by the DataHandler. Refer to the documentation for javax.activation.DataHandler for more details.
See Also:
getContentStream(), DataHandler.getInputStream()

getContentStream

protected java.io.InputStream getContentStream()
                                        throws MessagingException
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 the content byte array.

See Also:
content

getDataHandler

public DataHandler getDataHandler()
                           throws MessagingException
Return a DataHandler for this Message's content.

The implementation provided here works as follows. Note the use of the getContentStream 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 interface Part
Throws:
MessagingException -  

getContent

public java.lang.Object getContent()
                            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 invokes getDataHandler().getContent().

Specified by:
getContent in interface Part
Returns:
Object
Throws:
MessagingException -  
java.io.IOException - this is typically thrown by the DataHandler. Refer to the documentation for javax.activation.DataHandler for more details.
See Also:
Part, DataHandler.getContent()

setDataHandler

public void setDataHandler(DataHandler dh)
                    throws MessagingException
This method provides the mechanism to set this part's content. The given DataHandler object should wrap the actual content.
Specified by:
setDataHandler in interface Part
Parameters:
dh - The DataHandler for the content.
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

setContent

public void setContent(java.lang.Object o,
                       java.lang.String type)
                throws MessagingException
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 do setContent(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 interface Part
Parameters:
o - the content object
type - Mime type of the object
Throws:
IllegalWriteException - if the underlying implementation does not support modification of existing values
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

setText

public void setText(java.lang.String text)
             throws MessagingException
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 if text 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 the setText method that takes the charset parameter.

Specified by:
setText in interface MimePart
See Also:
setText(String text, String charset)

setText

public void setText(java.lang.String text,
                    java.lang.String charset)
             throws MessagingException
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 interface MimePart

setContent

public void setContent(Multipart mp)
                throws MessagingException
This method sets the Message's content to a Multipart object.
Specified by:
setContent in interface Part
Parameters:
mp - The multipart object that is the Message's content
Throws:
IllegalWriteException - if the underlying implementation does not support modification of existing values
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

reply

public Message reply(boolean replyToAll)
              throws MessagingException
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 will not have a "content". These will have to be suitably filled in by the client.

If replyToAll 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 the getReplyTo 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. The ANSWERED flag is set in this message.

Overrides:
reply in class Message
Parameters:
replyToAll - reply should be sent to all recipients of this message
Returns:
the reply Message
Throws:
MessagingException -  

writeTo

public void writeTo(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 interface Part
Throws:
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)

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.
Throws:
MessagingException -  
java.io.IOException - if an error occurs writing to the stream or if an error is generated by the javax.activation layer.
See Also:
DataHandler.writeTo(java.io.OutputStream)

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.

This implementation obtains the headers from the headers InternetHeaders object.

Specified by:
getHeader in interface Part
Parameters:
name - name of header
Returns:
array of headers
Throws:
MessagingException -  
See Also:
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.
Specified by:
getHeader in interface MimePart
Parameters:
header_name - the name of this header
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. 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 interface Part
Parameters:
name - header name
value - header value
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  
See Also:
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. 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 interface Part
Parameters:
name - header name
value - header value
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  
See Also:
MimeUtility

removeHeader

public void removeHeader(java.lang.String name)
                  throws MessagingException
Remove all headers with this name.
Specified by:
removeHeader in interface Part
Throws:
IllegalWriteException - if 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.

This implementation obtains the headers from the headers InternetHeaders object.

Specified by:
getAllHeaders in interface Part
Returns:
array of header objects
Throws:
MessagingException -  
See Also:
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. This implementation obtains the headers from the headers InternetHeaders object.
Specified by:
getMatchingHeaders in interface Part
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. This implementation obtains the header from the headers InternetHeaders object.
Specified by:
getNonMatchingHeaders in interface Part
Throws:
MessagingException -  

addHeaderLine

public void addHeaderLine(java.lang.String line)
                   throws MessagingException
Add a raw RFC 822 header-line.
Specified by:
addHeaderLine in interface MimePart
Throws:
IllegalWriteException - if 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 RFC 822 header-line, containing both the "name" and "value" field.
Specified by:
getAllHeaderLines in interface MimePart
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 RFC 822 header-line, containing both the "name" and "value" field.
Specified by:
getMatchingHeaderLines in interface MimePart
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 RFC 822 header-line, containing both the "name" and "value" field.
Specified by:
getNonMatchingHeaderLines in interface MimePart
Throws:
MessagingException -  

getFlags

public Flags getFlags()
               throws MessagingException
Return a Flags 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 class Message
Returns:
Flags object containing the flags for this message
Throws:
MessagingException -  
See Also:
Flags

isSet

public boolean isSet(Flags.Flag flag)
              throws MessagingException
Check whether the flag specified in the flag argument is set in this message.

This implementation checks this message's internal flags object.

Overrides:
isSet in class Message
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 void setFlags(Flags flag,
                     boolean set)
              throws MessagingException
Set the flags for this message.

This implementation modifies the flags field.

Overrides:
setFlags in class Message
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

saveChanges

public void saveChanges()
                 throws MessagingException
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 class Message
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  

updateHeaders

protected void updateHeaders()
                      throws MessagingException
Called by the saveChanges method to actually update the MIME headers. The implementation here sets the Content-Transfer-Encoding header (if needed and not already set), the Mime-Version header and the Message-ID header. Also, if the content of this message is a MimeMultipart, it's updateHeaders method is called.
Throws:
IllegalWriteException - if the underlying implementation does not support modification
java.lang.IllegalStateException - if this message is obtained from a READ_ONLY folder.
MessagingException -  
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

The CHM file was converted