|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.mail.Multipart
public abstract class Multipart
A multipart is a container for multiple body parts.
Some messaging systems provide different subtypes of multiparts. For example, MIME specifies a set of subtypes that include "alternative", "mixed", "related", "parallel", "signed", etc.
Field Summary | |
---|---|
protected java.lang.String |
contentType
The content-type of this multipart object. |
protected Part |
parent
The part containing this multipart, if known. |
protected java.util.Vector |
parts
Vector of body parts. |
Constructor Summary | |
---|---|
protected |
Multipart()
Constructor for an empty multipart of type "multipart/mixed". |
Method Summary | |
---|---|
void |
addBodyPart(BodyPart part)
Adds a body part to this multipart. |
void |
addBodyPart(BodyPart part,
int index)
Inserts a body part at the specified index. |
BodyPart |
getBodyPart(int index)
Get the specified body part. |
java.lang.String |
getContentType()
Returns the content-type of this multipart. |
int |
getCount()
Returns the number of enclosed body parts. |
Part |
getParent()
Returns the part containing this multipart, or null if
not known. |
boolean |
removeBodyPart(BodyPart part)
Removes the specified body part from this multipart. |
void |
removeBodyPart(int index)
Removes the body part at the specified index. |
protected void |
setMultipartDataSource(MultipartDataSource mp)
Configures this multipart from the given data source. |
void |
setParent(Part part)
Sets the parent of this multipart. |
abstract void |
writeTo(java.io.OutputStream os)
Writes this multipart to the specified byte stream. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.util.Vector parts
protected java.lang.String contentType
protected Part parent
Constructor Detail |
---|
protected Multipart()
Method Detail |
---|
protected void setMultipartDataSource(MultipartDataSource mp) throws MessagingException
The method adds the body parts in the data source to this multipart, and sets the content-type.
mp
- a multipart data source
MessagingException
public java.lang.String getContentType()
public int getCount() throws MessagingException
MessagingException
public BodyPart getBodyPart(int index) throws MessagingException
index
- the index of the desired body part
java.lang.IndexOutOfBoundsException
- if the given index is out of range
MessagingException
public boolean removeBodyPart(BodyPart part) throws MessagingException
part
- the body part to remove
MessagingException
- if the multipart has not been configured
IllegalWriteException
- if the underlying implementation
does not support modification of existing valuespublic void removeBodyPart(int index) throws MessagingException
index
- index of the part to remove
java.lang.IndexOutOfBoundsException
- if the given index is out of range
IllegalWriteException
- if the underlying implementation
does not support modification of existing values
MessagingException
public void addBodyPart(BodyPart part) throws MessagingException
part
- the body part to be appended
IllegalWriteException
- if the underlying implementation
does not support modification of existing values
MessagingException
public void addBodyPart(BodyPart part, int index) throws MessagingException
part
- the body part to be insertedindex
- where to insert the part
IllegalWriteException
- if the underlying implementation
does not support modification of existing values
MessagingException
public abstract void writeTo(java.io.OutputStream os) throws java.io.IOException, MessagingException
java.io.IOException
MessagingException
public Part getParent()
null
if
not known.
public void setParent(Part part)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |