Movatterモバイル変換

Class MimeBodyPart

java.lang.Object  |  +--javax.mail.BodyPart        |        +--javax.mail.internet.MimeBodyPart

All Implemented Interfaces:

MimePart,Part

public classMimeBodyPart

extendsBodyPart

implementsMimePart

This class represents a MIME body part. It implements theBodyPart abstract class and theMimePart interface. MimeBodyParts are contained inMimeMultipart objects.

MimeBodyPart uses theInternetHeaders class to parse and store the headers of that body part.

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:

Part,MimePart,MimeUtility

dh

protectedDataHandlerdh

The DataHandler object representing this Part's content.

content

protected byte[]content

Byte array that holds the bytes of the content of this Part.

headers

protectedInternetHeadersheaders

The InternetHeaders object that stores all the headers of this body part.

MimeBodyPart

publicMimeBodyPart()

An empty MimeBodyPart object is created. This body part maybe filled in by a client constructing a multipart message.

MimeBodyPart

publicMimeBodyPart(java.io.InputStream is)             throwsMessagingException

Constructs a MimeBodyPart by reading and parsing the data from the specified input stream. The parser consumes data till the end of the given input stream. The input stream must start at the beginning of a valid MIME body part and must terminate at the end of that body part.

Note that the "boundary" string that delimits body parts mustnot be included in the input stream. The intention is that the MimeMultipart parser will extract each body part's bytes from a multipart stream and feed them into this constructor, without the delimiter strings.

Parameters:

is - the body part Input Stream

MimeBodyPart

publicMimeBodyPart(InternetHeaders headers,                    byte[] content)             throwsMessagingException

Constructs a MimeBodyPart using the given header and content bytes.

Used by providers.

Parameters:

headers - The header of this part

content - bytes representing the body of this part.

getSize

public intgetSize()            throwsMessagingException

Return the size of the content of this body part 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 -1;

Specified by:

getSize in interfacePart

Returns:

size in bytes

getLineCount

public intgetLineCount()                 throwsMessagingException

Return the number of lines for the content of this Part. 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

Following copied from interface:javax.mail.Part

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 body part. This value must not be null. If this field is unavailable, "text/plain" should be returned.

This implementation usesgetHeader(name) to obtain the requisite header field.

Specified by:

getContentType in interfacePart

Returns:

Content-Type of this body part

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 usesgetHeader(name) to obtain the requisite header field.

Specified by:

getDisposition in interfacePart

See Also:

headers

setDisposition

public voidsetDisposition(java.lang.String disposition)                    throwsMessagingException

Set the "Content-Disposition" header field of this body part. If the disposition 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 body part isobtained from a READ_ONLY folder.

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 usesgetHeader(name) to obtain the requisite header field.

Specified by:

getEncoding in interfaceMimePart

See Also:

headers

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 usesgetHeader(name) to obtain the requisite header field.

Specified by:

getContentID in interfaceMimePart

Following copied from interface:javax.mail.internet.MimePart

Returns:

content-ID

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 usesgetHeader(name) to obtain the requisite header field.

Specified by:

getContentMD5 in interfaceMimePart

Following copied from interface:javax.mail.internet.MimePart

Returns:

content-MD5

setContentMD5

public voidsetContentMD5(java.lang.String md5)                   throwsMessagingException

Set the "Content-MD5" header field of this body part.

Specified by:

setContentMD5 in interfaceMimePart

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

getContentLanguage

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

Get the languages specified in the Content-Language header of this MimePart. The Content-Language header is defined by RFC 1766. Returnsnull if this header is not available or its value is absent.

This implementation usesgetHeader(name) to obtain the requisite header field.

Specified by:

getContentLanguage in interfaceMimePart

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

getDescription

public java.lang.StringgetDescription()                                throwsMessagingException

Returns the "Content-Description" header field of this body part. 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 usesgetHeader(name) to obtain the requisite header field.

Specified by:

getDescription in interfacePart

Returns:

content description

setDescription

public voidsetDescription(java.lang.String description)                    throwsMessagingException

Set the "Content-Description" header field for this body part. 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 body part isobtained from a READ_ONLY folder.

MessagingException. - An UnsupportedEncodingException may be included in the exception chain if the charset conversion fails.

setDescription

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

Set the "Content-Description" header field for this body part. 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 body part isobtained from a READ_ONLY folder.

