public final class MimeBodyPart extends Object
MimeMultipart
objects.
MimeBodyPart uses the InternetHeaders
class to parse
and store the headers of that body part.
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.MimeUtility
Modifier and Type | Field and Description |
---|---|
static String |
ATTACHMENT
This part should be presented as an attachment.
|
static String |
INLINE
This part should be presented 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,
int len)
Constructs a MimeBodyPart using the given header and
content bytes.
|
MimeBodyPart(InternetHeaders headers,
byte[] content,
int start,
int len) |
MimeBodyPart(MIMEPart part) |
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
|
FinalArrayList<com.sun.xml.messaging.saaj.packaging.mime.internet.hdr> |
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 MimeBodyPart.
|
String |
getContentMD5()
Return the value of the "Content-MD5" header field.
|
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 MimeBodyPart.
|
MimeMultipart |
getParent()
Return the containing
MimeMultipart object,
or null if not known. |
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 MimeBodyPart 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(MimeMultipart mp)
This method sets the body part's content to a MimeMultipart 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 MimeBodyPart.
|
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)
Set the value for this header_name.
|
void |
setParent(MimeMultipart parent)
Set the parent of this
MimeBodyPart to be the specified
MimeMultipart . |
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.
|
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.
|
public static final String ATTACHMENT
public static final String INLINE
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
- in case of errorpublic MimeBodyPart(InternetHeaders headers, byte[] content, int len)
Used by providers.
headers
- The header of this partcontent
- bytes representing the body of this part.len
- content length.public MimeBodyPart(InternetHeaders headers, byte[] content, int start, int len)
public MimeBodyPart(MIMEPart part)
public MimeMultipart getParent()
MimeMultipart
object,
or null
if not known.public void setParent(MimeMultipart parent)
MimeBodyPart
to be the specified
MimeMultipart
. Normally called by MimeMultipart
's
addBodyPart
method. parent
may be
null
if the MimeBodyPart
is being removed
from its containing MimeMultipart
.parent
- parent partpublic int getSize()
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.
public int getLineCount()
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.
public String getContentType()
This implementation uses getHeader(name)
to obtain the requisite header field.
public boolean isMimeType(String mimeType)
primaryType
and
subType
.
The parameters of the content types are ignored.
For example, this method will return true
when
comparing a MimeBodyPart 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.
mimeType
- stringpublic 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.
MessagingException
- in case of errorheaders
public void setDisposition(String disposition) throws MessagingException
disposition
- valueMessagingException
- in case of errorIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.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.
MessagingException
- in case of errorheaders
public String getContentID()
null
if the field is unavailable or its value is
absent.
This implementation uses getHeader(name)
to obtain the requisite header field.
public void setContentID(String cid)
cid
parameter is null, any existing
"Content-ID" is removed.cid
- content idIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.public String getContentMD5()
null
if this field is unavailable or its value
is absent.
This implementation uses getHeader(name)
to obtain the requisite header field.
public void setContentMD5(String md5)
md5
- content md5 sumIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.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.
MessagingException
- in case of errorpublic void setContentLanguage(String[] languages)
languages
- array of language tagspublic String getDescription()
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.
public 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.
description
- content descriptionIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.MessagingException
- 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 encodingIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.MessagingException
- 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.
MessagingException
- in case of errorpublic void setFileName(String filename) throws MessagingException
Sets the "filename" parameter of the "Content-Disposition" header field of this body part.
filename
- filenameMessagingException
- in case of errorIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.public InputStream getInputStream() throws IOException
This implementation obtains the input stream from the DataHandler. That is, it invokes getDataHandler().getInputStream();
IOException
- this is typically thrown by the
DataHandler. Refer to the documentation for
javax.activation.DataHandler for more details.getContentStream()
,
DataHandler.getInputStream()
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
- in case of errorgetInputStream()
,
getContentStream()
public DataHandler getDataHandler()
The implementation provided here works just like the the implementation in MimeMessage.
public Object getContent() throws IOException
This implementation obtains the content from the DataHandler. That is, it invokes getDataHandler().getContent();
IOException
- this is typically thrown by the
DataHandler. Refer to the documentation for
javax.activation.DataHandler for more details.public void setDataHandler(DataHandler dh)
dh
- The DataHandler for the contentIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.public void setContent(Object o, String type)
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.
o
- the content objecttype
- Mime type of the objectIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.public void setText(String text)
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.
text
- stringsetText(String text, String charset)
public void setText(String text, String charset)
text
- stringcharset
- character setpublic void setContent(MimeMultipart mp)
mp
- The multipart object that is the Message's contentIllegalStateException
- if this body part is
obtained from a READ_ONLY folder.public void writeTo(OutputStream os) throws IOException, MessagingException
os
- output streamMessagingException
- in case of errorIOException
- if an error occurs writing to the
stream or if an error is generated
by the javax.activation layer.DataHandler.writeTo(java.io.OutputStream)
public String[] getHeader(String name)
name
- name of headerMimeUtility
public String getHeader(String name, String delimiter)
null
, only the first header is
returned.name
- the name of this headerdelimiter
- delimiter between fields in returned stringpublic void setHeader(String name, String value)
name
- header namevalue
- header valueMimeUtility
public void addHeader(String name, String value)
name
- header namevalue
- header valueMimeUtility
public void removeHeader(String name)
name
- header namepublic FinalArrayList<com.sun.xml.messaging.saaj.packaging.mime.internet.hdr> getAllHeaders()
public void addHeaderLine(String line)
line
- header line to addprotected void updateHeaders() throws MessagingException
Content-Type
and Content-Transfer-Encoding
.
Headers might need to be updated in two cases:
Message.saveChanges
method.MessagingException
- in case of error.Copyright © 2020 JBoss by Red Hat. All rights reserved.