JavaEE API 8.0.1 · javax.mail.internet.MimeMultipart

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. For example, to create a "multipart/alternative" object, use new MimeMultipart("alternative").

The mail.mime.multipart.ignoremissingendboundary property may be set to false to cause a MessagingException to be thrown if the multipart data does not end with the required end boundary line. If this property is set to true or not set, missing end boundaries are not considered an error and the final body part ends at the end of the data.

The mail.mime.multipart.ignoremissingboundaryparameter System property may be set to false to cause a MessagingException to be thrown if the Content-Type of the MimeMultipart does not include a boundary parameter. If this property is set to true or not set, the multipart parsing code will look for a line that looks like a bounary line and use that as the boundary separating the parts.

The mail.mime.multipart.ignoreexistingboundaryparameter System property may be set to true to cause any boundary to be ignored and instead search for a boundary line in the message as with mail.mime.multipart.ignoremissingboundaryparameter.

Normally, when writing out a MimeMultipart that contains no body parts, or when trying to parse a multipart message with no body parts, a MessagingException is thrown. The MIME spec does not allow multipart content with no body parts. The mail.mime.multipart.allowempty System property may be set to true to override this behavior. When writing out such a MimeMultipart, a single empty part will be included. When reading such a multipart, a MimeMultipart will be created with no body parts.

Field Summary

Modifier and Type	Field and Description
protected boolean	allowEmpty Flag corresponding to the "mail.mime.multipart.allowempty" property, set in the `initializeProperties` method called from constructors and the parse method.
protected boolean	complete Have we seen the final bounary line?
protected DataSource	ds The DataSource supplying our InputStream.
protected boolean	ignoreExistingBoundaryParameter Flag corresponding to the "mail.mime.multipart.ignoreexistingboundaryparameter" property, set in the `initializeProperties` method called from constructors and the parse method.
protected boolean	ignoreMissingBoundaryParameter Flag corresponding to the "mail.mime.multipart.ignoremissingboundaryparameter" property, set in the `initializeProperties` method called from constructors and the parse method.
protected boolean	ignoreMissingEndBoundary Flag corresponding to the "mail.mime.multipart.ignoremissingendboundary" property, set in the `initializeProperties` method called from constructors and the parse method.
protected boolean	parsed Have we parsed the data from our InputStream yet?
protected String	preamble The MIME multipart preamble text, the text that occurs before the first boundary line.

Inherited from javax.mail.Multipart:: contentType parent parts

Constructor Summary

Access	Constructor and Description
public	MimeMultipart() Default constructor.
public	MimeMultipart(String the MIME content subtype subtype) Construct a MimeMultipart object of the given subtype.
public	MimeMultipart(BodyPart... the body parts parts) Construct a MimeMultipart object of the default "mixed" subtype, and with the given body parts.
public	MimeMultipart(String the MIME content subtype subtype, BodyPart... the body parts parts) Construct a MimeMultipart object of the given subtype and with the given body parts.
public	MimeMultipart(DataSource DataSource, can be a MultipartDataSource ds) Constructs a MimeMultipart object and its bodyparts from the given DataSource.

Method Summary

Modifier and Type	Method and Description
public synchronized void	addBodyPart(BodyPart The Part to be appended part) Overrides javax.mail.Multipart.addBodyPart. Adds a Part to the multipart.
public synchronized void	addBodyPart(BodyPart The BodyPart to be inserted part, int Location where to insert the part index) Overrides javax.mail.Multipart.addBodyPart. Adds a BodyPart at position `index`.
private static boolean	allDashes(String s) Is the string all dashes ('-')?
protected InternetHeaders	Returns: an InternetHeaders object createInternetHeaders(InputStream the InputStream to read the headers from is) Create and return an InternetHeaders object that loads the headers from the given InputStream.
protected MimeBodyPart	Returns: a MimeBodyPart createMimeBodyPart(InternetHeaders the headers for the body part headers, byte[] the content of the body part content) Create and return a MimeBodyPart object to represent a body part parsed from the InputStream.
protected MimeBodyPart	Returns: a MimeBodyPart createMimeBodyPart(InputStream InputStream containing the body part is) Create and return a MimeBodyPart object to represent a body part parsed from the InputStream.
private MimeBodyPart	createMimeBodyPartIs(InputStream is)
public synchronized BodyPart	Returns: the Part getBodyPart(int the index of the desired BodyPart index) Overrides javax.mail.Multipart.getBodyPart. Get the specified BodyPart.
public synchronized BodyPart	Returns: the Part getBodyPart(String the ContentID of the desired part CID) Get the MimeBodyPart referred to by the given ContentID (CID).
public synchronized int	Returns: number of parts getCount() Overrides javax.mail.Multipart.getCount. Return the number of enclosed BodyPart objects.
public synchronized String	Returns: the preamble text, or null if no preamble getPreamble() Get the preamble text, if any, that appears before the first body part of this multipart.
protected void	initializeProperties() Initialize flags that control parsing behavior, based on System properties described above in the class documentation.
public synchronized boolean	Returns: true if the final boundary line was seen isComplete() Return true if the final boundary line for this multipart was seen.
protected synchronized void	parse() Parse the InputStream from our DataSource, constructing the appropriate MimeBodyParts.
private static int	Returns: -1 on EOF, otherwise number of bytes read readFully(InputStream InputStream to read from in, byte[] buffer to read into buf, int offset in the buffer for first byte off, int number of bytes to read len) Read data from the input stream to fill the buffer starting at the specified offset with the specified number of bytes.
public boolean	Returns: true if part removed, false otherwise removeBodyPart(BodyPart The part to remove part) Overrides javax.mail.Multipart.removeBodyPart. Remove the specified part from the multipart message.
public void	removeBodyPart(int Index of the part to remove index) Overrides javax.mail.Multipart.removeBodyPart. Remove the part at specified location (starting from 0).
public synchronized void	setPreamble(String the preamble text preamble) Set the preamble text to be included before the first body part.
public synchronized void	setSubType(String Subtype subtype) Set the subtype.
private void	skipFully(InputStream in, long offset) Skip the specified number of bytes, repeatedly calling the skip method as necessary.
protected synchronized void	updateHeaders() Update headers.
public synchronized void	writeTo(OutputStream the stream to write to os) Implements abstract javax.mail.Multipart.writeTo. Iterates through all the parts and outputs each MIME part separated by a boundary.

Inherited from javax.mail.Multipart:: getContentType getParent setMultipartDataSource setParent

Field Detail

allowEmpty back to summary

allowEmpty	back to summary
protected boolean allowEmpty Flag corresponding to the "mail.mime.multipart.allowempty" property, set in the `initializeProperties` method called from constructors and the parse method. Since JavaMail 1.5

protected boolean allowEmpty

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

Since: JavaMail 1.5

complete	back to summary
protected boolean complete Have we seen the final bounary line? Since JavaMail 1.5

complete

public Class MimeMultipart

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail