StandardMail (javadoc-all-dev 8.0.0 API)

java.lang.Object
- jp.co.intra_mart.foundation.mail.javamail.StandardMail

直系の既知のサブクラス:

ExtendedMail
```
public class StandardMail
extends Object
```
送信するメールの属性を保管します。

SMTPサーバの設定は、 /conf/javamail-config/javamail-config.xml に設定されています。

id に default が指定されているsmtp-serverの設定が標準のSTMPサーバの設定として利用されます。
- キャラクターセット、エンコード
  このオブジェクトが保持するメールのキャラクターセット、エンコーディングの設定はロケールに依存します。ロケール毎の設定は定義ファイルにより決定されます。
  /conf/javamail-config/javamail-config.xml にencodeタグで指定します。
  
  指定可能なキーの一覧
  
  charset キャラクターセット
  
  mimeEncoding MIMEエンコード (B or Q)
  
  contentTransferEncoding ボディのエンコード
- SMTP Authentication
  StandardMail は SMTP Authentication に対応しています。有効にする場合は /conf/javamail-config/javamail-config.xml のauthタグを編集してください。
  
  enable SMTP Authの有効
  (true or false)
  
  user ユーザID
  
  password パスワード
- SMTPS(SMTP over SSL)
  StandardMail は 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)
導入されたバージョン:

5.0

バージョン:

8.0.20

関連項目:

JavaMailSender

charset	キャラクターセット
mimeEncoding	MIMEエンコード (B or Q)
contentTransferEncoding	ボディのエンコード

enable	SMTP Authの有効 (true or false)
user	ユーザID
password	パスワード

enable	SMTPSの有効 (true or false)
starttls	TLS/STARTTLSによる暗号化 (true or false)

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`StandardMail()` アカウントコンテキストのロケールでメール属性オブジェクトを新規に作成します。
`StandardMail(Locale locale)` ロケールを指定してメール属性オブジェクトを新規に作成します。
`StandardMail(Locale locale, String serverId)` 利用するSMTPサーバ設定およびロケールを指定してメール属性オブジェクトを新規に作成します。
`StandardMail(String serverId)` 利用するSMTPサーバ設定を指定してメール属性オブジェクトを新規に作成します。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addAttachment(String filename, String file)` 添付ファイルを追加します。
`void`	`addBcc(String address)` Bccを追加します。
`void`	`addBcc(String address, String personal)` Bccを追加します。
`void`	`addCc(String address)` Ccを追加します。
`void`	`addCc(String address, String personal)` Ccを追加します。
`void`	`addHeader(String name, String value)` ヘッダを追加します。
`void`	`addReplyTo(String replyto)` ReplyToを追加します。
`void`	`addReplyTo(String replyto, String personal)` ReplyToを追加します。
`void`	`addTo(String address)` Toを追加します。
`void`	`addTo(String address, String personal)` Toを追加します。
`void`	`clearReplyTo()` ReplyTo をクリアします。
`protected javax.mail.Session`	`createSession(Properties prop)` SMTPセッションを構築します。
`Collection<AttachmentFile>`	`getAttachment()` 添付ファイルを取得します。
`Collection<MailAddress>`	`getBcc()` Bccの一覧を取得します。
`Collection<MailAddress>`	`getCc()` Ccの一覧を取得します。
`MailAddress`	`getFrom()` Fromを取得します。
`Locale`	`getLocale()` ロケールを取得します。
`protected Properties`	`getProperties()` JavaMailのSMTPセッションに渡す属性を初期化します。
`Collection<MailAddress>`	`getReplyTo()` ReplyToの一覧を取得します。
`String`	`getSubject()` Subjectを取得します。
`String`	`getText()` 本文を取得します。
`Collection<MailAddress>`	`getTo()` Toの一覧を取得します。
`protected void`	`init()` StandardMailオブジェクトを初期化します。
`protected void`	`prepareMimeMessage(javax.mail.internet.MimeMessage message)` MIMEメッセージに対して操作を行います。
`protected void`	`prepareSession(javax.mail.Session session)` SMTPセッションに対して操作を行います。
`void`	`setFrom(String address)` Fromを設定します。
`void`	`setFrom(String address, String personal)` Fromを設定します。
`void`	`setSubject(String subject)` Subjectを設定します。
`void`	`setText(String text)` 本文を設定します。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - StandardMail
```
public StandardMail()
```
    アカウントコンテキストのロケールでメール属性オブジェクトを新規に作成します。
    このインスタンスを利用した場合、テナントIDと一致するSMTPサーバ設定IDのSMTPサーバ設定が有効になります。
    テナントIDと一致するSMTPサーバ設定IDの設定が存在しない場合は、標準のSMTPサーバ設定が有効になります。
  - StandardMail
```
public StandardMail(Locale locale)
```
    ロケールを指定してメール属性オブジェクトを新規に作成します。
    このインスタンスを利用した場合、テナントIDと一致するSMTPサーバ設定IDのSMTPサーバ設定が有効になります。
    テナントIDと一致するSMTPサーバ設定IDの設定が存在しない場合は、標準のSMTPサーバ設定が有効になります。
    
    パラメータ:
    
    locale - 送信先ロケール
  - StandardMail
```
public StandardMail(Locale locale,
                    String serverId)
