javax.mail.internet

Class MimeMultipart

java.lang.Object

javax.mail.Multipart

javax.mail.internet.MimeMultipart

public class MimeMultipart
extends Multipart

A MIME multipart container.

The default multipart subtype is "mixed". However, an application can construct a MIME multipart object of any subtype using the MimeMultipart(String) constructor.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowEmpty Flag corresponding to the mail.mime.multipart.allowempty property, set in initializeProperties() which is called from constructors and the parse method.
protected boolean	complete Indicates whether the final boundary line of the multipart has been seen.
protected javax.activation.DataSource	ds The data source supplying the multipart data.
protected boolean	ignoreExistingBoundaryParameter Flag corresponding to the mail.mime.multipart.ignoreexistingboundaryparameter property, set in initializeProperties() which is called from constructors and the parse method.
protected boolean	ignoreMissingBoundaryParameter Flag corresponding to the mail.mime.multipart.ignoremissingboundaryparameter property, set in initializeProperties() which is called from constructors and the parse method.
protected boolean	ignoreMissingEndBoundary Flag corresponding to the mail.mime.multipart.ignoremissingendboundary property, set in initializeProperties() which is called from constructors and the parse method.
protected boolean	parsed Indicates whether the data from the input stream has been parsed yet.
protected java.lang.String	preamble The preamble text before the first boundary line.

Fields inherited from class javax.mail.Multipart

contentType, parent, parts

Constructor Summary

Constructors

Constructor and Description
MimeMultipart() Constructor for an empty MIME multipart of type "multipart/mixed".
MimeMultipart(BodyPart... parts) Constructor with the "mixed" subtype and specified body parts.
MimeMultipart(javax.activation.DataSource ds) Constructor with a given data source.
MimeMultipart(java.lang.String subtype) Constructor for an empty MIME multipart of the given subtype.
MimeMultipart(java.lang.String subtype, BodyPart... parts) Constructor with the specified subtype and body parts.

Method Summary

Methods

Modifier and Type	Method and Description
protected InternetHeaders	createInternetHeaders(java.io.InputStream is) Creates headers from the specified input stream.
protected MimeBodyPart	createMimeBodyPart(java.io.InputStream is) Creates a MIME body part from the specified input stream.
protected MimeBodyPart	createMimeBodyPart(InternetHeaders headers, byte[] content) Creates a MIME body part object from the given headers and byte content.
BodyPart	getBodyPart(int index) Returns the specified body part.
BodyPart	getBodyPart(java.lang.String CID) Returns the body part identified by the given Content-ID (CID).
int	getCount() Returns the number of component body parts.
java.lang.String	getPreamble() Returns the preamble text (if any) before the first boundary line in this multipart's body.
protected void	initializeProperties() Initialize various flags that control parsing behavior.
boolean	isComplete() Indicates whether the final boundary line for this multipart has been parsed.
protected void	parse() Parses the body parts from this multipart's data source.
void	setPreamble(java.lang.String preamble) Sets the preamble text to be emitted before the first boundary line.
void	setSubType(java.lang.String subtype) Sets the subtype.
protected void	updateHeaders() Updates the headers of this part to be consistent with its content.
void	writeTo(java.io.OutputStream os) Writes this multipart to the specified output stream.

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 javax.activation.DataSource ds

The data source supplying the multipart data.

parsed

protected boolean parsed

Indicates whether the data from the input stream has been parsed yet.

complete

protected boolean complete

Indicates whether the final boundary line of the multipart has been seen.

Since:

JavaMail 1.5

preamble

protected java.lang.String preamble

The preamble text before the first boundary line.

Since:

JavaMail 1.5

ignoreMissingEndBoundary

protected boolean ignoreMissingEndBoundary

Flag corresponding to the mail.mime.multipart.ignoremissingendboundary property, set in initializeProperties() which is called from constructors and the parse method.

Since:

JavaMail 1.5

ignoreMissingBoundaryParameter

protected boolean ignoreMissingBoundaryParameter

Flag corresponding to the mail.mime.multipart.ignoremissingboundaryparameter property, set in initializeProperties() which is called from constructors and the parse method.

Since:

JavaMail 1.5

ignoreExistingBoundaryParameter

protected boolean ignoreExistingBoundaryParameter

Flag corresponding to the mail.mime.multipart.ignoreexistingboundaryparameter property, set in initializeProperties() which is called from constructors and the parse method.

Since:

JavaMail 1.5

allowEmpty

protected boolean allowEmpty

Flag corresponding to the mail.mime.multipart.allowempty property, set in initializeProperties() which is called from constructors and the parse method.

Since:

JavaMail 1.5

Constructor Detail

MimeMultipart

public MimeMultipart()

Constructor for an empty MIME multipart of type "multipart/mixed".

MimeMultipart

public MimeMultipart(java.lang.String subtype)

Constructor for an empty MIME multipart of the given subtype.

MimeMultipart

public MimeMultipart(javax.activation.DataSource ds)
              throws MessagingException

Constructor with a given data source.

Parameters:

ds - the data source, which can be a MultipartDataSource

Throws:

MessagingException

MimeMultipart

public MimeMultipart(BodyPart... parts)
              throws MessagingException

Constructor with the "mixed" subtype and specified body parts. More body parts may be added.

Throws:

MessagingException

Since:

JavaMail 1.5

MimeMultipart

public MimeMultipart(java.lang.String subtype,
             BodyPart... parts)
              throws MessagingException

Constructor with the specified subtype and body parts. More body parts may be added later.

Throws:

MessagingException

Since:

JavaMail 1.5

Method Detail

initializeProperties

protected void initializeProperties()

Initialize various flags that control parsing behavior.

Since:

JavaMail 1.5

setSubType

public void setSubType(java.lang.String subtype)
                throws MessagingException

Sets the subtype.

Throws:

MessagingException

getCount

public int getCount()
             throws MessagingException

Returns the number of component body parts.

Overrides:

getCount in class Multipart

Throws:

MessagingException

getBodyPart

public BodyPart getBodyPart(int index)
                     throws MessagingException

Returns the specified body part. Body parts are numbered starting at 0.

Overrides:

getBodyPart in class Multipart

Parameters:

index - the body part index

Throws:

MessagingException - if no such part exists

getBodyPart

public BodyPart getBodyPart(java.lang.String CID)
                     throws MessagingException

Returns the body part identified by the given Content-ID (CID).

Parameters:

CID - the Content-ID of the desired part

Throws:

MessagingException

updateHeaders

protected void updateHeaders()
                      throws MessagingException

Updates the headers of this part to be consistent with its content.

Throws:

MessagingException

writeTo

public void writeTo(java.io.OutputStream os)
             throws java.io.IOException,
                    MessagingException

Writes this multipart to the specified output stream. This method iterates through all the component parts, outputting each part separated by the Content-Type boundary parameter.

Specified by:

writeTo in class Multipart

Throws:

java.io.IOException

MessagingException

parse

protected void parse()
              throws MessagingException

Parses the body parts from this multipart's data source.

Throws:

MessagingException

isComplete

public boolean isComplete()
                   throws MessagingException

Indicates whether the final boundary line for this multipart has been parsed.

Throws:

MessagingException

Since:

JavaMail 1.4

getPreamble

public java.lang.String getPreamble()
                             throws MessagingException

Returns the preamble text (if any) before the first boundary line in this multipart's body.

Throws:

MessagingException

Since:

JavaMail 1.4

setPreamble

public void setPreamble(java.lang.String preamble)
                 throws MessagingException

Sets the preamble text to be emitted before the first boundary line.

Parameters:

preamble - the preamble text

Throws:

MessagingException

Since:

JavaMail 1.4

createInternetHeaders

protected InternetHeaders createInternetHeaders(java.io.InputStream is)
                                         throws MessagingException

Creates headers from the specified input stream.

Parameters:

is - the input stream to read the headers from

Throws:

MessagingException

createMimeBodyPart

protected MimeBodyPart createMimeBodyPart(InternetHeaders headers,
                              byte[] content)
                                   throws MessagingException

Creates a MIME body part object from the given headers and byte content.

Parameters:

headers - the part headers

content - the part content

Throws:

MessagingException

createMimeBodyPart

protected MimeBodyPart createMimeBodyPart(java.io.InputStream is)
                                   throws MessagingException

Creates a MIME body part from the specified input stream.

Parameters:

is - the input stream to parse the part from

Throws:

MessagingException