Module jakarta.mail
Package jakarta.mail

Class Multipart

  • Direct Known Subclasses:
    MimeMultipart
    public abstract class Multipart
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.

    Author:
    John Mani

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String contentType
      This field specifies the content-type of this multipart object.
      protected Part parent
      The Part containing this Multipart, if known.
      protected java.util.Vector<BodyPart> parts
      Vector of BodyPart objects.
      protected StreamProvider streamProvider
      Instance of stream provider.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Multipart()
      Default constructor.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void addBodyPart​(BodyPart part)
      Adds a Part to the multipart.
      void addBodyPart​(BodyPart part, int index)
      Adds a BodyPart at position index.
      BodyPart getBodyPart​(int index)
      Get the specified Part.
      java.lang.String getContentType()
      Return the content-type of this Multipart.
      int getCount()
      Return the number of enclosed BodyPart objects.
      Part getParent()
      Return the Part that contains this Multipart object, or null if not known.
      void removeBodyPart​(int index)
      Remove the part at specified location (starting from 0).
      boolean removeBodyPart​(BodyPart part)
      Remove the specified part from the multipart message.
      protected void setMultipartDataSource​(MultipartDataSource mp)
      Setup this Multipart object from the given MultipartDataSource.
      void setParent​(Part parent)
      Set the parent of this Multipart to be the specified Part.
      abstract void writeTo​(java.io.OutputStream os)
      Output an appropriately encoded bytestream to the given OutputStream.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • parts

        protected java.util.Vector<BodyPart> parts
        Vector of BodyPart objects.

      • contentType

        protected java.lang.String contentType
        This field specifies the content-type of this multipart object. It defaults to "multipart/mixed".

      • parent

        protected Part parent
        The Part containing this Multipart, if known.

      • streamProvider

        protected final StreamProvider streamProvider
        Instance of stream provider.

    • Constructor Detail

      • Multipart

        protected Multipart()
        Default constructor. An empty Multipart object is created.

    • Method Detail

      • setMultipartDataSource

        protected void setMultipartDataSource​(MultipartDataSource mp)
                               throws MessagingException
        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
        Throws:
        MessagingException - for failures

      • getContentType

        public java.lang.String getContentType()
        Return the content-type of this Multipart.

        This implementation just returns the value of the contentType field.

        Returns:
        content-type
        See Also:
        contentType

      • getBodyPart

        public BodyPart getBodyPart​(int index)
                     throws MessagingException
        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 index is out of range.
        MessagingException - for other failures

      • removeBodyPart

        public boolean removeBodyPart​(BodyPart part)
                       throws MessagingException
        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 underlying implementation does not support modification of existing values

      • removeBodyPart

        public void removeBodyPart​(int index)
                    throws MessagingException
        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:
        java.lang.IndexOutOfBoundsException - if the given index is out of range.
        IllegalWriteException - if the underlying implementation does not support modification of existing values
        MessagingException - for other failures

      • addBodyPart

        public void addBodyPart​(BodyPart part)
                 throws MessagingException
        Adds a Part to the multipart. The BodyPart is appended to the list of existing Parts.
        Parameters:
        part - The Part to be appended
        Throws:
        IllegalWriteException - if the underlying implementation does not support modification of existing values
        MessagingException - for other failures

      • addBodyPart

        public void addBodyPart​(BodyPart part,
                        int index)
                 throws MessagingException
        Adds a BodyPart at position index. If index is not the last one in the list, the subsequent parts are shifted up. If index 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:
        IllegalWriteException - if the underlying implementation does not support modification of existing values
        MessagingException - for other failures

      • writeTo

        public abstract void writeTo​(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.
        Parameters:
        os - the stream to write to
        Throws:
        java.io.IOException - if an IO related exception occurs
        MessagingException - for other failures

      • getParent

        public Part getParent()
        Return the Part that contains this Multipart object, or null if not known.
        Returns:
        the parent Part

      • setParent

        public void setParent​(Part parent)
        Set the parent of this Multipart to be the specified Part. Normally called by the Message or BodyPart setContent(Multipart) method. parent may be null if the Multipart is being removed from its containing Part.
        Parameters:
        parent - the parent Part