⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
javax.mail.internet

Class MimeBodyPart

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

All Implemented Interfaces:
Part, MimePart

Known Direct Subclasses:
IMAPBodyPart


public class MimeBodyPart
extends BodyPart
implements MimePart

This class represents a MIME body part. It implements the BodyPart abstract class and the MimePart interface. MimeBodyParts are contained in MimeMultipart objects.

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


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 achieve this. Callers of the setHeader, addHeader, and addHeaderLine methods are responsible for enforcing the MIME requirements for the specified headers. In addition, these header fields must be folded (wrapped) before being sent if they exceed the line length limitation for the transport (1000 bytes for SMTP). Received headers may have been folded. The application is responsible for folding and unfolding headers as appropriate.

Author:

Field Summary

byte[]

content

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

InputStream

contentStream

If the data for this body part was supplied by an InputStream that implements the SharedInputStream interface, contentStream is another such stream representing the content of this body part.

DataHandler

dh

The DataHandler object representing this Part's content.

InternetHeaders

headers

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

Constructor Summary

MimeBodyPart()

An empty MimeBodyPart object is created.

MimeBodyPart(InputStream is)

Constructs a MimeBodyPart by reading and parsing the data from the specified input stream.

MimeBodyPart(InternetHeaders headers, byte[] content)

Constructs a MimeBodyPart using the given header and content bytes.

Method Summary

void

addHeader(String name, String value)

Add this value to the existing values for this name.

void

addHeaderLine(String line)

Add a header line to this body part.

Enumeration

getAllHeaderLines()

Get all header lines as an Enumeration of Strings.

Enumeration

getAllHeaders()

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

Object

getContent()

Return the content as a java object.

String

getContentID()

Returns the value of the "Content-ID" header field.

String[]

getContentLanguage()

Get the languages specified in the Content-Language header of this MimePart.

String

getContentMD5()

Returns the value of the "Content-MD5" header field.

InputStream

getContentStream()

Produce the raw bytes of the content.

String

getContentType()

Returns the value of the RFC 822 "Content-Type" header field.

DataHandler

getDataHandler()

Return a DataHandler for this body part's content.

String

getDescription()

Returns the "Content-Description" header field of this body part.

String

getDisposition()

Returns the value of the "Content-Disposition" header field.

String

getEncoding()

Returns the content transfer encoding from the "Content-Transfer-Encoding" header field.

String

getFileName()

Get the filename associated with this body part.

String[]

getHeader(String name)

Get all the headers for this header_name.

String

getHeader(String name, String delimiter)

Get all the headers for this header name, returned as a single String, with headers separated by the delimiter.

InputStream

getInputStream()

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

int

getLineCount()

Return the number of lines for the content of this Part.

Enumeration

getMatchingHeaderLines(String[] names)

Get matching header lines as an Enumeration of Strings.

Enumeration

getMatchingHeaders(String[] names)

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

Enumeration

getNonMatchingHeaderLines(String[] names)

Get non-matching header lines as an Enumeration of Strings.

Enumeration

getNonMatchingHeaders(String[] names)

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

InputStream

getRawInputStream()

Return an InputStream to the raw data with any Content-Transfer-Encoding intact.

int

getSize()

Return the size of the content of this body part in bytes.

boolean

isMimeType(String mimeType)

Is this Part of the specified MIME type? This method compares only the primaryType and subType.

void

removeHeader(String name)

Remove all headers with this name.

void

setContent(Object o, String type)

A convenience method for setting this body part's content.

void

setContent(Multipart mp)

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

void

setContentID(String cid)

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

void

setContentLanguage(String[] languages)

Set the Content-Language header of this MimePart.

void

setContentMD5(String md5)

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

void

setDataHandler(DataHandler dh)

This method provides the mechanism to set this body part's content.

void

setDescription(String description)

Set the "Content-Description" header field for this body part.

void

setDescription(String description, String charset)

Set the "Content-Description" header field for this body part.

void

setDisposition(String disposition)

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

void

setFileName(String filename)

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

void

setHeader(String name, String value)

Add this value to the existing values for this name.

void

setText(String text)

Convenience method that sets the given String as this part's content, with a MIME type of "text/plain".

void

