ExtendedMail (javadoc-all-dev 8.0.0 API)

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

```
public class ExtendedMail
extends StandardMail
```
ExtendedMailはStandardMailの拡張クラスです。StandardMailで利用可能な機能に加え、以下の機能を利用できる。
- StorageとInputStreamを添付ファイルに設定
- HTMLメールの送信
- HTMLメールにインライン画像を挿入
導入されたバージョン:

8.0.8

バージョン:

8.0.16

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

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

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addAttachment(String filename, String file)` 添付ファイルを追加します。
`void`	`addAttachmentStorage(String filename, Storage<?> storage)` 添付ファイルを追加します。
`void`	`addAttachmentStream(String filename, InputStream in)` 添付ファイルを追加します。
`void`	`addHeader(String name, String value)` ヘッダを追加します。
`void`	`addHTMLImageStorage(String filename, Storage<?> storage, String cid)` インライン画像を追加します。
`void`	`addHTMLImageStream(String filename, InputStream in, String cid)` インライン画像を追加します。
`protected javax.mail.internet.InternetAddress`	`createAddress(String personal, String address)` InternetAddress のインスタンスを生成します。
`protected javax.mail.internet.InternetAddress[]`	`createAddressList(Collection<MailAddress> adresses)` MailAddressの一覧を InternetAddress の一覧に変換します。
`protected void`	`createAttachmentPart(javax.mail.Multipart parentPart, String charset, String mimeEncoding)` 添付ファイルのパートを生成します。
`protected void`	`createHTMLImagePart(javax.mail.Multipart parentPart, String charset, String mimeEncoding)` インライン画像のパートを生成します。
`protected javax.mail.BodyPart`	`createHTMLPart(String charset, String contentTransferEncoding)` HTMLテキストのパートを生成します。
`protected javax.mail.Multipart`	`createMultiPartAttachment(String charset, String mimeEncoding, String contentTransferEncoding)` 添付ファイルのマルチパートを生成します。
`protected javax.mail.Multipart`	`createMultiPartHTML(String charset, String mimeEncoding, String contentTransferEncoding)` HTMLメールのマルチパートを生成します。
`protected javax.mail.Multipart`	`createMultiPartHTMLAndAttachment(String charset, String mimeEncoding, String contentTransferEncoding)` HTMLメールと添付ファイルのマルチパートを生成します。
`protected javax.mail.Multipart`	`createMultiPartHTMLAndImage(String charset, String mimeEncoding, String contentTransferEncoding)` インライン画像含むHTMLメールのマルチパートを生成します alternative/ text related/ HTML image
`protected javax.mail.Multipart`	`createMultiPartHTMLAndImageAndAttachment(String charset, String mimeEncoding, String contentTransferEncoding)` インライン画像含むHTMLメールと添付ファイルのマルチパートを生成します。
`protected javax.mail.BodyPart`	`createTextPart(String charset, String contentTransferEncoding)` プレーンテキストのパートを生成します。
`protected static String`	`decodeText(String str)`
`protected String`	`encodeCharacter(String str, String encode)` 文字列をエンコードします。
`Collection<AttachmentFile>`	`getAttachment()` 添付ファイルを取得します。
`Collection<AttachmentStorage>`	`getAttachmentStorages()` 添付ファイルを取得します。
`Collection<AttachmentStream>`	`getAttachmentStreams()` 添付ファイルを取得します。
`Collection<MailHeader>`	`getHeaders()` ヘッダを取得します。
`String`	`getHTML()` HTML文書を取得します。
`Collection<HTMLImageStorage>`	`getHTMLImageStorages()` インライン画像を取得します。
`Collection<HTMLImageStream>`	`getHTMLImageStreams()` インライン画像を取得します。
`boolean`	`hasAttachment()` 添付ファイルが設定されているかを取得します。
`boolean`	`hasHTMLImage()` インライン画像が設定されているかを取得します。
`protected void`	`init()` StandardMailオブジェクトを初期化します。
`protected void`	`prepareMimeMessage(javax.mail.internet.MimeMessage message)` MIMEメッセージに対して操作を行います。
`void`	`setHTML(String html)` HTML文書を設定します。
`protected void`	`setHTMLContent(javax.mail.Message message, String charset, String contentTransferEncoding)` MIMEメッセージにHTMLメールを生成します。
`protected void`	`setTextContent(javax.mail.Message message, String charset, String contentTransferEncoding)` MIMEメッセージにテキストメールを生成します。

クラスから継承されたメソッド jp.co.intra_mart.foundation.mail.javamail.StandardMail
addBcc, addBcc, addCc, addCc, addReplyTo, addReplyTo, addTo, addTo, clearReplyTo, createSession, getBcc, getCc, getFrom, getLocale, getProperties, getReplyTo, getSubject, getText, getTo, prepareSession, setFrom, setFrom, setSubject, setText

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

- コンストラクタの詳細
  - ExtendedMail
```
public ExtendedMail()
```
    アカウントコンテキストのロケールでメール属性オブジェクトを新規に作成します。
    このインスタンスを利用した場合、テナントIDと一致するSMTPサーバ設定IDのSMTPサーバ設定が有効になります。
    テナントIDと一致するSMTPサーバ設定IDの設定が存在しない場合は、標準のSMTPサーバ設定が有効になります。
  - ExtendedMail
```
public ExtendedMail(Locale locale)
```
    ロケールを指定してメール属性オブジェクトを新規に作成します。
    このインスタンスを利用した場合、テナントIDと一致するSMTPサーバ設定IDのSMTPサーバ設定が有効になります。
    テナントIDと一致するSMTPサーバ設定IDの設定が存在しない場合は、標準のSMTPサーバ設定が有効になります。
    
    パラメータ:
    
    locale - 送信先ロケール
  - ExtendedMail
```
public ExtendedMail(Locale locale,
                    String serverId)
