MailContext (Nablarch-API)

java.lang.Object
- nablarch.common.mail.MailContext

Direct Known Subclasses:

FreeTextMailContext, TemplateMailContext
```
public abstract class MailContext
extends java.lang.Object
```
メール送信要求を表す抽象クラス。
以下の項目は、指定しない場合デフォルト値が使用される。
- 返信先メールアドレス：MailRequestConfig.defaultReturnPathの設定値
- 差し戻し先メールアドレス：MailRequestConfig.defaultReplyToの設定値
- Content-Typeヘッダに指定する文字セット：MailRequestConfig.defaultCharsetの設定値

Constructor Summary

Constructors
Constructor and Description

MailContext()

Constructors
Constructor and Description
`MailContext()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttachedFile(AttachedFile attachedFile)` 添付ファイルを追加する。
`void`	`addBcc(java.lang.String bcc)` 送信先(BCC)メールアドレスを追加する。
`void`	`addCc(java.lang.String cc)` 送信先(CC)メールアドレスを追加する。
`void`	`addTo(java.lang.String to)` 送信先(TO)メールアドレスを追加する。
`java.util.List<AttachedFile>`	`getAttachedFileList()` 添付ファイルのリストを取得する。
`java.util.Set<java.lang.String>`	`getBccList()` 送信先(BCC)メールアドレスのリストを取得する。
`java.util.Set<java.lang.String>`	`getCcList()` 送信先(CC)メールアドレスのリストを取得する。
`protected java.lang.String`	`getCharset()` Content-Typeヘッダに指定する文字セットを取得する。
`java.lang.String`	`getFrom()` 送信元メールアドレスを取得する。
`protected java.lang.String`	`getMailBody()` 本文を取得する。
`java.lang.String`	`getMailSendPatternId()` メール送信パターンIDを取得する。
`java.lang.String`	`getReplyTo()` 返信先メールアドレスを取得する。
`java.lang.String`	`getReturnPath()` 差し戻し先メールアドレスを取得する。
`protected java.lang.String`	`getSubject()` 件名を取得する。
`java.util.Set<java.lang.String>`	`getToList()` 送信先(TO)メールアドレスのリストを取得する。
`protected void`	`setCharset(java.lang.String charset)` Content-Typeヘッダに指定する文字セットを設定する。
`void`	`setFrom(java.lang.String from)` 送信元メールアドレスを設定する。
`protected void`	`setMailBody(java.lang.String mailBody)` 本文を設定する。
`void`	`setMailSendPatternId(java.lang.String mailSendPatternId)` メール送信パターンIDを設定する。メール送信パターンIDを指定して未送信データを送信する場合は必須。
`void`	`setReplyTo(java.lang.String replyTo)` 返信先メールアドレスを設定する。
`void`	`setReturnPath(java.lang.String returnPath)` 差し戻し先メールアドレスを設定する。
`protected void`	`setSubject(java.lang.String subject)` 件名を設定する。
`void`	`validate(MailRequestConfig mailRequestConfig)` メール送信要求をバリデーションする。バリデーション内容は以下の2つ。下記以外は業務アプリにてバリデーション済みの前提。宛先の数が0でないか、もしくは上限値を超えていないか。添付ファイルのファイルサイズが上限値を超えていないか。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MailContext
```
public MailContext()
```
- Method Detail
  - validate
```
public void validate(MailRequestConfig mailRequestConfig)
```
    メール送信要求をバリデーションする。
    バリデーション内容は以下の2つ。下記以外は業務アプリにてバリデーション済みの前提。
    - 宛先の数が0でないか、もしくは上限値を超えていないか。
    - 添付ファイルのファイルサイズが上限値を超えていないか。
    Parameters:
    
    mailRequestConfig - メールのデフォルト設定
  - getFrom
```
@Published(tag="architect")
public java.lang.String getFrom()
```
    送信元メールアドレスを取得する。
    
    Returns:
    
    送信元メールアドレス
  - setFrom
```
@Published
public void setFrom(java.lang.String from)
```
    送信元メールアドレスを設定する。
    
    Parameters:
    
    from - 送信元メールアドレス
  - getToList
```
@Published(tag="architect")
public java.util.Set<java.lang.String> getToList()
```
    送信先(TO)メールアドレスのリストを取得する。
    
    Returns:
    
    送信先(TO)メールアドレスのリスト
  - addTo
