Package org.apache.commons.mail.util

Class MimeMessageParser

  • public class MimeMessageParser
extends Object
    Parses a MimeMessage and stores the individual parts such a plain text, HTML text and attachments.
    Since:
    1.3

    • Constructor Detail

      • MimeMessageParser

        public MimeMessageParser​(MimeMessage message)
        Constructs an instance with the MimeMessage to be extracted.
        Parameters:
        message - the message to parse

    • Method Detail

      • getTo

        public List<Address> getTo()
                    throws Exception
        Returns:
        the 'to' recipients of the message
        Throws:
        Exception - determining the recipients failed

      • getCc

        public List<Address> getCc()
                    throws Exception
        Returns:
        the 'cc' recipients of the message
        Throws:
        Exception - determining the recipients failed

      • getBcc

        public List<Address> getBcc()
                     throws Exception
        Returns:
        the 'bcc' recipients of the message
        Throws:
        Exception - determining the recipients failed

      • getFrom

        public String getFrom()
               throws Exception
        Returns:
        the 'from' field of the message
        Throws:
        Exception - parsing the mime message failed

      • getReplyTo

        public String getReplyTo()
                  throws Exception
        Returns:
        the 'replyTo' address of the email
        Throws:
        Exception - parsing the mime message failed

      • getSubject

        public String getSubject()
                  throws Exception
        Returns:
        the mail subject
        Throws:
        Exception - parsing the mime message failed

      • getMimeMessage

        public MimeMessage getMimeMessage()
        Returns:
        Returns the mimeMessage.

      • isMultipart

        public boolean isMultipart()
        Returns:
        Returns the isMultiPart.

      • getPlainContent

        public String getPlainContent()
        Returns:
        Returns the plainContent if any

      • getAttachmentList

        public List<DataSource> getAttachmentList()
        Returns:
        Returns the attachmentList.

      • getContentIds

        public Collection<String> getContentIds()
        Returns a collection of all content-ids in the parsed message.

        The content-ids are stripped of any angle brackets, i.e. "part1" instead of "<part1>".

        Returns:
        the collection of content ids.
        Since:
        1.3.4

      • getHtmlContent

        public String getHtmlContent()
        Returns:
        Returns the htmlContent if any

      • hasPlainContent

        public boolean hasPlainContent()
        Returns:
        true if a plain content is available

      • hasHtmlContent

        public boolean hasHtmlContent()
        Returns:
        true if HTML content is available

      • hasAttachments

        public boolean hasAttachments()
        Returns:
        true if attachments are available

      • findAttachmentByName

        public DataSource findAttachmentByName​(String name)
        Find an attachment using its name.
        Parameters:
        name - the name of the attachment
        Returns:
        the corresponding datasource or null if nothing was found

      • findAttachmentByCid

        public DataSource findAttachmentByCid​(String cid)
        Find an attachment using its content-id.

        The content-id must be stripped of any angle brackets, i.e. "part1" instead of "<part1>".

        Parameters:
        cid - the content-id of the attachment
        Returns:
        the corresponding datasource or null if nothing was found
        Since:
        1.3.4