```
    利用するSMTPサーバ設定およびロケールを指定してメール属性オブジェクトを新規に作成します。
    標準のSMTPサーバ設定を有効にしたい場合は、SMTPサーバ設定IDに null を指定してください。
    
    パラメータ:
    
    locale - 送信先ロケール
    
    serverId - SMTPサーバ設定ID
  - ExtendedMail
```
public ExtendedMail(String serverId)
```
    利用するSMTPサーバ設定を指定してメール属性オブジェクトを新規に作成します。
    このインスタンスを有効にした場合、アカウントコンテキストのロケールでメール属性オブジェクトを作成します。
    標準のSMTPサーバ設定を利用したい場合は、SMTPサーバ設定IDに null を指定してください。
    
    パラメータ:
    
    serverId - SMTPサーバ設定ID
- メソッドの詳細
  - decodeText
```
protected static String decodeText(String str)
```
  - addAttachment
```
public void addAttachment(String filename,
                          String file)
```
    クラスからコピーされた説明: StandardMail
    
    添付ファイルを追加します。
    
    オーバーライド:
    
    addAttachment クラス内 StandardMail
    
    パラメータ:
    
    filename - 添付ファイル名
    
    file - ファイル
  - addAttachmentStorage
```
public void addAttachmentStorage(String filename,
                                 Storage<?> storage)
```
    添付ファイルを追加します。
    
    パラメータ:
    
    filename - ファイル名
    
    storage - ファイルが入力可能なStorageのインスタンス
  - addAttachmentStream
```
public void addAttachmentStream(String filename,
                                InputStream in)
```
    添付ファイルを追加します。
    
    パラメータ:
    
    filename - ファイル名
    
    in - ファイルが読み込み可能な入力ストリーム
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    クラスからコピーされた説明: StandardMail
    
    ヘッダを追加します。
    
    オーバーライド:
    
    addHeader クラス内 StandardMail
    
    パラメータ:
    
    name - ヘッダの名前
    
    value - ヘッダの値
  - addHTMLImageStorage
```
public void addHTMLImageStorage(String filename,
                                Storage<?> storage,
                                String cid)
