Java Doc for Part.java in  » EJB-Server-GlassFish » mail » javax » mail » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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:

• As a DataHandler - using the 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.
• As an input stream - using the getInputStream() method. Any mail-specific encodings are decoded before this stream is returned.
• As a Java object - using the 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.

Message and BodyPart implement the Part interface. Note that in MIME parlance, Part models an Entity (RFC 2045, Section 2.4).
author:
   John Mani

This is a convenience method that just invokes the DataHandler's getContent() method Object
exception:
  MessagingException -
exception:
  IOException - this is typically thrown by the DataHandler. Refer to the documentation for javax.activation.DataHandler for more details.
See Also:   javax.activation.DataHandler.getContent

The MIME typing system is used to name Content-types. The ContentType of this part
exception:
  MessagingException -
See Also:   javax.activation.DataHandler

 String disp = part.getDisposition();
 if (disp == null || disp.equalsIgnoreCase(Part.ATTACHMENT))
 // treat as attachment if not first part
 

This is typically a convenience method that just invokes the DataHandler's getInputStream() method. an InputStream
exception:
  IOException - this is typically thrown by the DataHandler. Refer to the documentation for javax.activation.DataHandler for more details.
exception:
  MessagingException -
See Also:   Part.getDataHandler
See Also:   javax.activation.DataHandler.getInputStream

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. size of content in bytes
exception:
  MessagingException -

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.

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.
Parameters:
  obj - A java object.
Parameters:
  type - MIME type of this object.
exception:
  IllegalWriteException - if the underlying implementationdoes not support modification of existing values
exception:
  IllegalStateException - if this Part is obtainedfrom a READ_ONLY folder

Classes that implement the Part interface decide on the appropriate encoding algorithm to be used.

The bytestream is typically used for sending.
exception:
  IOException - if an error occurs writing to the stream or if an error is generatedby the javax.activation layer.
exception:
  MessagingException - if an error occurs fetching thedata to be written
See Also:   javax.activation.DataHandler.writeTo