MessagingException. - An UnsupportedEncodingException may be included in the exception chain if the charset conversion fails.

getFileName

public java.lang.StringgetFileName()                             throwsMessagingException

Get the filename associated with this body part.

Returns the value of the "filename" parameter from the "Content-Disposition" header field of this body part. If its not available, returns the value of the "name" parameter from the "Content-Type" header field of this body part. Returnsnull if both are absent.

Specified by:

getFileName in interfacePart

Returns:

filename

setFileName

public voidsetFileName(java.lang.String filename)                 throwsMessagingException

Set the filename associated with this body part, if possible.

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

Specified by:

setFileName in interfacePart

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

getInputStream

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

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

This implementation obtains the input stream from the DataHandler. That is, it invokes getDataHandler().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 when creating a DataHandler object for the content. Subclasses that can provide a separate input stream for just the Part content might want to override this method.

See Also:

content,MimeMessage.getContentStream()

getDataHandler

publicDataHandlergetDataHandler()                           throwsMessagingException

Return a DataHandler for this body part's content.

The implementation provided here works just like the the implementation in MimeMessage.

Specified by:

getDataHandler in interfacePart

See Also:

MimeMessage.getDataHandler()

getContent

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

Return the content as a java object. The type of the object returned is of course 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" content 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 interfacePart

Returns:

Object

Throws:

MessagingException -  

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

setDataHandler

public voidsetDataHandler(DataHandler dh)                    throwsMessagingException

This method provides the mechanism to set this body 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 underlying implementation does not support modification

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

setContent

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

A convenience method for setting this body part'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. That is, 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 body part isobtained from a READ_ONLY folder.

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 the setText() version 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 body part'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 body part isobtained from a READ_ONLY folder.

writeTo

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

Output the body part as an RFC 822 format stream.

Specified by:

writeTo in interfacePart

Throws:

MessagingException -  

java.io.IOException - if an error occurs writing to thestream or if an error is generatedby the javax.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.

Specified by:

getHeader in interfacePart

Parameters:

name - name of header

Returns:

array of headers

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 be encoded as per the rules of RFC 2047.

Specified by:

setHeader in interfacePart

Parameters:

name - header name

value - header value

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 be encoded as per the rules of RFC 2047.

Specified by:

addHeader in interfacePart

Parameters:

name - header name

value - header value

See Also:

MimeUtility

removeHeader

public voidremoveHeader(java.lang.String name)                  throwsMessagingException

Remove all headers with this name.

Specified by:

removeHeader in interfacePart

Following copied from interface:javax.mail.Part

Parameters:

header_name - the name of this header

Throws:

MessagingException -  

IllegalWriteException - if the underlying implementation does not support modification of existing values

java.lang.IllegalStateException - if this Part is obtained from a READ_ONLY folder

getAllHeaders

public java.util.EnumerationgetAllHeaders()                                    throwsMessagingException

Return all the headers from this Message as an Enumeration of Header objects.

Specified by:

getAllHeaders in interfacePart

Following copied from interface:javax.mail.Part

Returns:

array of Header objects

Throws:

MessagingException -  

getMatchingHeaders

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

Return matching headers from this Message as an Enumeration of Header objects.

Specified by:

getMatchingHeaders in interfacePart

Following copied from interface:javax.mail.Part

Returns:

array of Header objects

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.

Specified by:

getNonMatchingHeaders in interfacePart

Following copied from interface:javax.mail.Part

Returns:

array of Header objects

Throws:

MessagingException -  

addHeaderLine

public voidaddHeaderLine(java.lang.String line)                   throwsMessagingException

Add a header line to this body part

Specified by:

addHeaderLine in interfaceMimePart

Following copied from interface:javax.mail.internet.MimePart

Throws:

IllegalWriteException - if the underlyingimplementation does not support modification

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

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

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

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

updateHeaders

protected voidupdateHeaders()                      throwsMessagingException

Examine the content of this body part and update the appropriate MIME headers. Typical headers that get set here areContent-Type andContent-Transfer-Encoding. Headers might need to be updated in two cases:
- A message being crafted by a mail application will certainly need to activate this method at some point to fill up its internal headers.
- A message read in from a Store will have obtained all its headers from the store, and so doesn't need this. However, if this message is editable and if any edits have been made to either the content or message structure, we might need to resync our headers.
In both cases this method is typically called by theMessage.saveChanges method.