javax.mail.internet

Class MimeBodyPart

Implemented Interfaces:
MimePart, Part
Known Direct Subclasses:
IMAPBodyPart

public class MimeBodyPart
extends BodyPart
implements MimePart

A MIME body part. Body parts are components of multipart parts.

The string representation of RFC822 and MIME header fields must contain only US-ASCII characters. Non US-ASCII characters must be encoded as per the rules in RFC 2047. This class does not enforce those rules; the caller is expected to use MimeUtility to ensure that header values are correctly encoded.

Version:
1.4
Author:
Chris Burdess

Field Summary

protected byte[]
content
The bytes of the content of this part, if the part can be stored in memory.
protected InputStream
contentStream
A SharedInputStream containing the bytes of this part, if it cannot be stored in memory.
protected DataHandler
dh
The data handler managing this part's content.
protected InternetHeaders
headers
The headers of this body part.

Fields inherited from class javax.mail.BodyPart

parent

Fields inherited from interface javax.mail.Part

ATTACHMENT, INLINE

Constructor Summary

MimeBodyPart()
Constructor for an empty MIME body part.
MimeBodyPart(InputStream is)
Constructor with an input stream.
MimeBodyPart(InternetHeaders headers, byte[] content)
Constructor with headers and byte content.

Method Summary

void
addHeader(String name, String value)
Adds the specified header.
void
addHeaderLine(String line)
Adds an RFC 822 header-line to this part.
void
attachFile(File file)
Use the specified file as the content for this part.
void
attachFile(String file)
Use the specified file as the content for this part.
Enumeration
getAllHeaderLines()
Returns all the header-lines.
Enumeration
getAllHeaders()
Returns all the headers.
Object
getContent()
Returns this part's content as a Java object.
String
getContentID()
Returns the value of the Content-ID header field.
String[]
getContentLanguage()
Returns the languages specified in the Content-Language header of this part, as defined by RFC 1766.
String
getContentMD5()
Returns the value of the Content-MD5 header field.
protected InputStream
getContentStream()
Returns the unencoded bytes of the content.
String
getContentType()
Returns the value of the RFC 822 Content-Type header field, or "text/plain" if the header is not available.
DataHandler
getDataHandler()
Returns a data handler for accessing this part's content.
String
getDescription()
Returns the Content-Description header field of this part.
String
getDisposition()
Returns the value of the RFC 822 Content-Disposition header field, or null if the header is not available.
String
getEncoding()
Returns the value of the Content-Transfer-Encoding header field.
String
getFileName()
Returns the filename associated with this body part.
String[]
getHeader(String name)
Returns all the values for the specified header name.
String
getHeader(String name, String delimiter)
Returns all the values for the specified header name as a single string, with headers separated by the given delimiter.
InputStream
getInputStream()
Returns a decoded input stream for this part's content.
int
getLineCount()
Returns the number of lines in the content of this body part, or -1 if this number cannot be determined.
Enumeration
getMatchingHeaderLines(String[] names)
Returns all the header-lines with any of the given names.
Enumeration
getMatchingHeaders(String[] names)
Returns all the headers with any of the given names.
Enumeration
getNonMatchingHeaderLines(String[] names)
Returns all the header-lines without any of the given names.
Enumeration
getNonMatchingHeaders(String[] names)
Returns all the headers without any of the given names.
InputStream
getRawInputStream()
Returns the unencoded bytes of the content without applying any content transfer decoding.
int
getSize()
Returns the size of the content of this body part in bytes, or -1 if the size cannot be determined.
boolean
isMimeType(String mimeType)
Indicates whether this part is of the specified MIME type.
void
removeHeader(String name)
Removes all headers with the specified name.
void
saveFile(File file)
Saves the content of this part to the specified file.
void
saveFile(String file)
Saves the content of this part to the specified file.
void
setContent(Object o, String type)
Sets the content of this part using the specified Java object and MIME type.
void
setContent(Multipart mp)
Sets the content of this part to be the specified multipart.
void
setContentID(String cid)
Sets the Content-ID header field of this part.
void
setContentLanguage(String[] languages)
Sets the Content-Language header of this part.
void
setContentMD5(String md5)
Sets the Content-MD5 header field of this part.
void
setDataHandler(DataHandler dh)
Sets the content of this part using the specified data handler.
void
setDescription(String description)
Sets the Content-Description header field for this part.
void
setDescription(String description, String charset)
Sets the Content-Description header field for this part.
void
setDisposition(String disposition)
Sets the Content-Disposition header field of this part.
void
setFileName(String filename)
Sets the filename associated with this body part.
void
setHeader(String name, String value)
Sets the specified header.
void
setText(String text)
Sets the content of this part using the specified text, and with a MIME type of "text/plain".
void
setText(String text, String charset)
Sets the content of this part using the specified text, and with a MIME type of "text/plain".
void
setText(String text, String charset, String subtype)
Sets the content of this part using the specified text, and with a text MIME type of the specified subtype.
protected void
updateHeaders()
Updates the headers of this part, based on the content.
void
writeTo(OutputStream os)
Writes this body part to the specified stream in RFC 822 format.

Methods inherited from class javax.mail.BodyPart

getParent

Field Details

content

protected byte[] content
The bytes of the content of this part, if the part can be stored in memory.

contentStream

protected InputStream contentStream
A SharedInputStream containing the bytes of this part, if it cannot be stored in memory.

dh

protected DataHandler dh
The data handler managing this part's content.

headers

protected InternetHeaders headers
The headers of this body part.

Constructor Details

MimeBodyPart

public MimeBodyPart()
Constructor for an empty MIME body part.

MimeBodyPart

public MimeBodyPart(InputStream is)
            throws MessagingException
Constructor with an input stream. The stream must be positioned at the start of a valid MIME body part and terminate at the end of that body part: the boundary string must not be included in the stream.
Parameters:
is - the input stream

MimeBodyPart

public MimeBodyPart(InternetHeaders headers,
                    byte[] content)
            throws MessagingException
Constructor with headers and byte content.
Parameters:
headers - the header
content - the byte content of this part

Method Details

addHeader

public void addHeader(String name,
                      String value)
            throws MessagingException
Adds the specified header.
Specified by:
addHeader in interface Part
Parameters:
name - the header name
value - the header value

addHeaderLine

public void addHeaderLine(String line)
            throws MessagingException
Adds an RFC 822 header-line to this part.
Specified by:
addHeaderLine in interface MimePart

attachFile

public void attachFile(File file)
            throws IOException,
                   MessagingException
Use the specified file as the content for this part.
Parameters:
file - the file
Since:
JavaMail 1.4

attachFile

public void attachFile(String file)
            throws IOException,
                   MessagingException
Use the specified file as the content for this part.
Parameters:
file - the file
Since:
JavaMail 1.4

getAllHeaderLines

public Enumeration getAllHeaderLines()
            throws MessagingException
Returns all the header-lines.
Specified by:
getAllHeaderLines in interface MimePart
Returns:
an Enumeration of Strings

getAllHeaders

public Enumeration getAllHeaders()
            throws MessagingException
Returns all the headers.
Specified by:
getAllHeaders in interface Part
Returns:
an Enumeration of Header objects

getContent

public Object getContent()
            throws IOException,
                   MessagingException
Returns this part's content as a Java object.
Specified by:
getContent in interface Part

getContentID

public String getContentID()
            throws MessagingException
Returns the value of the Content-ID header field.
Specified by:
getContentID in interface MimePart

getContentLanguage

public String[] getContentLanguage()
            throws MessagingException
Returns the languages specified in the Content-Language header of this part, as defined by RFC 1766. This method returns null if this header is not available.
Specified by:
getContentLanguage in interface MimePart

getContentMD5

public String getContentMD5()
            throws MessagingException
Returns the value of the Content-MD5 header field.
Specified by:
getContentMD5 in interface MimePart

getContentStream

protected InputStream getContentStream()
            throws MessagingException
