Package com.sun.xml.messaging.saaj.packaging.mime.internet

Class MimeBodyPart

  • public final class MimeBodyPart
extends Object
    This class represents a MIME body part. MimeBodyParts are contained in MimeMultipart objects.

    MimeBodyPart uses the InternetHeaders class to parse and store the headers of that body part.

    A note on RFC 822 and MIME headers RFC 822 header fields must contain only US-ASCII characters. MIME allows non ASCII characters to be present in certain portions of certain headers, by encoding those characters. RFC 2047 specifies the rules for doing this. The MimeUtility class provided in this package can be used to to achieve this. Callers of the setHeader, addHeader, and addHeaderLine methods are responsible for enforcing the MIME requirements for the specified headers. In addition, these header fields must be folded (wrapped) before being sent if they exceed the line length limitation for the transport (1000 bytes for SMTP). Received headers may have been folded. The application is responsible for folding and unfolding headers as appropriate.
    Author:
    John Mani, Bill Shannon
    See Also:
    MimeUtility

    • Constructor Detail

      • MimeBodyPart

        public MimeBodyPart()
        An empty MimeBodyPart object is created. This body part maybe filled in by a client constructing a multipart message.

      • MimeBodyPart

        public MimeBodyPart​(InputStream is)
             throws MessagingException
        Constructs a MimeBodyPart by reading and parsing the data from the specified input stream. The parser consumes data till the end of the given input stream. The input stream must start at the beginning of a valid MIME body part and must terminate at the end of that body part.

        Note that the "boundary" string that delimits body parts must not be included in the input stream. The intention is that the MimeMultipart parser will extract each body part's bytes from a multipart stream and feed them into this constructor, without the delimiter strings.

        Parameters:
        is - the body part Input Stream
        Throws:
        MessagingException - in case of error

      • MimeBodyPart

        public MimeBodyPart​(InternetHeaders headers,
                    byte[] content,
                    int len)
        Constructs a MimeBodyPart using the given header and content bytes.

        Used by providers.

        Parameters:
        headers - The header of this part
        content - bytes representing the body of this part.
        len - content length.

      • MimeBodyPart

        public MimeBodyPart​(InternetHeaders headers,
                    byte[] content,
                    int start,
                    int len)

      • MimeBodyPart

        public MimeBodyPart​(org.jvnet.mimepull.MIMEPart part)

    • Method Detail

      • getParent

        public MimeMultipart getParent()
        Return the containing MimeMultipart object, or null if not known.
        Returns:
        parent part.

      • setParent

        public void setParent​(MimeMultipart parent)
        Set the parent of this MimeBodyPart to be the specified MimeMultipart. Normally called by MimeMultipart's addBodyPart method. parent may be null if the MimeBodyPart is being removed from its containing MimeMultipart.
        Parameters:
        parent - parent part
        Since:
        JavaMail 1.1

      • getSize

        public int getSize()
        Return the size of the content of this body part in bytes. Return -1 if the size cannot be determined.

        Note that this number may not be an exact measure of the content size and may or may not account for any transfer encoding of the content.

        This implementation returns the size of the content array (if not null), or, if contentStream is not null, and the available method returns a positive number, it returns that number as the size. Otherwise, it returns -1.

        Returns:
        size in bytes, or -1 if not known

      • getLineCount

        public int getLineCount()
        Return the number of lines for the content of this MimeBodyPart. Return -1 if this number cannot be determined.

        Note that this number may not be an exact measure of the content length and may or may not account for any transfer encoding of the content.

        This implementation returns -1.

        Returns:
        number of lines, or -1 if not known

      • getContentType

        public String getContentType()
        Returns the value of the RFC 822 "Content-Type" header field. This represents the content type of the content of this body part. This value must not be null. If this field is unavailable, "text/plain" should be returned.

        This implementation uses getHeader(name) to obtain the requisite header field.

        Returns:
        Content-Type of this body part

      • isMimeType

        public boolean isMimeType​(String mimeType)
        Is this MimeBodyPart of the specified MIME type? This method compares only the primaryType and subType. The parameters of the content types are ignored.

        For example, this method will return true when comparing a MimeBodyPart of content type "text/plain" with "text/plain; charset=foobar".

        If the subType of mimeType is the special character '*', then the subtype is ignored during the comparison.

        Parameters:
        mimeType - string
        Returns:
        true if it is valid mime type

      • getDisposition

        public String getDisposition()
                      throws MessagingException
        Returns the value of the "Content-Disposition" header field. This represents the disposition of this part. The disposition describes how the part should be presented to the user.

        If the Content-Disposition field is unavailable, null is returned.

        This implementation uses getHeader(name) to obtain the requisite header field.

        Returns:
        content disposition
        Throws:
        MessagingException - in case of error
        See Also:
        headers

      • setDisposition

        public void setDisposition​(String disposition)
                    throws MessagingException
        Set the "Content-Disposition" header field of this body part. If the disposition is null, any existing "Content-Disposition" header field is removed.
        Parameters:
        disposition - value
        Throws:
        MessagingException - in case of error
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.

      • getEncoding

        public String getEncoding()
                   throws MessagingException
        Returns the content transfer encoding from the "Content-Transfer-Encoding" header field. Returns null if the header is unavailable or its value is absent.

        This implementation uses getHeader(name) to obtain the requisite header field.

        Returns:
        encoding
        Throws:
        MessagingException - in case of error
        See Also:
        headers

      • getContentID

        public String getContentID()
        Returns the value of the "Content-ID" header field. Returns null if the field is unavailable or its value is absent.

        This implementation uses getHeader(name) to obtain the requisite header field.

        Returns:
        conent id

      • setContentID

        public void setContentID​(String cid)
        Set the "Content-ID" header field of this body part. If the cid parameter is null, any existing "Content-ID" is removed.
        Parameters:
        cid - content id
        Throws:
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.
        Since:
        JavaMail 1.3

      • getContentMD5

        public String getContentMD5()
        Return the value of the "Content-MD5" header field. Returns null if this field is unavailable or its value is absent.

        This implementation uses getHeader(name) to obtain the requisite header field.

        Returns:
        content MD5 sum

      • setContentMD5

        public void setContentMD5​(String md5)
        Set the "Content-MD5" header field of this body part.
        Parameters:
        md5 - content md5 sum
        Throws:
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.

      • getContentLanguage

        public String[] getContentLanguage()
                            throws MessagingException
        Get the languages specified in the Content-Language header of this MimeBodyPart. The Content-Language header is defined by RFC 1766. Returns null if this header is not available or its value is absent.

        This implementation uses getHeader(name) to obtain the requisite header field.

        Returns:
        array of language tags
        Throws:
        MessagingException - in case of error

      • setContentLanguage

        public void setContentLanguage​(String[] languages)
        Set the Content-Language header of this MimeBodyPart. The Content-Language header is defined by RFC 1766.
        Parameters:
        languages - array of language tags

      • getDescription

        public String getDescription()
        Returns the "Content-Description" header field of this body part. This typically associates some descriptive information with this part. Returns null if this field is unavailable or its value is absent.

        If the Content-Description field is encoded as per RFC 2047, it is decoded and converted into Unicode. If the decoding or conversion fails, the raw data is returned as is.

        This implementation uses getHeader(name) to obtain the requisite header field.

        Returns:
        content description

      • setDescription

        public void setDescription​(String description)
                    throws MessagingException
        Set the "Content-Description" header field for this body part. If the description parameter is null, then any existing "Content-Description" fields are removed.

        If the description contains non US-ASCII characters, it will be encoded using the platform's default charset. If the description contains only US-ASCII characters, no encoding is done and it is used as is.

        Note that if the charset encoding process fails, a MessagingException is thrown, and an UnsupportedEncodingException is included in the chain of nested exceptions within the MessagingException.

        Parameters:
        description - content description
        Throws:
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.
        MessagingException - An UnsupportedEncodingException may be included in the exception chain if the charset conversion fails.

      • setDescription

        public void setDescription​(String description,
                           String charset)
                    throws MessagingException
        Set the "Content-Description" header field for this body part. If the description parameter is null, then any existing "Content-Description" fields are removed.

        If the description contains non US-ASCII characters, it will be encoded using the specified charset. If the description contains only US-ASCII characters, no encoding is done and it is used as is.

        Note that if the charset encoding process fails, a MessagingException is thrown, and an UnsupportedEncodingException is included in the chain of nested exceptions within the MessagingException.

        Parameters:
        description - Description
        charset - Charset for encoding
        Throws:
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.
        MessagingException - An UnsupportedEncodingException may be included in the exception chain if the charset conversion fails.

      • getFileName

        public String getFileName()
                   throws MessagingException
        Get the filename associated with this body part.

        Returns the value of the "filename" parameter from the "Content-Disposition" header field of this body part. If its not available, returns the value of the "name" parameter from the "Content-Type" header field of this body part. Returns null if both are absent.

        Returns:
        filename
        Throws:
        MessagingException - in case of error

      • setFileName

        public void setFileName​(String filename)
                 throws MessagingException
        Set the filename associated with this body part, if possible.

        Sets the "filename" parameter of the "Content-Disposition" header field of this body part.

        Parameters:
        filename - filename
        Throws:
        MessagingException - in case of error
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.

      • getInputStream

        public InputStream getInputStream()
                           throws IOException
        Return a decoded input stream for this body part's "content".

        This implementation obtains the input stream from the DataHandler. That is, it invokes getDataHandler().getInputStream();

        Returns:
        an InputStream
        Throws:
        IOException - this is typically thrown by the DataHandler. Refer to the documentation for jakarta.activation.DataHandler for more details.
        See Also:
        getContentStream(), DataHandler.getInputStream()

      • getRawInputStream

        public InputStream getRawInputStream()
                              throws MessagingException
        Return an InputStream to the raw data with any Content-Transfer-Encoding intact. This method is useful if the "Content-Transfer-Encoding" header is incorrect or corrupt, which would prevent the getInputStream method or getContent method from returning the correct data. In such a case the application may use this method and attempt to decode the raw data itself.

        This implementation simply calls the getContentStream method.

        Returns:
        input stream
        Throws:
        MessagingException - in case of error
        Since:
        JavaMail 1.2
        See Also:
        getInputStream(), getContentStream()

      • getDataHandler

        public jakarta.activation.DataHandler getDataHandler()
        Return a DataHandler for this body part's content.

        The implementation provided here works just like the the implementation in MimeMessage.

        Returns:
        data handler

      • getContent

        public Object getContent()
                  throws IOException
        Return the content as a java object. The type of the object returned is of course dependent on the content itself. For example, the native format of a text/plain content is usually a String object. The native format for a "multipart" content is always a MimeMultipart subclass. For content types that are unknown to the DataHandler system, an input stream is returned as the content.

        This implementation obtains the content from the DataHandler. That is, it invokes getDataHandler().getContent();

        Returns:
        Object
        Throws:
        IOException - this is typically thrown by the DataHandler. Refer to the documentation for jakarta.activation.DataHandler for more details.

      • setDataHandler

        public void setDataHandler​(jakarta.activation.DataHandler dh)
        This method provides the mechanism to set this body part's content. The given DataHandler object should wrap the actual content.
        Parameters:
        dh - The DataHandler for the content
        Throws:
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.

      • setContent

        public void setContent​(Object o,
                       String type)
        A convenience method for setting this body part's content.

        The content is wrapped in a DataHandler object. Note that a DataContentHandler class for the specified type should be available to the JavaMail implementation for this to work right. That is, to do setContent(foobar, "application/x-foobar"), a DataContentHandler for "application/x-foobar" should be installed. Refer to the Java Activation Framework for more information.

        Parameters:
        o - the content object
        type - Mime type of the object
        Throws:
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.

      • setText

        public void setText​(String text)
        Convenience method that sets the given String as this part's content, with a MIME type of "text/plain". If the string contains non US-ASCII characters, it will be encoded using the platform's default charset. The charset is also used to set the "charset" parameter.

        Note that there may be a performance penalty if text is large, since this method may have to scan all the characters to determine what charset to use.

        If the charset is already known, use the setText() version that takes the charset parameter.

        Parameters:
        text - string
        See Also:
        setText(String text, String charset)

      • setText

        public void setText​(String text,
                    String charset)
        Convenience method that sets the given String as this part's content, with a MIME type of "text/plain" and the specified charset. The given Unicode string will be charset-encoded using the specified charset. The charset is also used to set the "charset" parameter.
        Parameters:
        text - string
        charset - character set

      • setContent

        public void setContent​(MimeMultipart mp)
        This method sets the body part's content to a MimeMultipart object.
        Parameters:
        mp - The multipart object that is the Message's content
        Throws:
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.

      • writeTo

        public void writeTo​(OutputStream os)
             throws IOException,
                    MessagingException
        Output the body part as an RFC 822 format stream.
        Parameters:
        os - output stream
        Throws:
        MessagingException - in case of error
        IOException - if an error occurs writing to the stream or if an error is generated by the jakarta.activation layer.
        See Also:
        DataHandler.writeTo(java.io.OutputStream)

      • getHeader

        public String[] getHeader​(String name)
        Get all the headers for this header_name. Note that certain headers may be encoded as per RFC 2047 if they contain non US-ASCII characters and these should be decoded.
        Parameters:
        name - name of header
        Returns:
        array of headers
        See Also:
        MimeUtility

      • getHeader

        public String getHeader​(String name,
                        String delimiter)
        Get all the headers for this header name, returned as a single String, with headers separated by the delimiter. If the delimiter is null, only the first header is returned.
        Parameters:
        name - the name of this header
        delimiter - delimiter between fields in returned string
        Returns:
        the value fields for all headers with this name

      • setHeader

        public void setHeader​(String name,
                      String value)
        Set the value for this header_name. Replaces all existing header values with this new value. Note that RFC 822 headers must contain only US-ASCII characters, so a header that contains non US-ASCII characters must be encoded as per the rules of RFC 2047.
        Parameters:
        name - header name
        value - header value
        See Also:
        MimeUtility

      • addHeader

        public void addHeader​(String name,
                      String value)
        Add this value to the existing values for this header_name. Note that RFC 822 headers must contain only US-ASCII characters, so a header that contains non US-ASCII characters must be encoded as per the rules of RFC 2047.
        Parameters:
        name - header name
        value - header value
        See Also:
        MimeUtility

      • removeHeader

        public void removeHeader​(String name)
        Remove all headers with this name.
        Parameters:
        name - header name

      • getAllHeaders

        public FinalArrayList<com.sun.xml.messaging.saaj.packaging.mime.internet.hdr> getAllHeaders()
        Return all the headers from this Message as an Enumeration of Header objects.
        Returns:
        all headers

      • addHeaderLine

        public void addHeaderLine​(String line)
        Add a header line to this body part
        Parameters:
        line - header line to add

      • updateHeaders

        protected void updateHeaders()
                      throws MessagingException
        Examine the content of this body part and update the appropriate MIME headers. Typical headers that get set here are Content-Type and Content-Transfer-Encoding. Headers might need to be updated in two cases:
        - A message being crafted by a mail application will certainly need to activate this method at some point to fill up its internal headers.
        - A message read in from a Store will have obtained all its headers from the store, and so doesn't need this. However, if this message is editable and if any edits have been made to either the content or message structure, we might need to resync our headers.
        In both cases this method is typically called by the Message.saveChanges method.
        Throws:
        MessagingException - in case of error.