```
    インライン画像を追加します。
    
    パラメータ:
    
    filename - ファイル名
    
    storage - 画像ファイルが読み込み可能なStorageのインスタンス
    
    cid - Content-ID
  - addHTMLImageStream
```
public void addHTMLImageStream(String filename,
                               InputStream in,
                               String cid)
```
    インライン画像を追加します。
    
    パラメータ:
    
    filename - ファイル名
    
    in - 画像ファイルが読み込み可能な入力ストリーム
    
    cid - Content-ID
  - getAttachment
```
public Collection<AttachmentFile> getAttachment()
```
    クラスからコピーされた説明: StandardMail
    
    添付ファイルを取得します。
    
    オーバーライド:
    
    getAttachment クラス内 StandardMail
    
    戻り値:
    
    添付ファイル
  - getAttachmentStorages
```
public Collection<AttachmentStorage> getAttachmentStorages()
```
    添付ファイルを取得します。
    
    戻り値:
    
    添付ファイルの一覧
  - getAttachmentStreams
```
public Collection<AttachmentStream> getAttachmentStreams()
```
    添付ファイルを取得します。
    
    戻り値:
    
    添付ファイルの一覧
  - getHeaders
```
public Collection<MailHeader> getHeaders()
```
    ヘッダを取得します。
    
    戻り値:
    
    ヘッダの値
  - getHTML
```
public String getHTML()
```
    HTML文書を取得します。
    
    戻り値:
    
    HTML文書
  - getHTMLImageStorages
```
public Collection<HTMLImageStorage> getHTMLImageStorages()
```
    インライン画像を取得します。
    
    戻り値:
    
    インライン画像の一覧
  - getHTMLImageStreams
```
public Collection<HTMLImageStream> getHTMLImageStreams()
```
    インライン画像を取得します。
    
    戻り値:
    
    インライン画像の一覧
  - hasAttachment
```
public boolean hasAttachment()
```
    添付ファイルが設定されているかを取得します。
    
    戻り値:
    
    true/添付ファイルが設定されている。false/添付ファイルが設定されていない。
  - hasHTMLImage
```
public boolean hasHTMLImage()
```
    インライン画像が設定されているかを取得します。
    
    戻り値:
    
    true/インライン画像が設定されている。false/インライン画像が設定されていない。
  - setHTML
```
public void setHTML(String html)
```
    HTML文書を設定します。
    
    パラメータ:
    
    html - HTML文書
  - createAddress
```
protected javax.mail.internet.InternetAddress createAddress(String personal,
                                                            String address)
                                                     throws MailSenderException
```
    InternetAddress のインスタンスを生成します。
    
    パラメータ:
    
    personal - 名前
    
    address - メールアドレス
    
    戻り値:
    
    InternetAddressのインスタンス
    
    例外:
    
    MailSenderException - InternetAddressの生成時に例外が発生
  - createAddressList
```
protected javax.mail.internet.InternetAddress[] createAddressList(Collection<MailAddress> adresses)
```
    MailAddressの一覧を InternetAddress の一覧に変換します。
    
    パラメータ:
    
    adresses - MailAddress の一覧
    
    戻り値:
    
    InternetAddress の一覧
  - createAttachmentPart
```
protected void createAttachmentPart(javax.mail.Multipart parentPart,
                                    String charset,
                                    String mimeEncoding)
                             throws MailSenderException
```
    添付ファイルのパートを生成します。
    このメソッドはマルチパートを生成するメソッドから呼ばれます。
    
    パラメータ:
    
    parentPart - 親となるパート
    
    charset - ファイル名のキャラクターセット
    
    mimeEncoding - ファイル名のMIMEエンコーディング
    
    例外:
    
    MailSenderException - パート生成時に例外が発生
  - createHTMLImagePart
```
protected void createHTMLImagePart(javax.mail.Multipart parentPart,
                                   String charset,
                                   String mimeEncoding)
                            throws MailSenderException
