| com.google.code.javax.mail.Part |
Known Indirect Subclasses
|
The Part interface is the common base interface for
Messages and BodyParts.
Part consists of a set of attributes and a "Content".
Attributes:
The JavaMail API defines a set of standard Part attributes that are considered to be common to most existing Mail systems. These attributes have their own settor and gettor methods. Mail systems may support other Part attributes as well, these are represented as name-value pairs where both the name and value are Strings.
Content:
The data type of the "content" is returned by
the getContentType() method. The MIME typing system
is used to name data types.
The "content" of a Part is available in various formats:
getDataHandler() method.
The "content" of a Part is also available through a
javax.activation.DataHandler object. The DataHandler
object allows clients to discover the operations available on the
content, and to instantiate the appropriate component to perform
those operations.
getInputStream() method.
Any mail-specific encodings are decoded before this stream is returned.
getContent() method.
This method returns the "content" as a Java object.
The returned object is of course dependent on the content
itself. In particular, a "multipart" Part's content is always a
Multipart or subclass thereof. That is, getContent() on a
"multipart" type Part will always return a Multipart (or subclass) object.
writeTo() method that streams
out its bytestream in mail-safe form suitable for transmission.
This bytestream is typically an aggregation of the Part attributes
and its content's bytestream. Message and BodyPart implement the Part interface. Note that in MIME parlance, Part models an Entity (RFC 2045, Section 2.4).
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | ATTACHMENT | This part should be presented as an attachment. | |||||||||
| String | INLINE | This part should be presented inline. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Add this value to the existing values for this header_name.
| |||||||||||
Return all the headers from this part as an Enumeration of
Header objects.
| |||||||||||
Return the content as a Java object.
| |||||||||||
Returns the Content-Type of the content of this part.
| |||||||||||
Return a DataHandler for the content within this part.
| |||||||||||
Return a description String for this part.
| |||||||||||
Return the disposition of this part.
| |||||||||||
Get the filename associated with this part, if possible.
| |||||||||||
Get all the headers for this header name.
| |||||||||||
Return an input stream for this part's "content".
| |||||||||||
Return the number of lines in the content of this part.
| |||||||||||
Return matching headers from this part as an Enumeration of
Header objects.
| |||||||||||
Return non-matching headers from this envelope as an Enumeration
of Header objects.
| |||||||||||
Return the size of the content of this part in bytes.
| |||||||||||
Is this Part of the specified MIME type? This method
compares only the
primaryType and
subType. | |||||||||||
Remove all headers with this name.
| |||||||||||
A convenience method for setting this part's content.
| |||||||||||
This method sets the given Multipart object as this message's
content.
| |||||||||||
This method provides the mechanism to set this part's content.
| |||||||||||
Set a description String for this part.
| |||||||||||
Set the disposition of this part.
| |||||||||||
Set the filename associated with this part, if possible.
| |||||||||||
Set the value for this header_name.
| |||||||||||
A convenience method that sets the given String as this
part's content with a MIME type of "text/plain".
| |||||||||||
Output a bytestream for this Part.
| |||||||||||
This part should be presented as an attachment.
This part should be presented inline.
Add this value to the existing values for this header_name.
| header_name | The name of this header |
|---|---|
| header_value | The value for this header |
| IllegalWriteException | if the underlying implementation does not support modification of existing values |
|---|---|
| IllegalStateException | if this Part is obtained from a READ_ONLY folder |
| MessagingException |
Return all the headers from this part as an Enumeration of Header objects.
| MessagingException |
|---|
Return the content as a Java object. The type of the returned object is of course dependent on the content itself. For example, the object returned for "text/plain" content is usually a String object. The object returned 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 is a convenience method that just invokes the DataHandler's getContent() method
| IOException | this is typically thrown by the DataHandler. Refer to the documentation for javax.activation.DataHandler for more details. |
|---|---|
| MessagingException |
Returns the Content-Type of the content of this part. Returns null if the Content-Type could not be determined.
The MIME typing system is used to name Content-types.
| MessagingException |
|---|
Return a DataHandler for the content within this part. The DataHandler allows clients to operate on as well as retrieve the content.
| MessagingException |
|---|
Return a description String for this part. This typically associates some descriptive information with this part. Returns null if none is available.
| MessagingException |
|---|
Return the disposition of this part. The disposition describes how the part should be presented to the user. (See RFC 2183.) The return value should be considered without regard to case. For example:
String disp = part.getDisposition(); if (disp == null || disp.equalsIgnoreCase(Part.ATTACHMENT)) // treat as attachment if not first part
| MessagingException |
|---|
Get the filename associated with this part, if possible. Useful if this part represents an "attachment" that was loaded from a file. The filename will usually be a simple name, not including directory components.
| MessagingException |
|---|
Get all the headers for this header name. Returns null
if no headers for this header name are available.
| header_name | The name of this header |
|---|
| MessagingException |
|---|
Return an input stream for this part's "content". Any mail-specific transfer encodings will be decoded before the input stream is provided.
This is typically a convenience method that just invokes
the DataHandler's getInputStream() method.
| IOException | this is typically thrown by the DataHandler. Refer to the documentation for javax.activation.DataHandler for more details. |
|---|---|
| MessagingException |
Return the number of lines in the content of this part. Return -1 if the 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.
| MessagingException |
|---|
Return matching headers from this part as an Enumeration of Header objects.
| header_names |
|---|
| MessagingException |
|---|
Return non-matching headers from this envelope as an Enumeration of Header objects.
| header_names |
|---|
| MessagingException |
|---|
Return the size of the content of this part in bytes. Return -1 if the size cannot be determined.
Note that the size may not be an exact measure of the content size and may or may not account for any transfer encoding of the content. The size is appropriate for display in a user interface to give the user a rough idea of the size of this part.
| 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.
| mimeType |
|---|
| MessagingException |
|---|
Remove all headers with this name.
| header_name | The name of this header |
|---|
| IllegalWriteException | if the underlying implementation does not support modification of existing values |
|---|---|
| IllegalStateException | if this Part is obtained from a READ_ONLY folder |
| MessagingException |
A convenience method for setting this part's content. The part internally wraps the content in a DataHandler.
Note that a DataContentHandler class for the specified type should
be available to the JavaMail implementation for this to work right.
i.e., 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.
| obj | A java object. |
|---|---|
| type | MIME type of this object. |
| IllegalWriteException | if the underlying implementation does not support modification of existing values |
|---|---|
| IllegalStateException | if this Part is obtained from a READ_ONLY folder |
| MessagingException |
This method sets the given Multipart object as this message's content.
| 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 Part is obtained from a READ_ONLY folder |
| MessagingException |
This method provides the mechanism to set this part's content. The DataHandler wraps around the actual content.
| dh | The DataHandler for the content. |
|---|
| IllegalWriteException | if the underlying implementation does not support modification of existing values |
|---|---|
| IllegalStateException | if this Part is obtained from a READ_ONLY folder |
| MessagingException |
Set a description String for this part. This typically associates some descriptive information with this part.
| description | Description of this part |
|---|
| IllegalWriteException | if the underlying implementation does not support modification of this header |
|---|---|
| IllegalStateException | if this Part is obtained from a READ_ONLY folder |
| MessagingException |
Set the disposition of this part.
| disposition | Disposition of this part |
|---|
| IllegalWriteException | if the underlying implementation does not support modification of this header |
|---|---|
| IllegalStateException | if this Part is obtained from a READ_ONLY folder |
| MessagingException |
Set the filename associated with this part, if possible. Useful if this part represents an "attachment" that was loaded from a file. The filename will usually be a simple name, not including directory components.
| filename | Filename to associate with this part |
|---|
| IllegalWriteException | if the underlying implementation does not support modification of this header |
|---|---|
| IllegalStateException | if this Part is obtained from a READ_ONLY folder |
| MessagingException |
Set the value for this header_name. Replaces all existing header values with this new value.
| header_name | The name of this header |
|---|---|
| header_value | The value for this header |
| IllegalWriteException | if the underlying implementation does not support modification of existing values |
|---|---|
| IllegalStateException | if this Part is obtained from a READ_ONLY folder |
| MessagingException |
A convenience method that sets the given String as this part's content with a MIME type of "text/plain".
| text | The text that is the Message's content. |
|---|
| IllegalWriteException | if the underlying implementation does not support modification of existing values |
|---|---|
| IllegalStateException | if this Part is obtained from a READ_ONLY folder |
| MessagingException |
Output a bytestream for this Part. This bytestream is typically an aggregration of the Part attributes and an appropriately encoded bytestream from its 'content'.
Classes that implement the Part interface decide on the appropriate encoding algorithm to be used.
The bytestream is typically used for sending.
| os |
|---|
| IOException | if an error occurs writing to the stream or if an error is generated by the javax.activation layer. |
|---|---|
| MessagingException | if an error occurs fetching the data to be written |