com.amazonaws.services.simpleemail

クラス AWSJavaMailTransport

java.lang.Object

javax.mail.Service

javax.mail.Transport

com.amazonaws.services.simpleemail.AWSJavaMailTransport

public class AWSJavaMailTransport
extends javax.mail.Transport

Amazon Web Service の SES サービスを使用した転送インターフェースの実装クラスです。 JavaMail で指定するプロトコル名は "aws" になります。 SES サービスを通じてメッセージを送信するためには、 AWS の認証情報 (http://aws.amazon.com/security-credentials) を JavaMail の Session オブジェクトのプロパティ (mail.aws.user および mail.aws.password) に設定するか、もしくは connect() メソッドの引数、または Session オブジェクトの setPasswordAuthentication メソッドの引数に指定する必要があります。 セッションのプロパティに設定した値よりも、 connect メソッドに渡したパラメタや、PasswordAuthentication の情報が優先して使用されます。 接続時には、 AWS Access Key をユーザ名に、AWS Secret Key をパスワードに指定してください。

この実装クラスは MIME エンコード済みのメッセージ (詳しくは MimeMessage クラス参照) および RFC822 に準拠した電子メールアドレスの形式 (詳しくは InternetAddress クラス参照) にのみ 対応しています。

フィールドの概要

フィールド

修飾子とタイプ	フィールドと説明
static java.lang.String	AWS_ACCESS_KEY_PROPERTY
static java.lang.String	AWS_EMAIL_SERVICE_ENDPOINT_PROPERTY
static java.lang.String	AWS_SECRET_KEY_PROPERTY

クラスから継承されたフィールド javax.mail.Service

debug, session, url

コンストラクタの概要

コンストラクタ

コンストラクタと説明
AWSJavaMailTransport(javax.mail.Session session, javax.mail.URLName urlname)

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
<X extends AmazonWebServiceRequest> X	appendUserAgent(X request, java.lang.String userAgent)
void	close()
protected boolean	protocolConnect(java.lang.String host, int port, java.lang.String awsAccessKey, java.lang.String awsSecretKey) 新しい AmazonSimpleEmailServiceClient クライアントの初期設定を行います。
void	sendMessage(javax.mail.Message msg, javax.mail.Address[] addresses) Amazon の SES サービスを利用して MIME 形式のメッセージを指定した宛先に送信します。

クラスから継承されたメソッド javax.mail.Transport

addTransportListener, notifyTransportListeners, removeTransportListener, send, send

クラスから継承されたメソッド javax.mail.Service

addConnectionListener, connect, connect, connect, connect, finalize, getURLName, isConnected, notifyConnectionListeners, queueEvent, removeConnectionListener, setConnected, setURLName, toString

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

AWS_EMAIL_SERVICE_ENDPOINT_PROPERTY

public static final java.lang.String AWS_EMAIL_SERVICE_ENDPOINT_PROPERTY

関連項目:

定数フィールド値

AWS_SECRET_KEY_PROPERTY

public static final java.lang.String AWS_SECRET_KEY_PROPERTY

関連項目:

定数フィールド値

AWS_ACCESS_KEY_PROPERTY

public static final java.lang.String AWS_ACCESS_KEY_PROPERTY

関連項目:

定数フィールド値

コンストラクタの詳細

AWSJavaMailTransport

public AWSJavaMailTransport(javax.mail.Session session,
                    javax.mail.URLName urlname)

メソッドの詳細

sendMessage

public void sendMessage(javax.mail.Message msg,
               javax.mail.Address[] addresses)
                 throws javax.mail.MessagingException,
                        javax.mail.SendFailedException

Amazon の SES サービスを利用して MIME 形式のメッセージを指定した宛先に送信します。 このメソッドに指定したアドレスは、メッセージ内のアドレスに統合されます (重複したアドレスは取り除かれます)

定義:

sendMessage クラス内 javax.mail.Transport

パラメータ:

msg - 送信する MIME 形式の電子メールメッセージ

addresses - メッセージに追加する電子メールアドレス (RFC-822形式)

例外:

javax.mail.MessagingException

javax.mail.SendFailedException

protocolConnect

protected boolean protocolConnect(java.lang.String host,
                      int port,
                      java.lang.String awsAccessKey,
                      java.lang.String awsSecretKey)

新しい AmazonSimpleEmailServiceClient クライアントの初期設定を行います。 このメソッドは通常 connect() から間接的に呼び出されます。 インスタンス化もしくは close() 後の再オープン時にのみ呼び出されます。 サービスにユーザが接続中の場合には、セッションプロパティのユーザ名およびパスワードに (NULL/空文字ではない) 値を設定しても (mail.aws.user と mail.aws.password で) 上書きされます。 デフォルトの HTTPS のエンドポイントは電子メールクライアントにより設定されていますが、 引数もしくは mail.aws.host に設定すれば変更可能です。 ユーザ名とパスワード同様に、引数はプロパティファイルよりも優先します。

オーバーライド:

protocolConnect クラス内 javax.mail.Service

パラメータ:

host - オプション - AWS SES のエンドポイントのホスト名

awsAccessKey - オプション - AWS アクセスキー (ここで指定しない場合にはプロパティファイルに指定してください)

awsSecretKey - オプション - AWS のシークレットキー (ここで指定しない場合にはプロパティファイルに指定してください)

戻り値:

得られた認証情報が空でなければ true を返します

close

public void close()
           throws javax.mail.MessagingException

オーバーライド:

close クラス内 javax.mail.Service

例外:

javax.mail.MessagingException

appendUserAgent

public <X extends AmazonWebServiceRequest> X appendUserAgent(X request,
                                                    java.lang.String userAgent)