站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > Java Platform, Enterprise Edition v1.3.1 API Specifications

Java 2 Platform EE v1.3: Class MimeMultipart - Java Platform, Enterprise Edition v1.3.1 API Specifications

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

javax.mail.internet
Class MimeMultipart

java.lang.Object
  |
  +--javax.mail.Multipart
        |
        +--javax.mail.internet.MimeMultipart
public class MimeMultipart
extends Multipart

The MimeMultipart class is an implementation of the abstract Multipart class that uses MIME conventions for the multipart data.

A MimeMultipart is obtained from a MimePart whose primary type is "multipart" (by invoking the part's getContent() method) or it can be created by a client as part of creating a new MimeMessage.

The default multipart subtype is "mixed". The other multipart subtypes, such as "alternative", "related", and so on, can be implemented as subclasses of MimeMultipart with additional methods to implement the additional semantics of that type of multipart content. The intent is that service providers, mail JavaBean writers and mail clients will write many such subclasses and their Command Beans, and will install them into the JavaBeans Activation Framework, so that any JavaMail implementation and its clients can transparently find and use these classes. Thus, a MIME multipart handler is treated just like any other type handler, thereby decoupling the process of providing multipart handlers from the JavaMail API. Lacking these additional MimeMultipart subclasses, all subtypes of MIME multipart data appear as MimeMultipart objects.

An application can directly construct a MIME multipart object of any subtype by using the MimeMultipart(String subtype) constructor.

Field Summary
protected  DataSource ds
           
protected  boolean parsed
           
 
Fields inherited from class javax.mail.Multipart
contentType, parent, parts
 
Constructor Summary
MimeMultipart()
          Default constructor.
MimeMultipart(DataSource ds)
          Constructs a MimeMultipart object and its bodyparts from the given DataSource.
MimeMultipart(java.lang.String subtype)
          Construct a MimeMultipart object of the given subtype.
 
Method Summary
 BodyPart getBodyPart(int index)
          Get the specified BodyPart.
 BodyPart getBodyPart(java.lang.String CID)
          Get the MimeBodyPart referred to by the given ContentID (CID).
 int getCount()
          Return the number of enclosed BodyPart objects.
 void setSubType(java.lang.String subtype)
          Set the subtype.
protected  void updateHeaders()
          Update headers.
 void writeTo(java.io.OutputStream os)
          Iterates through all the parts and outputs each Mime part separated by a boundary.
 
Methods inherited from class javax.mail.Multipart
addBodyPart, addBodyPart, getContentType, getParent, removeBodyPart, removeBodyPart, setMultipartDataSource, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ds

protected DataSource ds

parsed

protected boolean parsed
Constructor Detail

MimeMultipart

public MimeMultipart()
Default constructor. An empty MimeMultipart object is created. Its content type is set to "multipart/mixed". A unique boundary string is generated and this string is setup as the "boundary" parameter for the contentType field.

MimeBodyParts may be added later.

MimeMultipart

public MimeMultipart(java.lang.String subtype)
Construct a MimeMultipart object of the given subtype. A unique boundary string is generated and this string is setup as the "boundary" parameter for the contentType field.

MimeBodyParts may be added later.

MimeMultipart

public MimeMultipart(DataSource ds)
              throws MessagingException
Constructs a MimeMultipart object and its bodyparts from the given DataSource.

This constructor handles as a special case the situation where the given DataSource is a MultipartDataSource object. In this case, this method just invokes the superclass (i.e., Multipart) constructor that takes a MultipartDataSource object.

Otherwise, the DataSource is assumed to provide a MIME multipart byte stream. The parser extracts the "boundary" parameter from the content type of this DataSource, skips the 'preamble' and reads bytes till the terminating boundary and creates MimeBodyParts for each part of the stream.

Parameters:
ds - DataSource, can be a MultipartDataSource
Method Detail

setSubType

public void setSubType(java.lang.String subtype)
                throws MessagingException
Set the subtype. This method should be invoked only on a new MimeMultipart object created by the client. The default subtype of such a multipart object is "mixed".

Parameters:
subtype - Subtype

getCount

public int getCount()
             throws MessagingException
Return the number of enclosed BodyPart objects.
Overrides:
getCount in class Multipart
Returns:
number of parts

getBodyPart

public BodyPart getBodyPart(int index)
                     throws MessagingException
Get the specified BodyPart. BodyParts are numbered starting at 0.
Overrides:
getBodyPart in class Multipart
Parameters:
index - the index of the desired BodyPart
Returns:
the Part
Throws:
MessagingException - if no such BodyPart exists

getBodyPart

public BodyPart getBodyPart(java.lang.String CID)
                     throws MessagingException
Get the MimeBodyPart referred to by the given ContentID (CID). Returns null if the part is not found.
Parameters:
CID - the ContentID of the desired part
Returns:
the Part

updateHeaders

protected void updateHeaders()
                      throws MessagingException
Update headers. The default implementation here just calls the updateHeaders method on each of its children BodyParts.

Note that the boundary parameter is already set up when a new and empty MimeMultipart object is created.

This method is called when the saveChanges method is invoked on the Message object containing this Multipart. This is typically done as part of the Message send process, however note that a client is free to call it any number of times. So if the header updating process is expensive for a specific MimeMultipart subclass, then it might itself want to track whether its internal state actually did change, and do the header updating only if necessary.

writeTo

public void writeTo(java.io.OutputStream os)
             throws java.io.IOException,
                    MessagingException
Iterates through all the parts and outputs each Mime part separated by a boundary.
Overrides:
writeTo in class Multipart
Following copied from class: javax.mail.Multipart
Throws:
java.io.IOException - if an IO related exception occurs
MessagingException -  
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

The CHM file was converted t