Movatterモバイル変換

Class Multipart

java.lang.Object  |  +--javax.mail.Multipart

Direct Known Subclasses:

MimeMultipart

public abstract classMultipart

extends java.lang.Object

Multipart is a container that holds multiple body parts. Multipart provides methods to retrieve and set its subparts.

Multipart also acts as the base class for the content object returned by most Multipart DataContentHandlers. For example, invoking getContent() on a DataHandler whose source is a "multipart/signed" data source may return an appropriate subclass of Multipart.

Some messaging systems provide different subtypes of Multiparts. For example, MIME specifies a set of subtypes that include "alternative", "mixed", "related", "parallel", "signed", etc.

Multipart is an abstract class. Subclasses provide actual implementations.

parts

protected java.util.Vectorparts

Vector of BodyPart objects.

contentType

protected java.lang.StringcontentType

This field specifies the content-type of this multipart object. It defaults to "multipart/mixed".

parent

protectedPartparent

ThePart containing thisMultipart, if known.

Since:

JavaMail 1.1

Multipart

protectedMultipart()

Default constructor. An empty Multipart object is created.

setMultipartDataSource

protected voidsetMultipartDataSource(MultipartDataSource mp)                               throwsMessagingException

Setup this Multipart object from the given MultipartDataSource.

The method adds the MultipartDataSource's BodyPart objects into this Multipart. This Multipart's contentType is set to that of the MultipartDataSource.

This method is typically used in those cases where one has a multipart data source that has already been pre-parsed into the individual body parts (for example, an IMAP datasource), but needs to create an appropriate Multipart subclass that represents a specific multipart subtype.

Parameters:

mp - Multipart datasource

getContentType

public java.lang.StringgetContentType()

Return the content-type of this Multipart.

This implementation just returns the value of thecontentType field.

Returns:

content-type

See Also:

contentType

getCount

public intgetCount()             throwsMessagingException

Return the number of enclosed BodyPart objects.

Returns:

number of parts

See Also:

parts

getBodyPart

publicBodyPartgetBodyPart(int index)                     throwsMessagingException

Get the specified Part. Parts are numbered starting at 0.

Parameters:

index - the index of the desired Part

Returns:

the Part

Throws:

java.lang.IndexOutOfBoundsException - if the given indexis out of range.

MessagingException -  

removeBodyPart

public booleanremoveBodyPart(BodyPart part)                       throwsMessagingException

Remove the specified part from the multipart message. Shifts all the parts after the removed part down one.

Parameters:

part - The part to remove

Returns:

true if part removed, false otherwise

Throws:

MessagingException - if no such Part exists

IllegalWriteException - if the underlyingimplementation does not support modificationof existing values

removeBodyPart

public voidremoveBodyPart(int index)                    throwsMessagingException

Remove the part at specified location (starting from 0). Shifts all the parts after the removed part down one.

Parameters:

index - Index of the part to remove

Throws:

MessagingException -  

java.lang.IndexOutOfBoundsException - if the given indexis out of range.

IllegalWriteException - if the underlyingimplementation does not support modificationof existing values

addBodyPart

public voidaddBodyPart(BodyPart part)                 throwsMessagingException

Adds a Part to the multipart. The BodyPart is appended to the list of existing Parts.

Parameters:

part - The Part to be appended

Throws:

MessagingException -  

IllegalWriteException - if the underlyingimplementation does not support modificationof existing values

addBodyPart

public voidaddBodyPart(BodyPart part,                        int index)                 throwsMessagingException

Adds a BodyPart at positionindex. Ifindex is not the last one in the list, the subsequent parts are shifted up. Ifindex is larger than the number of parts present, the BodyPart is appended to the end.

Parameters:

part - The BodyPart to be inserted

index - Location where to insert the part

Throws:

MessagingException -  

IllegalWriteException - if the underlyingimplementation does not support modificationof existing values

writeTo

public abstract voidwriteTo(java.io.OutputStream os)                      throws java.io.IOException,MessagingException

Output an appropriately encoded bytestream to the given OutputStream. The implementation subclass decides the appropriate encoding algorithm to be used. The bytestream is typically used for sending.

Throws:

java.io.IOException - if an IO related exception occurs

MessagingException -  

getParent

publicPartgetParent()

Return thePart that contains thisMultipart object, ornull if not known.

Since:

JavaMail 1.1

setParent

public voidsetParent(Part parent)

Set the parent of thisMultipart to be the specifiedPart. Normally called by theMessage orBodyPartsetContent(Multipart) method.parent may benull if theMultipart is being removed from its containingPart.

Since:

JavaMail 1.1