Returns the unencoded bytes of the content.

getContentType

public String getContentType()
            throws MessagingException
Returns the value of the RFC 822 Content-Type header field, or "text/plain" if the header is not available.
Specified by:
getContentType in interface Part

getDataHandler

public DataHandler getDataHandler()
            throws MessagingException
Returns a data handler for accessing this part's content.
Specified by:
getDataHandler in interface Part

getDescription

public String getDescription()
            throws MessagingException
Returns the Content-Description header field of this part.

If the Content-Description field is encoded as per RFC 2047, it is decoded and converted into Unicode.

Specified by:
getDescription in interface Part

getDisposition

public String getDisposition()
            throws MessagingException
Returns the value of the RFC 822 Content-Disposition header field, or null if the header is not available.
Specified by:
getDisposition in interface Part

getEncoding

public String getEncoding()
            throws MessagingException
Returns the value of the Content-Transfer-Encoding header field.
Specified by:
getEncoding in interface MimePart

getFileName

public String getFileName()
            throws MessagingException
Returns the filename associated with this body part.

This method returns the value of the "filename" parameter from the Content-Disposition header field. If the latter is not available, it returns the value of the "name" parameter from the Content-Type header field.

Specified by:
getFileName in interface Part

getHeader

public String[] getHeader(String name)
            throws MessagingException
Returns all the values for the specified header name. Note that headers may be encoded as per RFC 2047 if they contain non-US-ASCII characters: these should be decoded.
Specified by:
getHeader in interface Part
Parameters:
name - the header name

getHeader

public String getHeader(String name,
                        String delimiter)
            throws MessagingException
Returns all the values for the specified header name as a single string, with headers separated by the given delimiter. If the delimiter is null, only the first header is returned.
Specified by:
getHeader in interface MimePart
Parameters:
name - the header name
delimiter - the delimiter

getInputStream

public InputStream getInputStream()
            throws IOException,
                   MessagingException
Returns a decoded input stream for this part's content.
Specified by:
getInputStream in interface Part

getLineCount

public int getLineCount()
            throws MessagingException
Returns the number of lines in the content of this body part, or -1 if this number cannot be determined.

Note that this number may not be an exact measure, but if not -1, it will be suitable for display to the user.

Specified by:
getLineCount in interface Part

getMatchingHeaderLines

public Enumeration getMatchingHeaderLines(String[] names)
            throws MessagingException
Returns all the header-lines with any of the given names.
Specified by:
getMatchingHeaderLines in interface MimePart
Returns:
an Enumeration of Strings

getMatchingHeaders

public Enumeration getMatchingHeaders(String[] names)
            throws MessagingException
Returns all the headers with any of the given names.
Specified by:
getMatchingHeaders in interface Part
Returns:
an Enumeration of Header objects

getNonMatchingHeaderLines

public Enumeration getNonMatchingHeaderLines(String[] names)
            throws MessagingException
Returns all the header-lines without any of the given names.
Specified by:
getNonMatchingHeaderLines in interface MimePart
Returns:
an Enumeration of Strings

getNonMatchingHeaders

public Enumeration getNonMatchingHeaders(String[] names)
            throws MessagingException
Returns all the headers without any of the given names.
Specified by:
getNonMatchingHeaders in interface Part
Returns:
an Enumeration of Header objects

getRawInputStream

public InputStream getRawInputStream()
            throws MessagingException
Returns the unencoded bytes of the content without applying any content transfer decoding.

getSize

public int getSize()
            throws MessagingException
Returns the size of the content of this body part in bytes, or -1 if the size cannot be determined.

Note that this number may not be an exact measure, but if not -1, it will be suitable for display to the user.

Specified by:
getSize in interface Part

isMimeType

public boolean isMimeType(String mimeType)
            throws MessagingException
Indicates whether this part is of the specified MIME type.

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

Specified by:
isMimeType in interface Part

removeHeader

public void removeHeader(String name)
            throws MessagingException
Removes all headers with the specified name.
Specified by:
removeHeader in interface Part
Parameters:
name - the header name

