public class MimeBodyPart extends BodyPart implements MimePart
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.
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.
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.
Part
,
MimePart
,
MimeUtility
Modifier and Type | Field and Description |
---|---|
protected Object |
cachedContent
If our content is a Multipart of Message object, we save it
the first time it's created by parsing a stream so that changes
to the contained objects will not be lost.
|
protected byte[] |
content
Byte array that holds the bytes of the content of this Part.
|
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. |
protected DataHandler |
dh
The DataHandler object representing this Part's content.
|
protected InternetHeaders |
headers
The InternetHeaders object that stores all the headers
of this body part.
|
ATTACHMENT, INLINE
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
void |
addHeader(String name,
String value)
Add this value to the existing values for this header_name.
|
void |
addHeaderLine(String line)
Add a header line to this body part
|
void |
attachFile(File file)
Use the specified file to provide the data for this part.
|
void |
attachFile(File file,
String contentType,
String encoding)
Use the specified file with the specified Content-Type and
Content-Transfer-Encoding to provide the data for this part.
|
void |
attachFile(String file)
Use the specified file to provide the data for this part.
|
void |
attachFile(String file,
String contentType,
String encoding)
Use the specified file with the specified Content-Type and
Content-Transfer-Encoding to provide the data for this part.
|
Enumeration<String> |
getAllHeaderLines()
Get all header lines as an Enumeration of Strings.
|
Enumeration<Header> |
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()
Return the value of the "Content-MD5" header field.
|
protected 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 disposition from 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<String> |
getMatchingHeaderLines(String[] names)
Get matching header lines as an Enumeration of Strings.
|
Enumeration<Header> |
getMatchingHeaders(String[] names)
Return matching headers from this Message as an Enumeration of
Header objects.
|
Enumeration<String> |
getNonMatchingHeaderLines(String[] names)
Get non-matching header lines as an Enumeration of Strings.
|
Enumeration<Header> |
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 |
saveFile(File file)
Save the contents of this part in the specified file.
|
void |
saveFile(String file)
Save the contents of this part in the specified file.
|
void |
setContent(Multipart mp)
This method sets the body part's content to a Multipart object.
|
void |
setContent(Object o,
String type)
A convenience method for setting this body part's content.
|
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 disposition in 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)
Set the value for this header_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 |
setText(String text,
String charset,
String subtype)
Convenience method that sets the given String as this part's
content, with a primary MIME type of "text" and the specified
MIME subtype.
|
protected 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.
|
protected DataHandler dh
protected byte[] content
protected InputStream contentStream
contentStream
is another such stream representing
the content of this body part. In this case, content
will be null.protected InternetHeaders headers
protected Object cachedContent
getContent()
method. The getContent()
method sets this field if it
would return a Multipart or MimeMessage object. This field is
is cleared by the setDataHandler(javax.activation.DataHandler)
method.public MimeBodyPart()
public MimeBodyPart(InputStream is) throws MessagingException
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.
is
- the body part Input StreamMessagingException
- for failurespublic MimeBodyPart(InternetHeaders headers, byte[] content) throws MessagingException
Used by providers.
headers
- The header of this partcontent
- bytes representing the body of this part.MessagingException
- for failurespublic int getSize() throws MessagingException
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
MessagingException
- for failurespublic int getLineCount() throws MessagingException
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
MessagingException
- for failurespublic String getContentType() throws MessagingException
This implementation uses getHeader(name)
to obtain the requisite header field.
getContentType
in interface Part
MessagingException
- for failuresDataHandler
public boolean isMimeType(String mimeType) throws MessagingException
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
mimeType
- the MIME type to testMessagingException
- for failurespublic String getDisposition() throws MessagingException
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
MessagingException
- for failuresheaders
public void setDisposition(String disposition) throws MessagingException
setDisposition
in interface Part
disposition
- disposition of this partIllegalWriteException
- if the underlying
implementation does not support modificationIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.MessagingException
- for other failuresPart.ATTACHMENT
,
Part.INLINE
,
Part.setFileName(java.lang.String)
public String getEncoding() throws MessagingException
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
MessagingException
- for failuresheaders
public String getContentID() throws MessagingException
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
MessagingException
- for failurespublic void setContentID(String cid) throws MessagingException
cid
parameter is null, any existing
"Content-ID" is removed.cid
- the Content-IDIllegalWriteException
- if the underlying
implementation does not support modificationIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.MessagingException
- for other failurespublic String getContentMD5() throws MessagingException
null
if this field is unavailable or its value
is absent.
This implementation uses getHeader(name)
to obtain the requisite header field.
getContentMD5
in interface MimePart
MessagingException
- for failurespublic void setContentMD5(String md5) throws MessagingException
setContentMD5
in interface MimePart
md5
- the MD5 valueIllegalWriteException
- if the underlying
implementation does not support modificationIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.MessagingException
public String[] getContentLanguage() throws MessagingException
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
MessagingException
- for failurespublic void setContentLanguage(String[] languages) throws MessagingException
setContentLanguage
in interface MimePart
languages
- array of language tagsIllegalWriteException
- if the underlying
implementation does not support modificationMessagingException
public String getDescription() throws MessagingException
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
MessagingException
- for failurespublic void setDescription(String description) throws MessagingException
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 descriptionIllegalWriteException
- if the underlying
implementation does not support modificationIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.MessagingException
- otherwise; an
UnsupportedEncodingException may be included
in the exception chain if the charset
conversion fails.public void setDescription(String description, String charset) throws MessagingException
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
- Descriptioncharset
- Charset for encodingIllegalWriteException
- if the underlying
implementation does not support modificationIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.MessagingException
- otherwise; an
UnsupportedEncodingException may be included
in the exception chain if the charset
conversion fails.public String getFileName() throws MessagingException
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.
Returns null
if both are absent.
If the mail.mime.decodefilename
System property
is set to true, the MimeUtility.decodeText
method will be used to decode the
filename. While such encoding is not supported by the MIME
spec, many mailers use this technique to support non-ASCII
characters in filenames. The default value of this property
is false.
getFileName
in interface Part
MessagingException
- for failurespublic void setFileName(String filename) throws MessagingException
Sets the "filename" parameter of the "Content-Disposition" header field of this body part. For compatibility with older mailers, the "name" parameter of the "Content-Type" header is also set.
If the mail.mime.encodefilename
System property
is set to true, the MimeUtility.encodeText
method will be used to encode the
filename. While such encoding is not supported by the MIME
spec, many mailers use this technique to support non-ASCII
characters in filenames. The default value of this property
is false.
setFileName
in interface Part
filename
- the file nameIllegalWriteException
- if the underlying
implementation does not support modificationIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.MessagingException
- for other failurespublic InputStream getInputStream() throws IOException, MessagingException
This implementation obtains the input stream from the DataHandler. That is, it invokes getDataHandler().getInputStream();
getInputStream
in interface Part
IOException
- this is typically thrown by the
DataHandler. Refer to the documentation for
javax.activation.DataHandler for more details.MessagingException
- for other failuresgetContentStream()
,
DataHandler.getInputStream()
protected InputStream getContentStream() throws MessagingException
MessagingException
- for failurescontent
,
MimeMessage.getContentStream()
public InputStream getRawInputStream() throws MessagingException
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.
MessagingException
- for failuresgetInputStream()
,
getContentStream()
public DataHandler getDataHandler() throws MessagingException
The implementation provided here works just like the the implementation in MimeMessage.
getDataHandler
in interface Part
MessagingException
- for failuresMimeMessage.getDataHandler()
public Object getContent() throws IOException, MessagingException
This implementation obtains the content from the DataHandler. That is, it invokes getDataHandler().getContent(); If the content is a Multipart or Message object and was created by parsing a stream, the object is cached and returned in subsequent calls so that modifications to the content will not be lost.
getContent
in interface Part
IOException
- this is typically thrown by the
DataHandler. Refer to the documentation for
javax.activation.DataHandler for more details.MessagingException
- for other failuresDataHandler.getContent()
public void setDataHandler(DataHandler dh) throws MessagingException
setDataHandler
in interface Part
dh
- The DataHandler for the contentIllegalWriteException
- if the underlying
implementation does not support modificationIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.MessagingException
- for other failurespublic void setContent(Object o, String type) throws MessagingException
The content is wrapped in a DataHandler object. Note that a
DataContentHandler class for the specified type should be
available to the Jakarta Mail 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 objectIllegalWriteException
- if the underlying
implementation does not support modification of
existing valuesIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.MessagingException
- for other failurespublic void setText(String text) throws MessagingException
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.
setText
in interface MimePart
setText
in interface Part
text
- the text content to setMessagingException
- if an error occurssetText(String text, String charset)
public void setText(String text, String charset) throws MessagingException
setText
in interface MimePart
text
- the text content to setcharset
- the charset to use for the textMessagingException
- if an error occurspublic void setText(String text, String charset, String subtype) throws MessagingException
setText
in interface MimePart
text
- the text content to setcharset
- the charset to use for the textsubtype
- the MIME subtype to use (e.g., "html")MessagingException
- if an error occurspublic void setContent(Multipart mp) throws MessagingException
setContent
in interface Part
mp
- The multipart object that is the Message's contentIllegalWriteException
- if the underlying
implementation does not support modification of
existing values.IllegalStateException
- if this body part is
obtained from a READ_ONLY folder.MessagingException
- for other failurespublic void attachFile(File file) throws IOException, MessagingException
Part.ATTACHMENT
.file
- the File object to attachIOException
- errors related to accessing the fileMessagingException
- message related errorspublic void attachFile(String file) throws IOException, MessagingException
file
- the name of the file to attachIOException
- errors related to accessing the fileMessagingException
- message related errorspublic void attachFile(File file, String contentType, String encoding) throws IOException, MessagingException
Part.ATTACHMENT
.file
- the File object to attachcontentType
- the Content-Type, or nullencoding
- the Content-Transfer-Encoding, or nullIOException
- errors related to accessing the fileMessagingException
- message related errorspublic void attachFile(String file, String contentType, String encoding) throws IOException, MessagingException
Part.ATTACHMENT
.file
- the name of the filecontentType
- the Content-Type, or nullencoding
- the Content-Transfer-Encoding, or nullIOException
- errors related to accessing the fileMessagingException
- message related errorspublic void saveFile(File file) throws IOException, MessagingException
file
- the File object to write toIOException
- errors related to accessing the fileMessagingException
- message related errorspublic void saveFile(String file) throws IOException, MessagingException
file
- the name of the file to write toIOException
- errors related to accessing the fileMessagingException
- message related errorspublic void writeTo(OutputStream os) throws IOException, MessagingException
writeTo
in interface Part
os
- the stream to write toIOException
- if an error occurs writing to the
stream or if an error is generated
by the javax.activation layer.MessagingException
- for other failuresDataHandler.writeTo(java.io.OutputStream)
public String[] getHeader(String name) throws MessagingException
getHeader
in interface Part
name
- name of headerMessagingException
- for failuresMimeUtility
public String getHeader(String name, String delimiter) throws MessagingException
null
, only the first header is
returned.getHeader
in interface MimePart
name
- the name of this headerdelimiter
- delimiter between fields in returned stringMessagingException
- for failurespublic void setHeader(String name, String value) throws MessagingException
setHeader
in interface Part
name
- header namevalue
- header valueIllegalWriteException
- if the underlying
implementation does not support modification
of existing valuesMessagingException
- for other failuresMimeUtility
public void addHeader(String name, String value) throws MessagingException
addHeader
in interface Part
name
- header namevalue
- header valueIllegalWriteException
- if the underlying
implementation does not support modification
of existing valuesMessagingException
- for other failuresMimeUtility
public void removeHeader(String name) throws MessagingException
removeHeader
in interface Part
name
- the name of this headerIllegalWriteException
- if the underlying
implementation does not support modification
of existing valuesMessagingException
- for other failurespublic Enumeration<Header> getAllHeaders() throws MessagingException
getAllHeaders
in interface Part
MessagingException
- for failurespublic Enumeration<Header> getMatchingHeaders(String[] names) throws MessagingException
getMatchingHeaders
in interface Part
names
- the headers to matchMessagingException
- for failurespublic Enumeration<Header> getNonMatchingHeaders(String[] names) throws MessagingException
getNonMatchingHeaders
in interface Part
names
- the headers to not matchMessagingException
- for failurespublic void addHeaderLine(String line) throws MessagingException
addHeaderLine
in interface MimePart
line
- the line to addIllegalWriteException
- if the underlying
implementation does not support modificationMessagingException
- for other failurespublic Enumeration<String> getAllHeaderLines() throws MessagingException
getAllHeaderLines
in interface MimePart
MessagingException
- for failurespublic Enumeration<String> getMatchingHeaderLines(String[] names) throws MessagingException
getMatchingHeaderLines
in interface MimePart
names
- the headers to returnMessagingException
- for failurespublic Enumeration<String> getNonMatchingHeaderLines(String[] names) throws MessagingException
getNonMatchingHeaderLines
in interface MimePart
names
- the headers to not returnMessagingException
- for failuresprotected void updateHeaders() throws MessagingException
Content-Type
and Content-Transfer-Encoding
.
Headers might need to be updated in two cases:
Message.saveChanges
method.
If the cachedContent
field is not null (that is,
it references a Multipart or Message object), then
that object is used to set a new DataHandler, any
stream data used to create this object is discarded,
and the cachedContent
field is cleared.
MessagingException
- for failuresCopyright © 2019 Eclipse Foundation. Use is subject to license terms.