```
    利用するSMTPサーバ設定およびロケールを指定してメール属性オブジェクトを新規に作成します。
    標準のSMTPサーバ設定を有効にしたい場合は、SMTPサーバ設定IDに null を指定してください。
    
    パラメータ:
    
    locale - 送信先ロケール
    
    serverId - SMTPサーバ設定ID
  - StandardMail
```
public StandardMail(String serverId)
```
    利用するSMTPサーバ設定を指定してメール属性オブジェクトを新規に作成します。
    このインスタンスを有効にした場合、アカウントコンテキストのロケールでメール属性オブジェクトを作成します。
    標準のSMTPサーバ設定を利用したい場合は、SMTPサーバ設定IDに null を指定してください。
    
    パラメータ:
    
    serverId - SMTPサーバ設定ID
- メソッドの詳細
  - addAttachment
```
public void addAttachment(String filename,
                          String file)
```
    添付ファイルを追加します。
    
    パラメータ:
    
    filename - 添付ファイル名
    
    file - ファイル
  - addBcc
```
public void addBcc(String address)
```
    Bccを追加します。
    
    パラメータ:
    
    address - メールアドレス
  - addBcc
```
public void addBcc(String address,
                   String personal)
```
    Bccを追加します。
    
    パラメータ:
    
    address - メールアドレス
    
    personal - 名前
  - addCc
```
public void addCc(String address)
```
    Ccを追加します。
    
    パラメータ:
    
    address - メールアドレス
  - addCc
```
public void addCc(String address,
                  String personal)
```
    Ccを追加します。
    
    パラメータ:
    
    address - メールアドレス
    
    personal - 名前
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    ヘッダを追加します。
    
    パラメータ:
    
    name - ヘッダの名前
    
    value - ヘッダの値
  - addReplyTo
```
public void addReplyTo(String replyto)
```
    ReplyToを追加します。
    
    パラメータ:
    
    replyto - ReplyToに追加するメールアドレス
  - addReplyTo
```
public void addReplyTo(String replyto,
                       String personal)
```
    ReplyToを追加します。
    
    パラメータ:
    
    replyto - ReplyToに追加するメールアドレス
    
    personal - ReplyToに追加する名前
  - addTo
```
public void addTo(String address)
```
    Toを追加します。
    
    パラメータ:
    
    address - メールアドレス
  - addTo
```
public void addTo(String address,
                  String personal)
