|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.mail.BodyPart | +--javax.mail.internet.MimeBodyPart
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.
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.
Part
,
MimePart
,
MimeUtility
Field Summary | |
protected byte[] |
content
Byte array that holds the bytes of the content of this Part. |
protected javax.activation.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. |
Fields inherited from class javax.mail.BodyPart |
parent |
Constructor Summary | |
MimeBodyPart()
An empty MimeBodyPart object is created. |
|
MimeBodyPart(java.io.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(java.lang.String name,
java.lang.String value)
Add this value to the existing values for this header_name. |
void |
addHeaderLine(java.lang.String line)
Add a header line to this body part |
java.util.Enumeration |
getAllHeaderLines()
Get all header lines as an Enumeration of Strings. |
java.util.Enumeration |
getAllHeaders()
Return all the headers from this Message as an Enumeration of Header objects. |
java.lang.Object |
getContent()
Return the content as a java object. |
java.lang.String |
getContentID()
Returns the value of the "Content-ID" header field. |
java.lang.String[] |
getContentLanguage()
Get the languages specified in the Content-Language header of this MimePart. |
java.lang.String |
getContentMD5()
Return the value of the "Content-MD5" header field. |
protected java.io.InputStream |
getContentStream()
Produce the raw bytes of the content. |
java.lang.String |
getContentType()
Returns the value of the RFC 822 "Content-Type" header field. |
javax.activation.DataHandler |
getDataHandler()
Return a DataHandler for this body part's content. |
java.lang.String |
getDescription()
Returns the "Content-Description" header field of this body part. |
java.lang.String |
getDisposition()
Returns the value of the "Content-Disposition" header field. |
java.lang.String |
getEncoding()
Returns the value of the "Content-Transfer-Encoding" header field. |
java.lang.String |
getFileName()
Get the filename associated with this body part. |
java.lang.String[] |
getHeader(java.lang.String name)
Get all the headers for this header_name. |
java.lang.String |
getHeader(java.lang.String name,
java.lang.String delimiter)
Get all the headers for this header name, returned as a single String, with headers separated by the delimiter. |
java.io.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. |
java.util.Enumeration |
getMatchingHeaderLines(java.lang.String[] names)
Get matching header lines as an Enumeration of Strings. |
java.util.Enumeration |
getMatchingHeaders(java.lang.String[] names)
Return matching headers from this Message as an Enumeration of Header objects. |
java.util.Enumeration |
getNonMatchingHeaderLines(java.lang.String[] names)
Get non-matching header lines as an Enumeration of Strings. |
java.util.Enumeration |
getNonMatchingHeaders(java.lang.String[] names)
Return non-matching headers from this Message as an Enumeration of Header objects. |
int |
getSize()
Return the size of the content of this body part in bytes. |
boolean |
isMimeType(java.lang.String mimeType)
Is this Part of the specified MIME type? This method compares only the primaryType and
subType . |
void |
removeHeader(java.lang.String name)
Remove all headers with this name. |
void |
setContent(Multipart mp)
This method sets the body part's content to a Multipart object. |
void |
setContent(java.lang.Object o,
java.lang.String type)
A convenience method for setting this body part's content. |
void |
setContentLanguage(java.lang.String[] languages)
Set the Content-Language header of this MimePart. |
void |
setContentMD5(java.lang.String md5)
Set the "Content-MD5" header field of this body part. |
void |
setDataHandler(javax.activation.DataHandler dh)
This method provides the mechanism to set this body part's content. |
void |
setDescription(java.lang.String description)
Set the "Content-Description" header field for this body part. |
void |
setDescription(java.lang.String description,
java.lang.String charset)
Set the "Content-Description" header field for this body part. |
void |
setDisposition(java.lang.String disposition)
Set the "Content-Disposition" header field of this body part. |
void |
setFileName(java.lang.String filename)
Set the filename associated with this body part, if possible. |
void |
setHeader(java.lang.String name,
java.lang.String value)
Set the value for this header_name. |
void |
setText(java.lang.String text)
Convenience method that sets the given String as this part's content, with a MIME type of "text/plain". |
void |
setText(java.lang.String text,
java.lang.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(java.io.OutputStream os)
Output the body part as an RFC 822 format stream. |
Methods inherited from class javax.mail.BodyPart |
getParent |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
protected javax.activation.DataHandler dh
protected byte[] content
protected InternetHeaders headers
Constructor Detail |
public MimeBodyPart()
public MimeBodyPart(java.io.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 Streampublic MimeBodyPart(InternetHeaders headers, byte[] content) throws MessagingException
Used by providers.
headers
- The header of this partcontent
- bytes representing the body of this part.Method Detail |
public 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 -1;
public 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;
public java.lang.String getContentType() throws MessagingException
This implementation uses getHeader(name)
to obtain the requisite header field.
public boolean isMimeType(java.lang.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.
public java.lang.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.
headers
public void setDisposition(java.lang.String disposition) throws MessagingException
public java.lang.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.
headers
public java.lang.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.
public java.lang.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.
public void setContentMD5(java.lang.String md5) throws MessagingException
public java.lang.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.
public void setContentLanguage(java.lang.String[] languages) throws MessagingException
languages
- array of language tagspublic java.lang.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.
public void setDescription(java.lang.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 descriptionpublic void setDescription(java.lang.String description, java.lang.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 encodingpublic java.lang.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.
public void setFileName(java.lang.String filename) throws MessagingException
Sets the "filename" parameter of the "Content-Disposition" header field of this body part.
public java.io.InputStream getInputStream() throws java.io.IOException, MessagingException
This implementation obtains the input stream from the DataHandler. That is, it invokes getDataHandler().getInputStream();
getContentStream()
,
DataHandler.getInputStream()
protected java.io.InputStream getContentStream() throws MessagingException
content
,
MimeMessage.getContentStream()
public javax.activation.DataHandler getDataHandler() throws MessagingException
The implementation provided here works just like the the implementation in MimeMessage.
MimeMessage.getDataHandler()
public java.lang.Object getContent() throws java.io.IOException, MessagingException
This implementation obtains the content from the DataHandler. That is, it invokes getDataHandler().getContent();
public void setDataHandler(javax.activation.DataHandler dh) throws MessagingException
dh
- The DataHandler for the contentpublic void setContent(java.lang.Object o, java.lang.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 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 objectpublic void setText(java.lang.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() version that takes the charset parameter.
setText(String text, String charset)
public void setText(java.lang.String text, java.lang.String charset) throws MessagingException
public void setContent(Multipart mp) throws MessagingException
mp
- The multipart object that is the Message's contentpublic void writeTo(java.io.OutputStream os) throws java.io.IOException, MessagingException
DataHandler.writeTo(java.io.OutputStream)
public java.lang.String[] getHeader(java.lang.String name) throws MessagingException
name
- name of headerMimeUtility
public java.lang.String getHeader(java.lang.String name, java.lang.String delimiter) throws MessagingException
null
, only the first header is
returned.header_name
- the name of this headerpublic void setHeader(java.lang.String name, java.lang.String value) throws MessagingException
name
- header namevalue
- header valueMimeUtility
public void addHeader(java.lang.String name, java.lang.String value) throws MessagingException
name
- header namevalue
- header valueMimeUtility
public void removeHeader(java.lang.String name) throws MessagingException
public java.util.Enumeration getAllHeaders() throws MessagingException
public java.util.Enumeration getMatchingHeaders(java.lang.String[] names) throws MessagingException
public java.util.Enumeration getNonMatchingHeaders(java.lang.String[] names) throws MessagingException
public void addHeaderLine(java.lang.String line) throws MessagingException
public java.util.Enumeration getAllHeaderLines() throws MessagingException
public java.util.Enumeration getMatchingHeaderLines(java.lang.String[] names) throws MessagingException
public java.util.Enumeration getNonMatchingHeaderLines(java.lang.String[] names) throws MessagingException
protected void updateHeaders() throws MessagingException
Content-Type
and Content-Transfer-Encoding
.
Headers might need to be updated in two cases:
Message.saveChanges
method.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |