MailSenderオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.8 |
since | 5.0 |
メールを送信するオブジェクトです。
- キャラクターセット、エンコード
このオブジェクトが保持するメールのキャラクターセット、エンコーディングの設定は ロケールに依存します。ロケール毎の設定は定義ファイルにより決定されます。
WEB-INF/conf/javamail-config/javamail-config_[ロケール].xml として、定義ファイルを配置してください。
指定可能なキーの一覧
charset キャラクターセット mimeEncoding MIMEエンコード (B or Q) contentTransferEncoding ボディのエンコード - SMTP Authentication
MailSenderオブジェクトは SMTP Authentication に対応しています。有効にする場合は WEB-INF/conf/javamail-config/javamail-config.xml を編集してください。
enable SMTP Authの有効
(true or false)user ユーザID password パスワード - SMTPS(SMTP over SSL)
MailSenderオブジェクトは SMTPS(SMTP over SSL) に対応しています。有効にする場合は /conf/javamail-config/javamail-config.xml のsmtpsタグを編集してください。
SMTPSを利用するにはJavaランタイムがSMTPサーバのSSL証明書を信頼済みである必要があります。
SSL証明書が信頼されていない場合、javax.net.ssl.SSLHandshakeExceptionがスローされSMTPサーバに接続することができません。
JavaランタイムがSMTPサーバのSSL証明書を信頼済みであることを確認して使用してください。
enable SMTPSの有効
(true or false)starttls TLS/STARTTLSによる暗号化
(true or false) - メール送信リスナ
MailSenderオブジェクトはリスナを実装することで、メール送信前に任意の処理を実行することが可能です。
リスナでは送信メールの情報を参照したり、送信を中止することも可能です。
リスナはJavaのクラスを実装する必要があります。 詳しい実装方法はjp.co.intra_mart.foundation.mail.javamail.listener.MailSendListenerインタフェースを参照してください。 - Storageオブジェクトを添付ファイルに設定
PublicStorage、SessionScopeStorage、SystemStorageなどのストレージオブジェクトを添付ファイルに設定することが可能です。(intra-mart Accel Platform 2015 Winter 以降で使用可能)function init(request) { var mail = new MailSender(); var storage = new PublicStorage("test.txt"); mail.setFrom("foo@example.com"); mail.addTo("bar@example.com"); mail.setSubject("subject"); mail.setText("本文"); mail.addAttachment("test.txt", storage); var result = mail.send(); }
- HTMLメールの送信
HTML形式の文書とテキスト文書のマルチパート形式のメールを送信することが可能です。(intra-mart Accel Platform 2015 Winter 以降で使用可能)function init(request) { var mail = new MailSender(); mail.setFrom("foo@example.com"); mail.addTo("bar@example.com"); mail.setSubject("subject"); mail.setText("本文"); mail.setHTML("<html><body>本文</body></html>"); var result = mail.send(); }
- HTMLメールにインライン画像を挿入
ストレージオブジェクトから取得した画像を、HTMLメールに挿入することが可能です。(intra-mart Accel Platform 2015 Winter 以降で使用可能)function init(request) { var mail = new MailSender(); var storage = new PublicStorage("test.gif"); mail.setFrom("foo@example.com"); mail.addTo("bar@example.com"); mail.setSubject("subject"); mail.setText("本文"); mail.setHTML("<html><body>本文<img src=\"cid:image1\"></body></html>"); mail.addHTMLImage("test.gif", storage, "image1"); var result = mail.send(); }
コンストラクタの概要
MailSender (String locale , String serverId ) コンストラクタ。 |
メソッドの概要
返却値の型 | メソッド名 |
---|---|
void | addAttachment (String filename , Object file ) 添付ファイルを追加します。 |
void | addBcc (String address , String personal ) Bccを追加します。 |
void | addCc (String address , String personal ) Ccを追加します。 |
void | addHTMLImage (String filename , Storage storage , String cid ) HTMLメールのインライン画像を追加します。 |
void | addHeader (String name , String value ) メールヘッダーを追加します。 |
void | addReplyTo (String replyto ) ReplyToを追加します。 |
void | addTo (String address , String personal ) Toを追加します。 |
String | getErrorMessage () メール送信エラー時のメッセージを返します。 |
Boolean | send () メールを送信します。 |
void | setFrom (String address , String personal ) Fromを設定します。 |
void | setHTML (String html ) HTML文書を設定します。 |
void | setSubject (String subject ) Subjectを設定します。 |
void | setText (String text ) 本文を設定します。 |
コンストラクタの詳細
MailSender (String locale , String serverId )
コンストラクタ。
MailSenderオブジェクトを生成します。 引数のlocaleおよびserverIdは省略可能です。 locale、serverIdの両方を省略する場合、以下のように引数なしでインスタンスを生成します。 new MailSender();localeを省略した場合は、アカウントコンテキストのロケールでMailSenderオブジェクトが生成されます。 localeを省略し、serverIdのみ指定したい場合は以下のように第1引数にnullを指定してインスタンスを生成します。 new MailSender(null, serverId);serverIdを指定した場合は標準のメール設定のSMTPサーバ設定に従ってMailSenderオブジェクトが生成されます。 serverIdを省略し、localeのみ指定した場合は以下のようにlocaleのみ指定してインスタンスを生成します。 省略したserverIdはテナントIDが利用されます。 new MailSender(locale);
パラメータ
|
メソッドの詳細
void addAttachment (String filename , Object file )
添付ファイルを追加します。
パラメータ
返却値
|
void addBcc (String address , String personal )
Bccを追加します。
パラメータ
返却値
|
void addCc (String address , String personal )
Ccを追加します。
パラメータ
返却値
|
void addHTMLImage (String filename , Storage storage , String cid )
HTMLメールのインライン画像を追加します。
このメソッドはintra-mart Accel Platform 2015 Winter 以降で使用可能です。
パラメータ
返却値
|
void addHeader (String name , String value )
メールヘッダーを追加します。
パラメータ
返却値
|
void addReplyTo (String replyto )
ReplyToを追加します。
パラメータ
返却値
|
void addTo (String address , String personal )
Toを追加します。
パラメータ
返却値
|
String getErrorMessage ()
メール送信エラー時のメッセージを返します。
返却値
|
Boolean send ()
メールを送信します。
返却値
|
void setFrom (String address , String personal )
Fromを設定します。
パラメータ
返却値
|
void setHTML (String html )
HTML文書を設定します。
このメソッドはintra-mart Accel Platform 2015 Winter 以降で使用可能です。
パラメータ
返却値
|
void setSubject (String subject )
Subjectを設定します。
パラメータ
返却値
|
void setText (String text )
本文を設定します。
パラメータ
返却値
|