setText(String text, 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.

void

updateHeaders()

Examine the content of this body part and update the appropriate MIME headers.

void

writeTo(OutputStream os)

Output the body part as an RFC 822 format stream.

Field Details

content

protected byte[] content

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


contentStream

protected InputStream contentStream

If the data for this body part was supplied by an InputStream that implements the SharedInputStream interface, contentStream is another such stream representing the content of this body part. In this case, content will be null.


dh

protected DataHandler dh

The DataHandler object representing this Part's content.


headers

protected InternetHeaders headers

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

Constructor Details

MimeBodyPart

public MimeBodyPart()

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


MimeBodyPart

public MimeBodyPart(InputStream is)

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 must not 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

public MimeBodyPart(InternetHeaders headers, byte[] content)

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.

Method Details

addHeader

public void addHeader(String name, String value)

Add this value to the existing values for this 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.

Parameters:
name - the header name
value - the header value

addHeaderLine

public void addHeaderLine(String line)

Add a header line to this body part.

Parameters:
line
Throws:
- if the underlying implementation does not support modification
- if this body part is obtained from a READ_ONLY folder.

getAllHeaderLines

public Enumeration getAllHeaderLines()

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.


getAllHeaders

public Enumeration getAllHeaders()

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


getContent

public Object getContent()

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();

Throws:
- - this is typically thrown by the DataHandler.

getContentID

public String getContentID()

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

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


getContentLanguage

public String[] getContentLanguage()

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

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


getContentMD5

public String getContentMD5()

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

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


getContentStream

protected InputStream getContentStream()

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.


getContentType

public String getContentType()

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

Returns:
Content-Type of this body part

getDataHandler

public DataHandler getDataHandler()

Return a DataHandler for this body part's content.

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


getDescription

public String getDescription()

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


getDisposition

public String getDisposition()

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


getEncoding

public String getEncoding()

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


getFileName

public String getFileName()

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 it's not available, returns the value of the "name" parameter from the "Content-Type" header field of this body part. Returns null if both are absent.


getHeader

public String[] getHeader(String name)

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.

Parameters:
name - name of header

getHeader

public String getHeader(String name, String delimiter)

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.

Parameters:
name - the name of this header
delimiter - the delimiter to use

getInputStream

public InputStream getInputStream()

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();

Throws:
- this is typically thrown by the DataHandler.

getLineCount

public int getLineCount()

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.

Returns:
number of lines, or -1 if not known

getMatchingHeaderLines

public Enumeration getMatchingHeaderLines(String[] names)

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.

Parameters:
names

getMatchingHeaders

public Enumeration getMatchingHeaders(String[] names)

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

Parameters:
names

getNonMatchingHeaderLines

public Enumeration getNonMatchingHeaderLines(String[] names)

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.

Parameters:
names

getNonMatchingHeaders

public Enumeration getNonMatchingHeaders(String[] names)

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

Parameters:
names

getRawInputStream

public InputStream getRawInputStream()

Return an InputStream to the raw data with any Content-Transfer-Encoding intact. This method is useful if the "Content-Transfer-Encoding" header is incorrect or corrupt, which would prevent the getInputStream method or getContent method from returning the correct data. In such a case the application may use this method and attempt to decode the raw data itself.

This implementation simply calls the getContentStream method.


getSize

public int getSize()

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 the size of the content array (if not null), or, if contentStream is not null, and the available method returns a positive number, it returns that number as the size. Otherwise, it returns -1.

Returns:
size in bytes, or -1 if not known

isMimeType

public boolean isMimeType(String mimeType)

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.

Parameters:
mimeType

removeHeader

public void removeHeader(String name)

Remove all headers with this name.

Parameters:
name - the name of this header
Throws:
- if the underlying implementation does not support modification
- if this body part is obtained from a READ_ONLY folder.

setContent

public void setContent(Object o, String type)

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 do setContent(foobar, "application/x-foobar"), a DataContentHandler for "application/x-foobar" should be installed. Refer to the Java Activation Framework for more information.

Parameters:
o - the content object
type - Mime type of the object
Throws:
- if the underlying implementation does not support modification
- if this body part is obtained from a READ_ONLY folder.

setContent

public void setContent(Multipart mp)

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

Parameters:
mp - The multipart object that is the Message's content
Throws:
- if the underlying implementation does not support modification
- if this body part is obtained from a READ_ONLY folder.

setContentID

public void setContentID(String cid)

Set the "Content-ID" header field of this body part. If the cid parameter is null, any existing "Content-ID" is removed.

Since:
JavaMail 1.3
Parameters:
cid
Throws:
- if the underlying implementation does not support modification
- if this body part is obtained from a READ_ONLY folder.

setContentLanguage

public void setContentLanguage(String[] languages)

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

Parameters:
languages - array of language tags

setContentMD5

public void setContentMD5(String md5)

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

Parameters:
md5
Throws:
- if the underlying implementation does not support modification
- if this body part is obtained from a READ_ONLY folder.

setDataHandler

public void setDataHandler(DataHandler dh)

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

Parameters:
dh
Throws:
- if the underlying implementation does not support modification
- if this body part is obtained from a READ_ONLY folder.

setDescription

public void setDescription(String description)

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

Parameters:
description - content description
Throws:
- if the underlying implementation does not support modification
- if this body part is obtained from a READ_ONLY folder.

setDescription

public void setDescription(String description, String charset)

Set the "Content-Description" header field for this body part. 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 - content description
charset - Charset for encoding
Throws:
- if the underlying implementation does not support modification
- if this body part is obtained from a READ_ONLY folder.

setDisposition

public void setDisposition(String disposition)

Set the "Content-Disposition" header field of this body part. If the disposition is null, any existing "Content-Disposition" header field is removed.

Parameters:
disposition
Throws:
- if the underlying implementation does not support modification
- if this body part is obtained from a READ_ONLY folder.

setFileName

public void setFileName(String filename)

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

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

Parameters:
filename
Throws:
- if the underlying implementation does not support modification
- if this body part is obtained from a READ_ONLY folder.

setHeader

public void setHeader(String name, String value)

Add this value to the existing values for this 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.

Parameters:
name - the header name
value - the header value

setText

public void setText(String text)

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() version that takes the charset parameter.

Parameters:
text

setText

public void setText(String text, 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. The given Unicode string will be charset-encoded using the specified charset. The charset is also used to set the "charset" parameter.

Parameters:
text
charset

updateHeaders

protected void updateHeaders()

Examine the content of this body part and update the appropriate MIME headers. Typical headers that get set here are Content-Type and Content-Transfer-Encoding. Headers might need to be updated in two cases: In both cases this method is typically called by the Message.saveChanges method.


writeTo

public void writeTo(OutputStream os)

Output the body part as an RFC 822 format stream.

Parameters:
os
Throws:
- if an error occurs writing to the stream or if an error is generated by the javax.activation layer.