```
    Toを追加します。
    
    パラメータ:
    
    address - メールアドレス
    
    personal - 名前
  - clearReplyTo
```
public void clearReplyTo()
```
    ReplyTo をクリアします。
    
    導入されたバージョン:
    
    8.0.20
  - getAttachment
```
public Collection<AttachmentFile> getAttachment()
```
    添付ファイルを取得します。
    
    戻り値:
    
    添付ファイル
  - getBcc
```
public Collection<MailAddress> getBcc()
```
    Bccの一覧を取得します。
    
    戻り値:
    
    Bccの一覧
  - getCc
```
public Collection<MailAddress> getCc()
```
    Ccの一覧を取得します。
    
    戻り値:
    
    Ccの一覧
  - getFrom
```
public MailAddress getFrom()
```
    Fromを取得します。
    
    戻り値:
    
    from
  - getLocale
```
public Locale getLocale()
```
    ロケールを取得します。
    
    戻り値:
    
    ロケール
  - getReplyTo
```
public Collection<MailAddress> getReplyTo()
```
    ReplyToの一覧を取得します。
    
    戻り値:
    
    ReplyToの一覧
  - getSubject
```
public String getSubject()
```
    Subjectを取得します。
    
    戻り値:
    
    Subject
  - getText
```
public String getText()
```
    本文を取得します。
    
    戻り値:
    
    本文
  - getTo
```
public Collection<MailAddress> getTo()
```
    Toの一覧を取得します。
    
    戻り値:
    
    Toの一覧
  - setFrom
```
public void setFrom(String address)
```
    Fromを設定します。
    
    パラメータ:
    
    address - メールアドレス
  - setFrom
```
public void setFrom(String address,
                    String personal)
```
    Fromを設定します。
    
    パラメータ:
    
    address - メールアドレス
    
    personal - 名前
  - setSubject
```
public void setSubject(String subject)
```
    Subjectを設定します。
    
    パラメータ:
    
    subject - Subject
  - setText
```
public void setText(String text)
```
    本文を設定します。
    
    パラメータ:
    
    text - 本文
  - createSession
```
protected javax.mail.Session createSession(Properties prop)
                                    throws MailSenderException
```
    SMTPセッションを構築します。 SMTP認証が有効の場合は、認証情報が含まれたセッションを構築します。
    
    パラメータ:
    
    prop - 属性
    
    戻り値:
    
    SMTPセッション
    
    例外:
    
    MailSenderException - SMTPセッション構築時に例外が発生
    
    導入されたバージョン:
    
    7.0.2
  - getProperties
```
protected Properties getProperties()
                            throws MailSenderException
```
    JavaMailのSMTPセッションに渡す属性を初期化します。
    
    ここではSMTPサーバのホスト及びポートを設定します。
    このメソッドはJavaMailSender.send()から呼ばれます。
    
    戻り値:
    
    属性
    
    例外:
    
    MailSenderException - 属性設定時に例外が発生。
  - init
```
protected void init()
             throws MailSenderException
```
    StandardMailオブジェクトを初期化します。このメソッドはJavaMailSender.send()から呼ばれます。
    
    例外:
    
    MailSenderException - StandardMailオブジェクトを初期化時に例外が発生。
  - prepareMimeMessage
```
protected void prepareMimeMessage(javax.mail.internet.MimeMessage message)
                           throws MailSenderException
```
    MIMEメッセージに対して操作を行います。このメソッドはJavaMailSender.send()から呼ばれます。
    
    パラメータ:
    
    message - メッセージ
    
    例外:
    
    MailSenderException - メッセージ操作中に例外が発生。
  - prepareSession
```
protected void prepareSession(javax.mail.Session session)
                       throws MailSenderException
```
    SMTPセッションに対して操作を行います。
    
    ここでは、JavaMailにデバッグオプションを設定します。設定値は"conf/mail/javaMail.properties"の設定値が有効となります。
    このメソッドはJavaMailSender.send()から呼ばれます。
    
    パラメータ:
    
    session - SMTPセッション
    
    例外:
    
    MailSenderException - セッション操作中に例外が発生。

クラス StandardMail

コンストラクタのサマリー

メソッドのサマリー

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

コンストラクタの詳細

StandardMail

StandardMail

StandardMail

StandardMail

メソッドの詳細

addAttachment

addBcc

addBcc

addCc

addCc

addHeader

addReplyTo

addReplyTo

addTo

addTo

clearReplyTo

getAttachment

getBcc

getCc

getFrom

getLocale

getReplyTo

getSubject

getText

getTo

setFrom

setFrom

setSubject

setText

createSession

getProperties

init

prepareMimeMessage

prepareSession