Email (biz-Stream XML Library 5.2.0 API)

java.lang.Object
- com.brainsellers.xml.email.Email

```
public class Email
extends Object
```
メール情報を保持し、その情報を使ってメール送信を実行するクラス

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

コンストラクタ
コンストラクタと説明
`Email()` 設定ファイルを指定しない場合は、mail.xmlファイルかmail.propertiesをクラスパス上から探して読み込む mail.xmlファイルが読み込めない場合はmail.propertiesを読み込む。
`Email(String fileName)` 設定ファイルを指定する場合。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addAttachment(CommonEmailAttachment attachment)` メールに添付ファイルを追加する。
`void`	`addBccAddress(EmailAddress bcc)` メールにBCC のアドレスを追加する。
`void`	`addCcAddress(EmailAddress cc)` メールにCC のアドレスを追加する。
`void`	`addToAddress(EmailAddress to)` メールにTO のアドレスを追加する。
`void`	`clearBccAddress()` メールのBCCアドレス情報をクリアする。
`void`	`clearCcAddress()` メールのCCアドレス情報をクリアする。
`void`	`clearHeaders()` メールのヘッダ情報をクリアする。
`void`	`clearToAddress()` メールのToアドレス情報をクリアする。
`List`	`getAttachmentList()` メールに添付される添付ファイル情報を格納したCommonEmailAttachmentオブジェクトの一覧を返す。
`List`	`getBccAddressList()` メールのBCCアドレスを設定したEmailAddressオブジェクトの一覧を返す。
`List`	`getCcAddressList()` メールのCCアドレスを設定したEmailAddressオブジェクトの一覧を返す。
`String`	`getFromAddress()` メールのFrom値を取得
`String`	`getFromAddressComment()` メールのFromの値に表示される文字列を取得する
`GeneratePDFAttachment`	`getGeneratePdfAttachment()` 生成するPDFファイルの情報を格納したクラスを返す。
`String`	`getHostName()` 使用するホストの値を取得する
`String`	`getMessage()` メールの本文を取得
`GeneratePDFAttachment`	`getPdfAttachment()` 生成されるPDFファイルの情報を格納したクラス GeneratePDFAttachmentを取得する
`String`	`getReplyToAddress()` Reply TOアドレスを取得する。
`String`	`getReplyToAddressComment()` Reply TO アドレスに表示される文字列を取得する。
`String`	`getSubject()` メールの表題を取得
`List`	`getToAddressList()` メールのTOアドレスを設定したEmailAddressオブジェクトの一覧を返す。
`void`	`sendMail()` 設定したメール情報を元にメールを送信する。
`void`	`setAuthentication(javax.mail.Authenticator authenication)`
`void`	`setAuthentication(String userName, String password)` ユーザ認証が必要なSMPTサーバを使用する場合に認証情報をセットする。
`void`	`setDebug(boolean debug)` メールのデバッグモードを起動するかしないか。
`void`	`setEncoding(String encoding)` 文字コード設定。
`void`	`setFromAddress(String fromAddress)` メールのFrom値を設定
`void`	`setFromAddressComment(String fromAddressComment)` メールのFromの値に表示される文字列を設定する。
`void`	`setHeaderValue(String key, String value)` メールのヘッダーに項目を追加したい値を保持する
`void`	`setHostName(String hostName)` 使用するホストの値を設定する
`void`	`setMailDataFromFile(String file)` TO,CC,BCC,Subject,Headerの情報をファイルから追加するメソッド制限事項としてJavaバージョンは1.5以上を使用。
`void`	`setMessage(String msg)` メールの本文を設定メール送信時にメッセージがセットされていないとメール送信ができない。
`void`	`setPdfAttachment(GeneratePDFAttachment pdfAttachment)` 生成されるPDFファイルの情報を格納したクラス GeneratePDFAttachmentを設定する 4.5.3以降では、メソッド実行順の合わせてmulti-partへ、出力される（殆どのメーラーで添付順になる）
`void`	`setPopBeforeSmtp(boolean newPopBeforeSmtp, String popHost, String popUsername, String ｐassword)` pop3 before smtpの設定をする。
`void`	`setReplyToAddress(String replyToAddress)` Reply TOアドレスの値を設定する。
`void`	`setReplyToAddressComment(String replyToAddressComment)` Reply TO アドレスに表示される文字列を設定する。
`void`	`setSubject(String subject)` メールの表題を設定

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

- コンストラクタの詳細
  - Email
```
public Email()
      throws PDFEmailException
```
    設定ファイルを指定しない場合は、mail.xmlファイルかmail.propertiesをクラスパス上から探して読み込む
    mail.xmlファイルが読み込めない場合はmail.propertiesを読み込む。
    mail.xmlとmail.propertiesの2つが有る場合はmail.xmlのみの設定を読み込む。プロパティファイルから値を取得して初期値をセットする。
    
    例外:
    
    PDFEmailException
  - Email
```
public Email(String fileName)
      throws PDFEmailException
```
    設定ファイルを指定する場合。
    設定ファイルの形式がXMLの場合、Javaのバージョンは1.5以上でなければならない。
    
    パラメータ:
    
    fileName -
    
    例外:
    
    PDFEmailException
- メソッドの詳細
  - addAttachment
```
public void addAttachment(CommonEmailAttachment attachment)
```
    メールに添付ファイルを追加する。
    4.5.3以降では、メソッド実行順の合わせてmulti-partへ、出力される（殆どのメーラーで添付順になる）
    
    パラメータ:
    
    attachment -
  - addBccAddress
```
public void addBccAddress(EmailAddress bcc)
```
    メールにBCC のアドレスを追加する。
    
    パラメータ:
    
    bcc -
  - addCcAddress
```
public void addCcAddress(EmailAddress cc)
```
    メールにCC のアドレスを追加する。
    
    パラメータ:
    
    cc -
  - addToAddress
```
public void addToAddress(EmailAddress to)
```
    メールにTO のアドレスを追加する。
    
    パラメータ:
    
    to -
  - clearBccAddress
```
public void clearBccAddress()
```
    メールのBCCアドレス情報をクリアする。
  - clearCcAddress
```
public void clearCcAddress()
```
    メールのCCアドレス情報をクリアする。
  - clearHeaders
```
public void clearHeaders()
```
    メールのヘッダ情報をクリアする。
  - clearToAddress
```
public void clearToAddress()
```
    メールのToアドレス情報をクリアする。
  - getAttachmentList
```
public List getAttachmentList()
```
    メールに添付される添付ファイル情報を格納したCommonEmailAttachmentオブジェクトの一覧を返す。
    
    戻り値:
    
    java.util.List
    
    関連項目:
    
    CommonEmailAttachment
  - getBccAddressList
```
public List getBccAddressList()
```
    メールのBCCアドレスを設定したEmailAddressオブジェクトの一覧を返す。
    
    戻り値:
    
    java.util.List
    
    関連項目:
    
    EmailAddress
  - getCcAddressList
```
public List getCcAddressList()
```
    メールのCCアドレスを設定したEmailAddressオブジェクトの一覧を返す。
    
    戻り値:
    
    java.util.List
    
    関連項目:
    
    EmailAddress
  - getFromAddress
```
public String getFromAddress()
```
    メールのFrom値を取得
    
    戻り値:
    
    java.lang.String
  - getFromAddressComment
```
public String getFromAddressComment()
```
    メールのFromの値に表示される文字列を取得する
    
    戻り値:
    
    java.lang.String
  - getGeneratePdfAttachment
```
public GeneratePDFAttachment getGeneratePdfAttachment()
```
    生成するPDFファイルの情報を格納したクラスを返す。
    
    戻り値:
    
    GeneratePDFAttachment
  - getHostName
```
public String getHostName()
```
    使用するホストの値を取得する
    
    戻り値:
    
    java.lang.String
  - getMessage
```
public String getMessage()
```
    メールの本文を取得
    
    戻り値:
    
    java.lang.String
  - getPdfAttachment
```
public GeneratePDFAttachment getPdfAttachment()
```
    生成されるPDFファイルの情報を格納したクラス GeneratePDFAttachmentを取得する
    
    戻り値:
    
    com.brainsellers.xml.email.GeneratePDFAttachment
    
    関連項目:
    
    GeneratePDFAttachment
  - getReplyToAddress
```
public String getReplyToAddress()
```
    Reply TOアドレスを取得する。
    
    戻り値:
    
    java.lang.String
  - getReplyToAddressComment
```
public String getReplyToAddressComment()
```
    Reply TO アドレスに表示される文字列を取得する。
    
    戻り値:
    
    String
  - getSubject
```
public String getSubject()
```
    メールの表題を取得
    
    戻り値:
    
    java.lang.String
  - getToAddressList
```
public List getToAddressList()
```
    メールのTOアドレスを設定したEmailAddressオブジェクトの一覧を返す。
    
    戻り値:
    
    java.util.List
    
    関連項目:
    
    EmailAddress
  - sendMail
```
public void sendMail()
              throws PDFEmailException
