|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.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.
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
Field Summary | |
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. |
Fields inherited from class javax.mail.BodyPart |
parent |
Fields inherited from interface javax.mail.Part |
ATTACHMENT, INLINE |
Constructor Summary | |
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. |
Method Summary | |
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 |
Enumeration |
getAllHeaderLines()
Get all header lines as an Enumeration of Strings. |
Enumeration |
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 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 Part. |
Enumeration |
getMatchingHeaderLines(String[] names)
Get matching header lines as an Enumeration of Strings. |
Enumeration |
getMatchingHeaders(String[] names)
Return matching headers from this Message as an Enumeration of Header objects. |
Enumeration |
getNonMatchingHeaderLines(String[] names)
Get non-matching header lines as an Enumeration of Strings. |
Enumeration |
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? |
void |
removeHeader(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(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 "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. |
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. |
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 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
Constructor Detail |
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 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 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.
MessagingException
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.
getLineCount
in interface Part
MessagingException
public String getContentType() throws MessagingException
This implementation uses getHeader(name)
to obtain the requisite header field.
getContentType
in interface Part
MessagingException
DataHandler
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
MessagingException
public 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
headers
public void setDisposition(String disposition) throws MessagingException
setDisposition
in interface Part
disposition
- disposition of this part
IllegalWriteException
- if the underlying
implementation does not support modification
IllegalStateException
- if this body part is
obtained from a READ_ONLY folder.
MessagingException
Part.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
headers
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
public void setContentID(String cid) throws MessagingException
cid
parameter is null, any existing
"Content-ID" is removed.
IllegalWriteException
- if the underlying
implementation does not support modification
IllegalStateException
- if this body part is
obtained from a READ_ONLY folder.
MessagingException
public 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
public void setContentMD5(String md5) throws MessagingException
setContentMD5
in interface MimePart
md5
- the MD5 value
IllegalWriteException
- if the underlying
implementation does not support modification
IllegalStateException
- 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
public void setContentLanguage(String[] languages) throws MessagingException
setContentLanguage
in interface MimePart
languages
- array of language tags
MessagingException
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
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.
setDescription
in interface Part
description
- content description
IllegalWriteException
- if the underlying
implementation does not support modification
IllegalStateException
- 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 encoding
IllegalWriteException
- if the underlying
implementation does not support modification
IllegalStateException
- 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.
getFileName
in interface Part
MessagingException
public void setFileName(String filename) throws MessagingException
Sets the "filename" parameter of the "Content-Disposition" header field of this body part.
setFileName
in interface Part
filename
- Filename to associate with this part
IllegalWriteException
- if the underlying
implementation does not support modification
IllegalStateException
- if this body part is
obtained from a READ_ONLY folder.
MessagingException
public InputStream getInputStream() throws IOException, MessagingException
This implementation obtains the input stream from the DataHandler. That is, it invokes getDataHandler().getInputStream();
getInputStream
in interface Part
MessagingException
IOException
- this is typically thrown by the
DataHandler. Refer to the documentation for
javax.activation.DataHandler for more details.getContentStream()
,
DataHandler.getInputStream()
protected InputStream getContentStream() throws MessagingException
MessagingException
content
,
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
getInputStream()
,
getContentStream()
public DataHandler getDataHandler() throws MessagingException
The implementation provided here works just like the the implementation in MimeMessage.
getDataHandler
in interface Part
MessagingException
MimeMessage.getDataHandler()
public Object getContent() throws IOException, MessagingException
This implementation obtains the content from the DataHandler. That is, it invokes getDataHandler().getContent();
getContent
in interface Part
MessagingException
IOException
- this is typically thrown by the
DataHandler. Refer to the documentation for
javax.activation.DataHandler for more details.DataHandler.getContent()
public void setDataHandler(DataHandler dh) throws MessagingException
setDataHandler
in interface Part
dh
- The DataHandler for the content
IllegalWriteException
- if the underlying
implementation does not support modification
IllegalStateException
- if this body part is
obtained from a READ_ONLY folder.
MessagingException
public 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 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
IllegalWriteException
- if the underlying
implementation does not support modification of
existing values
IllegalStateException
- if this body part is
obtained from a READ_ONLY folder.
MessagingException
public 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() version that takes the charset parameter.
MessagingException
setText(String text, String charset)
public void setText(String text, String charset) throws MessagingException
MessagingException
public void setContent(Multipart mp) throws MessagingException
setContent
in interface Part
mp
- The multipart object that is the Message's content
IllegalWriteException
- if the underlying
implementation does not support modification of
existing values.
IllegalStateException
- if this body part is
obtained from a READ_ONLY folder.
MessagingException
public void writeTo(OutputStream os) throws IOException, MessagingException
MessagingException
IOException
- 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) throws MessagingException
name
- name of header
MessagingException
MimeUtility
public String getHeader(String name, String delimiter) throws MessagingException
null
, only the first header is
returned.
name
- the name of this headerdelimiter
- delimiter between fields in returned string
MessagingException
public void setHeader(String name, String value) throws MessagingException
name
- header namevalue
- header value
MessagingException
MimeUtility
public void addHeader(String name, String value) throws MessagingException
name
- header namevalue
- header value
MessagingException
MimeUtility
public void removeHeader(String name) throws MessagingException
removeHeader
in interface Part
name
- the name of this header
MessagingException
public Enumeration getAllHeaders() throws MessagingException
getAllHeaders
in interface Part
MessagingException
public Enumeration getMatchingHeaders(String[] names) throws MessagingException
getMatchingHeaders
in interface Part
MessagingException
public Enumeration getNonMatchingHeaders(String[] names) throws MessagingException
getNonMatchingHeaders
in interface Part
MessagingException
public void addHeaderLine(String line) throws MessagingException
addHeaderLine
in interface MimePart
MessagingException
public Enumeration getAllHeaderLines() throws MessagingException
getAllHeaderLines
in interface MimePart
MessagingException
public Enumeration getMatchingHeaderLines(String[] names) throws MessagingException
getMatchingHeaderLines
in interface MimePart
MessagingException
public Enumeration getNonMatchingHeaderLines(String[] names) throws MessagingException
getNonMatchingHeaderLines
in interface MimePart
MessagingException
protected void updateHeaders() throws MessagingException
Content-Type
and Content-Transfer-Encoding
.
Headers might need to be updated in two cases:
Message.saveChanges
method.
MessagingException
|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2003 Sun Microsystems, Inc. All rights reserved.