```
    インライン画像のパートを生成します。
    このメソッドはマルチパートを生成するメソッドから呼ばれます。
    
    パラメータ:
    
    parentPart - 親となるパート
    
    charset - ファイル名のキャラクターセット
    
    mimeEncoding - ファイル名のMIMEエンコーディング
    
    例外:
    
    MailSenderException - パート生成時に例外が発生
  - createHTMLPart
```
protected javax.mail.BodyPart createHTMLPart(String charset,
                                             String contentTransferEncoding)
                                      throws MailSenderException
```
    HTMLテキストのパートを生成します。このメソッドはマルチパートを生成するメソッドから呼ばれます。
    
    パラメータ:
    
    charset - HTMLテキストパートのキャラクターセット
    
    contentTransferEncoding - HTMLテキストパートのMIMEエンコーディング
    
    戻り値:
    
    パート
    
    例外:
    
    MailSenderException - パート生成時に例外が発生
  - createMultiPartAttachment
```
protected javax.mail.Multipart createMultiPartAttachment(String charset,
                                                         String mimeEncoding,
                                                         String contentTransferEncoding)
                                                  throws MailSenderException
```
    添付ファイルのマルチパートを生成します。
```
 mixed/
   text
   attachment
 
```
    パラメータ:
    
    charset - ボディのキャラクターセット
    
    mimeEncoding - ボディのMIMEエンコーディング
    
    contentTransferEncoding - ボディのContent-Transfer-Encoding
    
    戻り値:
    
    ボディ
    
    例外:
    
    MailSenderException - ボディ生成時に例外が発生
  - createMultiPartHTML
```
protected javax.mail.Multipart createMultiPartHTML(String charset,
                                                   String mimeEncoding,
                                                   String contentTransferEncoding)
                                            throws MailSenderException
```
    HTMLメールのマルチパートを生成します。
```
 alternative/
   text
   HTML
 
```
    パラメータ:
    
    charset - ボディのキャラクターセット
    
    mimeEncoding - ボディのMIMEエンコーディング
    
    contentTransferEncoding - ボディのContent-Transfer-Encoding
    
    戻り値:
    
    ボディ
    
    例外:
    
    MailSenderException - ボディ生成時に例外が発生
  - createMultiPartHTMLAndAttachment
```
protected javax.mail.Multipart createMultiPartHTMLAndAttachment(String charset,
                                                                String mimeEncoding,
                                                                String contentTransferEncoding)
                                                         throws MailSenderException
```
    HTMLメールと添付ファイルのマルチパートを生成します。
```
 mixed/
   alternative/
     text
     HTML
   attachment
 
```
    パラメータ:
    
    charset - ボディのキャラクターセット
    
    mimeEncoding - ボディのMIMEエンコーディング
    
    contentTransferEncoding - ボディのContent-Transfer-Encoding
    
    戻り値:
    
    ボディ
    
    例外:
    
    MailSenderException - ボディ生成時に例外が発生
  - createMultiPartHTMLAndImage
```
protected javax.mail.Multipart createMultiPartHTMLAndImage(String charset,
                                                           String mimeEncoding,
                                                           String contentTransferEncoding)
                                                    throws MailSenderException
```
    インライン画像含むHTMLメールのマルチパートを生成します
```
 alternative/
   text
   related/
     HTML
     image
 
```
    パラメータ:
    
    charset - ボディのキャラクターセット
    
    mimeEncoding - ボディのMIMEエンコーディング
    
    contentTransferEncoding - ボディのContent-Transfer-Encoding
    
    戻り値:
    
    ボディ
    
    例外:
    
    MailSenderException - ボディ生成時に例外が発生
  - createMultiPartHTMLAndImageAndAttachment
```
protected javax.mail.Multipart createMultiPartHTMLAndImageAndAttachment(String charset,
                                                                        String mimeEncoding,
                                                                        String contentTransferEncoding)
                                                                 throws MailSenderException
```
    インライン画像含むHTMLメールと添付ファイルのマルチパートを生成します。
```
 mixed/
   alternative/
     text
     related/
       HTML
       image
   attachment
 