```
@Published
public void addTo(java.lang.String to)
```
    送信先(TO)メールアドレスを追加する。
    
    Parameters:
    
    to - 送信先(TO)メールアドレス
  - getCcList
```
@Published(tag="architect")
public java.util.Set<java.lang.String> getCcList()
```
    送信先(CC)メールアドレスのリストを取得する。
    
    Returns:
    
    送信先(CC)メールアドレスのリスト
  - addCc
```
@Published
public void addCc(java.lang.String cc)
```
    送信先(CC)メールアドレスを追加する。
    
    Parameters:
    
    cc - 送信先(CC)メールアドレス
  - getBccList
```
@Published(tag="architect")
public java.util.Set<java.lang.String> getBccList()
```
    送信先(BCC)メールアドレスのリストを取得する。
    
    Returns:
    
    送信先(BCC)メールアドレス
  - addBcc
```
@Published
public void addBcc(java.lang.String bcc)
```
    送信先(BCC)メールアドレスを追加する。
    
    Parameters:
    
    bcc - 送信先(BCC)メールアドレス
  - getReturnPath
```
@Published(tag="architect")
public java.lang.String getReturnPath()
```
    差し戻し先メールアドレスを取得する。
    
    Returns:
    
    差し戻し先メールアドレス
  - setReturnPath
```
@Published
public void setReturnPath(java.lang.String returnPath)
```
    差し戻し先メールアドレスを設定する。
    
    Parameters:
    
    returnPath - 差し戻し先メールアドレス
  - getReplyTo
```
@Published(tag="architect")
public java.lang.String getReplyTo()
```
    返信先メールアドレスを取得する。
    
    Returns:
    
    返信先メールアドレス
  - setReplyTo
```
@Published
public void setReplyTo(java.lang.String replyTo)
```
    返信先メールアドレスを設定する。
    
    Parameters:
    
    replyTo - 返信先メールアドレス
  - getSubject
```
@Published(tag="architect")
protected java.lang.String getSubject()
```
    件名を取得する。
    
    Returns:
    
    件名
  - setSubject
```
@Published
protected void setSubject(java.lang.String subject)
```
    件名を設定する。
    
    Parameters:
    
    subject - 件名
  - getMailBody
```
@Published(tag="architect")
protected java.lang.String getMailBody()
```
    本文を取得する。
    
    Returns:
    
    本文
  - setMailBody
```
@Published
protected void setMailBody(java.lang.String mailBody)
```
    本文を設定する。
    
    Parameters:
    
    mailBody - 本文
  - getCharset
```
@Published(tag="architect")
protected java.lang.String getCharset()
```
    Content-Typeヘッダに指定する文字セットを取得する。
    
    Returns:
    
    Content-Typeヘッダに指定する文字セット
  - setCharset
```
@Published
protected void setCharset(java.lang.String charset)
```
    Content-Typeヘッダに指定する文字セットを設定する。
    
    Parameters:
    
    charset - Content-Typeヘッダに指定する文字セット
  - getAttachedFileList
```
@Published(tag="architect")
public java.util.List<AttachedFile> getAttachedFileList()
```
    添付ファイルのリストを取得する。
    
    Returns:
    
    添付ファイルのリスト
  - addAttachedFile
```
@Published
public void addAttachedFile(AttachedFile attachedFile)
```
    添付ファイルを追加する。
    
    Parameters:
    
    attachedFile - 添付ファイル
  - getMailSendPatternId
```
@Published(tag="architect")
public java.lang.String getMailSendPatternId()
```
    メール送信パターンIDを取得する。
    
    Returns:
    
    メール送信パターンID
  - setMailSendPatternId
```
@Published
public void setMailSendPatternId(java.lang.String mailSendPatternId)
```
    メール送信パターンIDを設定する。
    メール送信パターンIDを指定して未送信データを送信する場合は必須。
    
    Parameters:
    
    mailSendPatternId - メール送信パターンID

Class MailContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MailContext

Method Detail

validate

getFrom

setFrom

getToList

addTo

getCcList

addCc

getBccList

addBcc

getReturnPath

setReturnPath

getReplyTo

setReplyTo

getSubject

setSubject

getMailBody

setMailBody

getCharset

setCharset

getAttachedFileList

addAttachedFile

getMailSendPatternId

setMailSendPatternId