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.
addHeader
public void addHeader(String name,
String value)
throws MessagingException 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.
- addHeader in interface Part
name - the header namevalue - the header value
getAllHeaderLines
public 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.
- getAllHeaderLines in interface MimePart
getAllHeaders
public Enumeration getAllHeaders()
throws MessagingException Return all the headers from this Message as an Enumeration of Header
objects.
- getAllHeaders in interface Part
getContent
public Object getContent()
throws 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();
- getContent in interface Part
getContentID
public 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
getHeader(name) to obtain
the requisite header field.
- getContentID in interface MimePart
getContentLanguage
public String[] getContentLanguage()
throws MessagingException 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.
- getContentLanguage in interface MimePart
getContentMD5
public String getContentMD5()
throws MessagingException 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.
- getContentMD5 in interface MimePart
getContentStream
protected InputStream getContentStream()
throws MessagingException 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()
throws MessagingException 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.
- getContentType in interface Part
- Content-Type of this body part
getDataHandler
public DataHandler getDataHandler()
throws MessagingException Return a DataHandler for this body part's content.
The implementation provided here works just like the the implementation
in MimeMessage.
- getDataHandler in interface Part
getDescription
public String getDescription()
throws MessagingException 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.
- getDescription in interface Part
getDisposition
public 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
getHeader(name) to obtain the
requisite header field.
- getDisposition in interface Part
getEncoding
public 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
getHeader(name) to obtain
the requisite header field.
- getEncoding in interface MimePart
getFileName
public String getFileName()
throws MessagingException 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.
- getFileName in interface Part
getHeader
public String[] getHeader(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.
- getHeader in interface Part
name - name of header
getHeader
public String getHeader(String name,
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.
- getHeader in interface MimePart
name - the name of this headerdelimiter - the delimiter to use
getInputStream
public InputStream getInputStream()
throws 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();
- getInputStream in interface Part
getLineCount
public int getLineCount()
throws MessagingException 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.
- getLineCount in interface Part
- number of lines, or -1 if not known
getMatchingHeaderLines
public Enumeration getMatchingHeaderLines(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.
- getMatchingHeaderLines in interface MimePart
getMatchingHeaders
public Enumeration getMatchingHeaders(String[] names)
throws MessagingException Return matching headers from this Message as an Enumeration of Header
objects.
- getMatchingHeaders in interface Part
getNonMatchingHeaderLines
public Enumeration getNonMatchingHeaderLines(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.
- getNonMatchingHeaderLines in interface MimePart
getNonMatchingHeaders
public Enumeration getNonMatchingHeaders(String[] names)
throws MessagingException Return non-matching headers from this Message as an Enumeration of Header
objects.
- getNonMatchingHeaders in interface Part
getRawInputStream
public InputStream getRawInputStream()
throws MessagingException 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()
throws MessagingException 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.
- getSize in interface Part
- size in bytes, or -1 if not known
isMimeType
public boolean isMimeType(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.
- isMimeType in interface Part
removeHeader
public void removeHeader(String name)
throws MessagingException Remove all headers with this name.
- removeHeader in interface Part
name - the name of this header
setContent
public void setContent(Object o,
String type)
throws MessagingException 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.
- setContent in interface Part
o - the content objecttype - Mime type of the object
setContent
public void setContent(Multipart mp)
throws MessagingException This method sets the body part's content to a Multipart object.
- setContent in interface Part
mp - The multipart object that is the Message's content
setContentID
public void setContentID(String cid)
throws MessagingException Set the "Content-ID" header field of this body part.
If the cid parameter is null, any existing "Content-ID" is
removed.
- JavaMail 1.3
setContentLanguage
public void setContentLanguage(String[] languages)
throws MessagingException Set the Content-Language header of this MimePart.
The Content-Language header is defined by RFC 1766.
- setContentLanguage in interface MimePart
languages - array of language tags
setDataHandler
public void setDataHandler(DataHandler dh)
throws MessagingException This method provides the mechanism to set this body part's content.
The given DataHandler object should wrap the actual content.
- setDataHandler in interface Part
setDescription
public void setDescription(String description)
throws MessagingException 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.
- setDescription in interface Part
description - content description
setDescription
public void setDescription(String description,
String charset)
throws MessagingException 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.
description - content descriptioncharset - Charset for encoding
setDisposition
public void setDisposition(String disposition)
throws MessagingException Set the "Content-Disposition" header field of this body part.
If the disposition is null, any existing "Content-Disposition"
header field is removed.
- setDisposition in interface Part
setFileName
public void setFileName(String filename)
throws MessagingException Set the filename associated with this body part, if possible.
Sets the "filename" parameter of the "Content-Disposition"
header field of this body part.
- setFileName in interface Part
setHeader
public void setHeader(String name,
String value)
throws MessagingException 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.
- setHeader in interface Part
name - the header namevalue - the header value
setText
public void setText(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() version
that takes the
charset parameter.
- setText in interface MimePart
- setText in interface Part
setText
public void setText(String text,
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.
- setText in interface MimePart
updateHeaders
protected void updateHeaders()
throws MessagingException 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:
- 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 the
Message.saveChanges method.
writeTo
public void writeTo(OutputStream os)
throws IOException,
MessagingException Output the body part as an RFC 822 format stream.
- writeTo in interface Part