saveFile

public void saveFile(File file)
            throws IOException,
                   MessagingException
Saves the content of this part to the specified file.
Parameters:
file - the file
Since:
JavaMail 1.4

saveFile

public void saveFile(String file)
            throws IOException,
                   MessagingException
Saves the content of this part to the specified file.
Parameters:
file - the file
Since:
JavaMail 1.4

setContent

public void setContent(Object o,
                       String type)
            throws MessagingException
Sets the content of this part using the specified Java object and MIME type. Note that a data content handler for the MIME type must be installed and accept objects of the type given.
Specified by:
setContent in interface Part
Parameters:
o - the content object
type - the MIME type of the object

setContent

public void setContent(Multipart mp)
            throws MessagingException
Sets the content of this part to be the specified multipart.
Specified by:
setContent in interface Part
Parameters:
mp - the multipart content

setContentID

public void setContentID(String cid)
            throws MessagingException
Sets the Content-ID header field of this part.
Since:
JavaMail 1.3

setContentLanguage

public void setContentLanguage(String[] languages)
            throws MessagingException
Sets the Content-Language header of this part.
Specified by:
setContentLanguage in interface MimePart
Parameters:
languages - the array of language tags

setContentMD5

public void setContentMD5(String md5)
            throws MessagingException
Sets the Content-MD5 header field of this part.
Specified by:
setContentMD5 in interface MimePart

setDataHandler

public void setDataHandler(DataHandler dh)
            throws MessagingException
Sets the content of this part using the specified data handler.
Specified by:
setDataHandler in interface Part

setDescription

public void setDescription(String description)
            throws MessagingException
Sets the Content-Description header field for this part.

If description contains non US-ASCII characters, it will be encoded using the platform default charset.

Specified by:
setDescription in interface Part
Parameters:
description - the content description

setDescription

public void setDescription(String description,
                           String charset)
            throws MessagingException
Sets the Content-Description header field for this part.

If description contains non US-ASCII characters, it will be encoded using the specified charset.

Parameters:
description - the content description
charset - the charset used for encoding

setDisposition

public void setDisposition(String disposition)
            throws MessagingException
Sets the Content-Disposition header field of this part.
Specified by:
setDisposition in interface Part

setFileName

public void setFileName(String filename)
            throws MessagingException
Sets the filename associated with this body part.
Specified by:
setFileName in interface Part

setHeader

public void setHeader(String name,
                      String value)
            throws MessagingException
Sets the specified header.
Specified by:
setHeader in interface Part
Parameters:
name - the header name
value - the header value

setText

public void setText(String text)
            throws MessagingException
Sets the content of this part using the specified text, and with a MIME type of "text/plain".

If the text contains non US-ASCII characters, it will be encoded using the platform default charset.

Specified by:
setText in interface MimePart
setText in interface Part
Parameters:
text - the text content

setText

public void setText(String text,
                    String charset)
            throws MessagingException
Sets the content of this part using the specified text, and with a MIME type of "text/plain".

If the text contains non US-ASCII characters, it will be encoded using the specified charset.

Specified by:
setText in interface MimePart
Parameters:
text - the text content
charset - the charset used for any encoding

setText

public void setText(String text,
                    String charset,
                    String subtype)
            throws MessagingException
Sets the content of this part using the specified text, and with a text MIME type of the specified subtype.

If the text contains non US-ASCII characters, it will be encoded using the specified charset.

Specified by:
setText in interface MimePart
Parameters:
text - the text content
charset - the charset used for any encoding
subtype - the MIME text subtype (e.g. "plain", "html")
Since:
JavaMail 1.4

updateHeaders

protected void updateHeaders()
            throws MessagingException
Updates the headers of this part, based on the content.

writeTo

public void writeTo(OutputStream os)
            throws IOException,
                   MessagingException
Writes this body part to the specified stream in RFC 822 format.
Specified by:
writeTo in interface Part

© Copyright 2003, 2004 The Free Software Foundation, All rights reserved