```
    パラメータ:
    
    charset - ボディのキャラクターセット
    
    mimeEncoding - ボディのMIMEエンコーディング
    
    contentTransferEncoding - ボディのContent-Transfer-Encoding
    
    戻り値:
    
    ボディ
    
    例外:
    
    MailSenderException - ボディ生成時に例外が発生
  - createTextPart
```
protected javax.mail.BodyPart createTextPart(String charset,
                                             String contentTransferEncoding)
                                      throws MailSenderException
```
    プレーンテキストのパートを生成します。
    このメソッドはマルチパートを生成するメソッドから呼ばれます。
    
    パラメータ:
    
    charset - テキストパートのキャラクターセット
    
    contentTransferEncoding - テキストパートのMIMEエンコーディング
    
    戻り値:
    
    パート
    
    例外:
    
    MailSenderException - パート生成時に例外が発生
  - encodeCharacter
```
protected String encodeCharacter(String str,
                                 String encode)
                          throws MailSenderException
```
    文字列をエンコードします。
    
    パラメータ:
    
    str - エンコードする文字列
    
    encode - エンコーディング名
    
    戻り値:
    
    エンコードされた文字列
    
    例外:
    
    MailSenderException
  - init
```
protected void init()
             throws MailSenderException
```
    クラスからコピーされた説明: StandardMail
    
    StandardMailオブジェクトを初期化します。このメソッドはJavaMailSender.send()から呼ばれます。
    
    オーバーライド:
    
    init クラス内 StandardMail
    
    例外:
    
    MailSenderException - StandardMailオブジェクトを初期化時に例外が発生。
  - prepareMimeMessage
```
protected void prepareMimeMessage(javax.mail.internet.MimeMessage message)
                           throws MailSenderException
```
    クラスからコピーされた説明: StandardMail
    
    MIMEメッセージに対して操作を行います。このメソッドはJavaMailSender.send()から呼ばれます。
    
    オーバーライド:
    
    prepareMimeMessage クラス内 StandardMail
    
    パラメータ:
    
    message - メッセージ
    
    例外:
    
    MailSenderException - メッセージ操作中に例外が発生。
  - setHTMLContent
```
protected void setHTMLContent(javax.mail.Message message,
                              String charset,
                              String contentTransferEncoding)
                       throws MailSenderException
```
    MIMEメッセージにHTMLメールを生成します。
    このメソッドはシングルパートのメール生成時に呼ばれます。
    
    パラメータ:
    
    message - MIME message
    
    charset - ボディのキャラクターセット
    
    contentTransferEncoding - ボディのContent-Transfer-Encoding
    
    例外:
    
    MailSenderException - ボディ生成時に例外が発生
  - setTextContent
```
protected void setTextContent(javax.mail.Message message,
                              String charset,
                              String contentTransferEncoding)
                       throws MailSenderException
```
    MIMEメッセージにテキストメールを生成します。
    このメソッドはシングルパートのメール生成時に呼ばれます。
    
    パラメータ:
    
    message - MIME message
    
    charset - ボディのキャラクターセット
    
    contentTransferEncoding - ボディのContent-Transfer-Encoding
    
    例外:
    
    MailSenderException - ボディ生成時に例外が発生

クラス ExtendedMail

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

メソッドのサマリー

クラスから継承されたメソッド jp.co.intra_mart.foundation.mail.javamail.StandardMail

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

コンストラクタの詳細

ExtendedMail

ExtendedMail

ExtendedMail

ExtendedMail

メソッドの詳細

decodeText

addAttachment

addAttachmentStorage

addAttachmentStream

addHeader

addHTMLImageStorage

addHTMLImageStream

getAttachment

getAttachmentStorages

getAttachmentStreams

getHeaders

getHTML

getHTMLImageStorages

getHTMLImageStreams

hasAttachment

hasHTMLImage

setHTML

createAddress

createAddressList

createAttachmentPart

createHTMLImagePart

createHTMLPart

createMultiPartAttachment

createMultiPartHTML

createMultiPartHTMLAndAttachment

createMultiPartHTMLAndImage

createMultiPartHTMLAndImageAndAttachment

createTextPart

encodeCharacter

init

prepareMimeMessage

setHTMLContent

setTextContent