Class AWSJavaMailTransport

  • All Implemented Interfaces:
    AutoCloseable

    public class AWSJavaMailTransport
    extends javax.mail.Transport
    A transport implementation using Amazon Web Service's E-mail Service. For JavaMail purposes this transport implementation uses the "aws" protocol. In order to send messages through the E-mail Service your AWS Credentials (http://aws.amazon.com/security-credentials) need to be either in the JavaMail Session's Properties (mail.aws.user and mail.aws.password), passed into the connect() method, or set in the Session's setPasswordAuthentication method. Parameters passed into the connect method as well as PasswordAuthentication information supersedes the properties field for a particular session. When connecting your AWS Access Key is your username and your AWS Secret Key is your password.

    This transport implementation only accepts MIME encoded messages (see MimeMessage class) and RFC822 E-mail addresses (see InternetAddress class).

    • Constructor Detail

      • AWSJavaMailTransport

        public AWSJavaMailTransport​(javax.mail.Session session,
                                    javax.mail.URLName urlname)
    • Method Detail

      • sendMessage

        public void sendMessage​(javax.mail.Message msg,
                                javax.mail.Address[] addresses)
                         throws javax.mail.MessagingException,
                                javax.mail.SendFailedException
        Sends a MIME message through Amazon's E-mail Service with the specified recipients. Addresses that are passed into this method are merged with the ones already embedded in the message (duplicates are removed).
        Specified by:
        sendMessage in class javax.mail.Transport
        Parameters:
        msg - A Mime type e-mail message to be sent
        addresses - Additional e-mail addresses (RFC-822) to be included in the message
        Throws:
        javax.mail.MessagingException
        javax.mail.SendFailedException
      • protocolConnect

        protected boolean protocolConnect​(String host,
                                          int port,
                                          String awsAccessKey,
                                          String awsSecretKey)
        Sets up a new AmazonSimpleEmailServiceClient. This method is typically called indirectly from the connect() method and should only be called on instantiation or to reopen after a close(). If a non-null or empty User and Password passed in session properties are overridden while user remains connected (mail.aws.user and mail.aws.password). The default https endpoint is specified by the mail client; however, it can be overridden by either passing in a value or setting mail.aws.host. Like the user and password, the variable that is passed in takes preference over the properties file.
        Overrides:
        protocolConnect in class javax.mail.Service
        Parameters:
        host - Optional - host specifies the AWS E-mail endpoint
        awsAccessKey - Optional - AWS Access Key (otherwise must specify through properties file)
        awsSecretKey - Optional - AWS Secret key (otherwise must specify through properties file)
        Returns:
        Returns true if non-empty credentials are given
      • close

        public void close()
                   throws javax.mail.MessagingException
        Specified by:
        close in interface AutoCloseable
        Overrides:
        close in class javax.mail.Service
        Throws:
        javax.mail.MessagingException
      • getLastMessageId

        public String getLastMessageId()

        The unique message identifier ot the last message sent by sendMessage

        Returns:
        The unique message identifier sent by the last sendMessage action.