javax.mail
Class Multipart

java.lang.Object
  extended by javax.mail.Multipart
Direct Known Subclasses:
MimeMultipart

public abstract class Multipart
extends Object

A container for multiple BodyParts.

Version:
$Rev: 421852 $ $Date: 2006-07-14 03:02:19 -0700 (Fri, 14 Jul 2006) $

Field Summary
protected  String contentType
          The content type of this multipart object; defaults to "multipart/mixed"
protected  Part parent
          The Part that contains this multipart.
protected  Vector parts
          Vector of sub-parts.
 
Constructor Summary
protected Multipart()
           
 
Method Summary
 void addBodyPart(BodyPart part)
          Add a part to the end of the list.
 void addBodyPart(BodyPart part, int pos)
          Insert a part into the list at a designated point; all subsequent parts move down
 BodyPart getBodyPart(int index)
          Get the specified part; numbering starts at zero.
 String getContentType()
          Return the content type.
 int getCount()
          Return the number of enclosed parts
 Part getParent()
          Return the Part containing this Multipart object or null if unknown.
 boolean removeBodyPart(BodyPart part)
          Remove the supplied part from the list.
 void removeBodyPart(int index)
          Remove the specified part; all others move down one
protected  void setMultipartDataSource(MultipartDataSource mds)
          Initialize this multipart object from the supplied data source.
 void setParent(Part part)
          Set the parent of this Multipart object
abstract  void writeTo(OutputStream out)
          Encode and write this multipart to the supplied OutputStream; the encoding used is determined by the implementation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

parts

protected Vector parts
Vector of sub-parts.


contentType

protected String contentType
The content type of this multipart object; defaults to "multipart/mixed"


parent

protected Part parent
The Part that contains this multipart.

Constructor Detail

Multipart

protected Multipart()
Method Detail

setMultipartDataSource

protected void setMultipartDataSource(MultipartDataSource mds)
                               throws MessagingException
Initialize this multipart object from the supplied data source. This adds any BodyParts into this object and initializes the content type.

Parameters:
mds - the data source
Throws:
MessagingException

getContentType

public String getContentType()
Return the content type.

Returns:
the content type

getCount

public int getCount()
             throws MessagingException
Return the number of enclosed parts

Returns:
the number of parts
Throws:
MessagingException

getBodyPart

public BodyPart getBodyPart(int index)
                     throws MessagingException
Get the specified part; numbering starts at zero.

Parameters:
index - the part to get
Returns:
the part
Throws:
MessagingException

removeBodyPart

public boolean removeBodyPart(BodyPart part)
                       throws MessagingException
Remove the supplied part from the list.

Parameters:
part - the part to remove
Returns:
true if the part was removed
Throws:
MessagingException

removeBodyPart

public void removeBodyPart(int index)
                    throws MessagingException
Remove the specified part; all others move down one

Parameters:
index - the part to remove
Throws:
MessagingException

addBodyPart

public void addBodyPart(BodyPart part)
                 throws MessagingException
Add a part to the end of the list.

Parameters:
part - the part to add
Throws:
MessagingException

addBodyPart

public void addBodyPart(BodyPart part,
                        int pos)
                 throws MessagingException
Insert a part into the list at a designated point; all subsequent parts move down

Parameters:
part - the part to add
pos - the index of the new part
Throws:
MessagingException

writeTo

public abstract void writeTo(OutputStream out)
                      throws IOException,
                             MessagingException
Encode and write this multipart to the supplied OutputStream; the encoding used is determined by the implementation.

Parameters:
out - the stream to write to
Throws:
IOException
MessagingException

getParent

public Part getParent()
Return the Part containing this Multipart object or null if unknown.

Returns:
this Multipart's parent

setParent

public void setParent(Part part)
Set the parent of this Multipart object

Parameters:
part - this object's parent


Copyright © 2006 Apache Software Foundation. All Rights Reserved.