```
    設定したメール情報を元にメールを送信する。 PDF情報とメッセージ本文は実行前にセットしておかなければならない。
    
    例外:
    
    PDFEmailException
  - setAuthentication
```
public void setAuthentication(javax.mail.Authenticator authenication)
```
  - setAuthentication
```
public void setAuthentication(String userName,
                              String password)
```
    ユーザ認証が必要なSMPTサーバを使用する場合に認証情報をセットする。
    
    パラメータ:
    
    userName - SMTPサーバのためのユーザ名
    
    password - SMTPサーバのためのパスワード
  - setDebug
```
public void setDebug(boolean debug)
```
    メールのデバッグモードを起動するかしないか。
    
    パラメータ:
    
    debug - trueの場合はデバッグモードがOnの状態になる。
  - setEncoding
```
public void setEncoding(String encoding)
                 throws PDFEmailException
```
    文字コード設定。
    
    パラメータ:
    
    encoding -
    
    例外:
    
    PDFEmailException
  - setFromAddress
```
public void setFromAddress(String fromAddress)
```
    メールのFrom値を設定
    
    パラメータ:
    
    fromAddress -
  - setFromAddressComment
```
public void setFromAddressComment(String fromAddressComment)
```
    メールのFromの値に表示される文字列を設定する。
    
    パラメータ:
    
    fromAddressComment -
  - setHeaderValue
```
public void setHeaderValue(String key,
                           String value)
```
    メールのヘッダーに項目を追加したい値を保持する
    
    パラメータ:
    
    key -
    
    value -
  - setHostName
```
public void setHostName(String hostName)
```
    使用するホストの値を設定する
  - setMailDataFromFile
```
public void setMailDataFromFile(String file)
                         throws IOException
```
    TO,CC,BCC,Subject,Headerの情報をファイルから追加するメソッド
    制限事項としてJavaバージョンは1.5以上を使用。
    
    パラメータ:
    
    file -
    
    例外:
    
    IOException
  - setMessage
```
public void setMessage(String msg)
```
    メールの本文を設定メール送信時にメッセージがセットされていないとメール送信ができない。
    
    パラメータ:
    
    msg -
  - setPdfAttachment
```
public void setPdfAttachment(GeneratePDFAttachment pdfAttachment)
```
    生成されるPDFファイルの情報を格納したクラス GeneratePDFAttachmentを設定する
    4.5.3以降では、メソッド実行順の合わせてmulti-partへ、出力される（殆どのメーラーで添付順になる）
    
    パラメータ:
    
    pdfAttachment -
    
    関連項目:
    
    GeneratePDFAttachment
  - setPopBeforeSmtp
```
public void setPopBeforeSmtp(boolean newPopBeforeSmtp,
                             String popHost,
                             String popUsername,
                             String ｐassword)
```
    pop3 before smtpの設定をする。
    
    パラメータ:
    
    newPopBeforeSmtp - メール送信前にPOP3サーバにログインするかどうか。true ログインする false ログインしない
    
    popHost - POP3で使うホスト
    
    popUsername - ユーザ名
    
    ｐassword - パスワード
  - setReplyToAddress
```
public void setReplyToAddress(String replyToAddress)
```
    Reply TOアドレスの値を設定する。
    
    パラメータ:
    
    replyToAddress -
  - setReplyToAddressComment
```
public void setReplyToAddressComment(String replyToAddressComment)
```
    Reply TO アドレスに表示される文字列を設定する。
    
    パラメータ:
    
    replyToAddressComment -
  - setSubject
```
public void setSubject(String subject)
```
    メールの表題を設定
    
    パラメータ:
    
    subject -

クラス Email

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

メソッドのサマリー

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

コンストラクタの詳細

Email

Email

メソッドの詳細

addAttachment

addBccAddress

addCcAddress

addToAddress

clearBccAddress

clearCcAddress

clearHeaders

clearToAddress

getAttachmentList

getBccAddressList

getCcAddressList

getFromAddress

getFromAddressComment

getGeneratePdfAttachment

getHostName

getMessage

getPdfAttachment

getReplyToAddress

getReplyToAddressComment

getSubject

getToAddressList

sendMail

setAuthentication

setAuthentication

setDebug

setEncoding

setFromAddress

setFromAddressComment

setHeaderValue

setHostName

setMailDataFromFile

setMessage

setPdfAttachment

setPopBeforeSmtp

setReplyToAddress

setReplyToAddressComment

setSubject