Package org.apache.commons.mail.util

Class MimeMessageUtils

  • public final class MimeMessageUtils
extends java.lang.Object
    Creates MimeMessage instances and other helper methods.
    Since:
    1.3

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static javax.mail.internet.MimeMessage createMimeMessage​(javax.mail.Session session, byte[] source)
      Creates a MimeMessage.
      static javax.mail.internet.MimeMessage createMimeMessage​(javax.mail.Session session, java.io.File source)
      Creates a MimeMessage.
      static javax.mail.internet.MimeMessage createMimeMessage​(javax.mail.Session session, java.io.InputStream source)
      Creates a MimeMessage.
      static javax.mail.internet.MimeMessage createMimeMessage​(javax.mail.Session session, java.lang.String source)
      Creates a MimeMessage using the platform's default character encoding.
      static javax.mail.internet.MimeMessage createMimeMessage​(javax.mail.Session session, java.nio.file.Path source, java.nio.file.OpenOption... options)
      Creates a MimeMessage.
      static void writeMimeMessage​(javax.mail.internet.MimeMessage mimeMessage, java.io.File resultFile)
      Writes a MimeMessage into a file.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • createMimeMessage

        public static javax.mail.internet.MimeMessage createMimeMessage​(javax.mail.Session session,
                                                                byte[] source)
                                                         throws javax.mail.MessagingException,
                                                                java.io.IOException
        Creates a MimeMessage.
        Parameters:
        session - the mail session.
        source - the input data.
        Returns:
        the MimeMessage.
        Throws:
        javax.mail.MessagingException - creating the MimeMessage failed.
        java.io.IOException - creating the MimeMessage failed.

      • createMimeMessage

        public static javax.mail.internet.MimeMessage createMimeMessage​(javax.mail.Session session,
                                                                java.io.File source)
                                                         throws javax.mail.MessagingException,
                                                                java.io.IOException
        Creates a MimeMessage.
        Parameters:
        session - the mail session.
        source - the input data.
        Returns:
        the MimeMessage.
        Throws:
        javax.mail.MessagingException - creating the MimeMessage failed.
        java.io.IOException - creating the MimeMessage failed.

      • createMimeMessage

        public static javax.mail.internet.MimeMessage createMimeMessage​(javax.mail.Session session,
                                                                java.io.InputStream source)
                                                         throws javax.mail.MessagingException
        Creates a MimeMessage.
        Parameters:
        session - the mail session.
        source - the input data.
        Returns:
        the MimeMessage.
        Throws:
        javax.mail.MessagingException - creating the MimeMessage failed.

      • createMimeMessage

        public static javax.mail.internet.MimeMessage createMimeMessage​(javax.mail.Session session,
                                                                java.nio.file.Path source,
                                                                java.nio.file.OpenOption... options)
                                                         throws javax.mail.MessagingException,
                                                                java.io.IOException
        Creates a MimeMessage.
        Parameters:
        session - the mail session.
        source - the input data.
        options - options specifying how the file is opened.
        Returns:
        the MimeMessage.
        Throws:
        javax.mail.MessagingException - creating the MimeMessage failed.
        java.io.IOException - creating the MimeMessage failed.

      • createMimeMessage

        public static javax.mail.internet.MimeMessage createMimeMessage​(javax.mail.Session session,
                                                                java.lang.String source)
                                                         throws javax.mail.MessagingException,
                                                                java.io.IOException
        Creates a MimeMessage using the platform's default character encoding.
        Parameters:
        session - the mail session.
        source - the input data.
        Returns:
        the MimeMessage.
        Throws:
        javax.mail.MessagingException - creating the MimeMessage failed.
        java.io.IOException - creating the MimeMessage failed.

      • writeMimeMessage

        public static void writeMimeMessage​(javax.mail.internet.MimeMessage mimeMessage,
                                    java.io.File resultFile)
                             throws javax.mail.MessagingException,
                                    java.io.IOException
        Writes a MimeMessage into a file.
        Parameters:
        mimeMessage - the MimeMessage to write.
        resultFile - the file containing the MimeMessage.
        Throws:
        javax.mail.MessagingException - accessing MimeMessage failed.
        java.io.IOException - writing the MimeMessage failed.