Package javax.mail.internet

Class MimeBodyPart

  • All Implemented Interfaces:
    MimePart, Part
    Direct Known Subclasses:
    IMAPBodyPart, PreencodedMimeBodyPart
    public class MimeBodyPart
extends BodyPart
implements MimePart
    This class represents a MIME body part. It implements the BodyPart abstract class and the MimePart interface. 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.

    See Also:
    Part, MimePart, 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 - for failures

      • MimeBodyPart

        public MimeBodyPart​(InternetHeaders headers,
                    byte[] content)
             throws MessagingException
        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.
        Throws:
        MessagingException - for failures

    • Method Detail

      • getSize

        public int getSize()
            throws MessagingException
        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.

        Specified by:
        getSize in interface Part
        Returns:
        size in bytes, or -1 if not known
        Throws:
        MessagingException - for failures

      • getLineCount

        public int getLineCount()
                 throws MessagingException
        Return the number of lines for the content of this Part. 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.

        Specified by:
        getLineCount in interface Part
        Returns:
        number of lines, or -1 if not known
        Throws:
        MessagingException - for failures

      • getContentType

        public String getContentType()
                      throws MessagingException
        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.

        Specified by:
        getContentType in interface Part
        Returns:
        Content-Type of this body part
        Throws:
        MessagingException - for failures
        See Also:
        DataHandler

      • isMimeType

        public boolean isMimeType​(String mimeType)
                   throws MessagingException
        Is this Part 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 Part 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.

        Specified by:
        isMimeType in interface Part
        Parameters:
        mimeType - the MIME type to test
        Returns:
        true if this part is of the specified type
        Throws:
        MessagingException - for failures

      • getDisposition

        public String getDisposition()
                      throws MessagingException
        Returns the disposition from 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.

        Specified by:
        getDisposition in interface Part
        Returns:
        disposition of this part, or null if unknown
        Throws:
        MessagingException - for failures
        See Also:
        headers

      • 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.

        Specified by:
        getEncoding in interface MimePart
        Returns:
        content-transfer-encoding
        Throws:
        MessagingException - for failures
        See Also:
        headers

      • getContentID

        public String getContentID()
                    throws MessagingException
        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.

        Specified by:
        getContentID in interface MimePart
        Returns:
        content-ID
        Throws:
        MessagingException - for failures

      • setContentID

        public void setContentID​(String cid)
                  throws MessagingException
        Set the "Content-ID" header field of this body part. If the cid parameter is null, any existing "Content-ID" is removed.
        Parameters:
        cid - the Content-ID
        Throws:
        IllegalWriteException - if the underlying implementation does not support modification
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.
        MessagingException - for other failures
        Since:
        JavaMail 1.3

      • getContentMD5

        public String getContentMD5()
                     throws MessagingException
        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.

        Specified by:
        getContentMD5 in interface MimePart
        Returns:
        content-MD5
        Throws:
        MessagingException - for failures

      • getContentLanguage

        public String[] getContentLanguage()
                            throws MessagingException
        Get the languages specified in the Content-Language header of this MimePart. 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.

        Specified by:
        getContentLanguage in interface MimePart
        Returns:
        array of content language strings
        Throws:
        MessagingException - for failures

      • setContentLanguage

        public void setContentLanguage​(String[] languages)
                        throws MessagingException
        Set the Content-Language header of this MimePart. The Content-Language header is defined by RFC 1766.
        Specified by:
        setContentLanguage in interface MimePart
        Parameters:
        languages - array of language tags
        Throws:
        IllegalWriteException - if the underlying implementation does not support modification
        MessagingException

      • getDescription

        public String getDescription()
                      throws MessagingException
        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.

        Specified by:
        getDescription in interface Part
        Returns:
        content description
        Throws:
        MessagingException - for failures

      • 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.

        Specified by:
        setDescription in interface Part
        Parameters:
        description - content description
        Throws:
        IllegalWriteException - if the underlying implementation does not support modification
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.
        MessagingException - otherwise; 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:
        IllegalWriteException - if the underlying implementation does not support modification
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.
        MessagingException - otherwise; 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.

        If the mail.mime.decodefilename System property is set to true, the MimeUtility.decodeText method will be used to decode the filename. While such encoding is not supported by the MIME spec, many mailers use this technique to support non-ASCII characters in filenames. The default value of this property is false.

        Specified by:
        getFileName in interface Part
        Returns:
        filename
        Throws:
        MessagingException - for failures

      • 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. For compatibility with older mailers, the "name" parameter of the "Content-Type" header is also set.

        If the mail.mime.encodefilename System property is set to true, the MimeUtility.encodeText method will be used to encode the filename. While such encoding is not supported by the MIME spec, many mailers use this technique to support non-ASCII characters in filenames. The default value of this property is false.

        Specified by:
        setFileName in interface Part
        Parameters:
        filename - the file name
        Throws:
        IllegalWriteException - if the underlying implementation does not support modification
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.
        MessagingException - for other failures

      • 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:
        an InputStream containing the raw bytes
        Throws:
        MessagingException - for failures
        Since:
        JavaMail 1.2
        See Also:
        getInputStream(), getContentStream()

      • getContent

        public Object getContent()
                  throws IOException,
                         MessagingException
        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 Multipart 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(); If the content is a Multipart or Message object and was created by parsing a stream, the object is cached and returned in subsequent calls so that modifications to the content will not be lost.

        Specified by:
        getContent in interface Part
        Returns:
        Object
        Throws:
        IOException - this is typically thrown by the DataHandler. Refer to the documentation for javax.activation.DataHandler for more details.
        MessagingException - for other failures
        See Also:
        DataHandler.getContent()

      • setContent

        public void setContent​(Object o,
                       String type)
                throws MessagingException
        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.

        Specified by:
        setContent in interface Part
        Parameters:
        o - the content object
        type - Mime type of the object
        Throws:
        IllegalWriteException - if the underlying implementation does not support modification of existing values
        IllegalStateException - if this body part is obtained from a READ_ONLY folder.
        MessagingException - for other failures

      • setText

        public void setText​(String text)
             throws MessagingException
        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 method that takes the charset parameter.

        Specified by:
        setText in interface MimePart
        Specified by:
        setText in interface Part
        Parameters:
        text - the text content to set
        Throws:
        MessagingException - if an error occurs
        See Also:
        setText(String text, String charset)

      • setText

        public void setText​(String text,
                    String charset)
             throws MessagingException
        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.
        Specified by:
        setText in interface MimePart
        Parameters:
        text - the text content to set
        charset - the charset to use for the text
        Throws:
        MessagingException - if an error occurs

      • setText

        public void setText​(String text,
                    String charset,
                    String subtype)
             throws MessagingException
        Convenience method that sets the given String as this part's content, with a primary MIME type of "text" and the specified MIME subtype. The given Unicode string will be charset-encoded using the specified charset. The charset is also used to set the "charset" parameter.
        Specified by:
        setText in interface MimePart
        Parameters:
        text - the text content to set
        charset - the charset to use for the text
        subtype - the MIME subtype to use (e.g., "html")
        Throws:
        MessagingException - if an error occurs
        Since:
        JavaMail 1.4

      • attachFile

        public void attachFile​(File file)
                throws IOException,
                       MessagingException
        Use the specified file to provide the data for this part. The simple file name is used as the file name for this part and the data in the file is used as the data for this part. The encoding will be chosen appropriately for the file data. The disposition of this part is set to Part.ATTACHMENT.
        Parameters:
        file - the File object to attach
        Throws:
        IOException - errors related to accessing the file
        MessagingException - message related errors
        Since:
        JavaMail 1.4

      • attachFile

        public void attachFile​(String file)
                throws IOException,
                       MessagingException
        Use the specified file to provide the data for this part. The simple file name is used as the file name for this part and the data in the file is used as the data for this part. The encoding will be chosen appropriately for the file data.
        Parameters:
        file - the name of the file to attach
        Throws:
        IOException - errors related to accessing the file
        MessagingException - message related errors
        Since:
        JavaMail 1.4

      • attachFile

        public void attachFile​(File file,
                       String contentType,
                       String encoding)
                throws IOException,
                       MessagingException
        Use the specified file with the specified Content-Type and Content-Transfer-Encoding to provide the data for this part. If contentType or encoding are null, appropriate values will be chosen. The simple file name is used as the file name for this part and the data in the file is used as the data for this part. The disposition of this part is set to Part.ATTACHMENT.
        Parameters:
        file - the File object to attach
        contentType - the Content-Type, or null
        encoding - the Content-Transfer-Encoding, or null
        Throws:
        IOException - errors related to accessing the file
        MessagingException - message related errors
        Since:
        JavaMail 1.5

      • attachFile

        public void attachFile​(String file,
                       String contentType,
                       String encoding)
                throws IOException,
                       MessagingException
        Use the specified file with the specified Content-Type and Content-Transfer-Encoding to provide the data for this part. If contentType or encoding are null, appropriate values will be chosen. The simple file name is used as the file name for this part and the data in the file is used as the data for this part. The disposition of this part is set to Part.ATTACHMENT.
        Parameters:
        file - the name of the file
        contentType - the Content-Type, or null
        encoding - the Content-Transfer-Encoding, or null
        Throws:
        IOException - errors related to accessing the file
        MessagingException - message related errors
        Since:
        JavaMail 1.5

      • saveFile

        public void saveFile​(File file)
              throws IOException,
                     MessagingException
        Save the contents of this part in the specified file. The content is decoded and saved, without any of the MIME headers.
        Parameters:
        file - the File object to write to
        Throws:
        IOException - errors related to accessing the file
        MessagingException - message related errors
        Since:
        JavaMail 1.4

      • saveFile

        public void saveFile​(String file)
              throws IOException,
                     MessagingException
        Save the contents of this part in the specified file. The content is decoded and saved, without any of the MIME headers.
        Parameters:
        file - the name of the file to write to
        Throws:
        IOException - errors related to accessing the file
        MessagingException - message related errors
        Since:
        JavaMail 1.4

      • getHeader

        public String[] getHeader​(String name)
                   throws MessagingException
        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.
        Specified by:
        getHeader in interface Part
        Parameters:
        name - name of header
        Returns:
        array of headers
        Throws:
        MessagingException - for failures
        See Also:
        MimeUtility

      • getHeader

        public String getHeader​(String name,
                        String delimiter)
                 throws MessagingException
        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.
        Specified by:
        getHeader in interface MimePart
        Parameters:
        name - the name of this header
        delimiter - delimiter between fields in returned string
        Returns:
        the value fields for all headers with this name
        Throws:
        MessagingException - for failures

      • setHeader

        public void setHeader​(String name,
                      String value)
               throws MessagingException
        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.
        Specified by:
        setHeader in interface Part
        Parameters:
        name - header name
        value - header value
        Throws:
        IllegalWriteException - if the underlying implementation does not support modification of existing values
        MessagingException - for other failures
        See Also:
        MimeUtility

      • addHeader

        public void addHeader​(String name,
                      String value)
               throws MessagingException
        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.
        Specified by:
        addHeader in interface Part
        Parameters:
        name - header name
        value - header value
        Throws:
        IllegalWriteException - if the underlying implementation does not support modification of existing values
        MessagingException - for other failures
        See Also:
        MimeUtility

      • getMatchingHeaderLines

        public Enumeration<String> getMatchingHeaderLines​(String[] names)
                                           throws MessagingException
        Get matching header lines as an Enumeration of Strings. A Header line is a raw RFC 822 header line, containing both the "name" and "value" field.
        Specified by:
        getMatchingHeaderLines in interface MimePart
        Parameters:
        names - the headers to return
        Returns:
        an Enumeration of Strings
        Throws:
        MessagingException - for failures

      • getNonMatchingHeaderLines

        public Enumeration<String> getNonMatchingHeaderLines​(String[] names)
                                              throws MessagingException
        Get non-matching header lines as an Enumeration of Strings. A Header line is a raw RFC 822 header line, containing both the "name" and "value" field.
        Specified by:
        getNonMatchingHeaderLines in interface MimePart
        Parameters:
        names - the headers to not return
        Returns:
        an Enumeration of Strings
        Throws:
        MessagingException - for failures