com.nttdocomo.system
クラス MailDraft

Object
  com.nttdocomo.system.MailDraft

すべての実装インタフェース:

MailConstants

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

DecomailDraft

public class MailDraft

extends Object

implements MailConstants

送信(または保存)用のメールを定義します。

このクラスにおける、サブジェクト、宛先アドレス、 メール本文の文字列の扱いについては、原則として MailAgent クラスの、 send 時に設定する文字列の扱いと同様です。 ただし、 メール本文中の改行文字の正規化に限っては MailAgent.send(MailDraft) が呼び出されるまで行われません。

メール機能では、 メールの取得や送信を行うクラスと メールそのものを表すクラスが区別されています。 このクラスはメールそのものを表しますが、 メールの取得や送信は MailAgent クラスで行います。

メールを新規に作成し、送信(または保存)するためには、 コンストラクタにより MailDraft オブジェクトを生成します。 生成したオブジェクトに対して宛先等の設定、取得、および MailAgent.send(MailDraft) メソッドによる送信が可能です。 送信の成否にかかわらず、 送信に使用したMailDraftオブジェクトの状態は変化しません。

通常文字列による宛先アドレスの指定と、 XStringによる宛先アドレスの指定は排他的に動作します。 一方を指定する(nullも含む)と、 他方のそれ以前の設定はすべて破棄されます。

導入されたバージョン:

DoJa-3.0 (505i)

関連項目:

MailAgent

フィールドの概要

インタフェース com.nttdocomo.system.MailConstants から継承したフィールド

ADDRESS_DOMAIN, ADDRESS_FULL, ADDRESS_USER, RECEIVED, SENT, UNSENT

コンストラクタの概要

MailDraft()
送信用のメールを生成します。

MailDraft(String subject, String[] addresses, String body)
送信用のメールを生成します。

MailDraft(String subject, XString address, String body)
送信用のメールを生成します。

メソッドの概要

void	addRecipient(String address) 宛先アドレス(通常文字列)を追加します。
String	getBody() ボディ(通常文字列)を取得します。
String[]	getRecipients() 宛先アドレス(通常文字列)を取得します。
String	getSubject() サブジェクト(通常文字列)を取得します。
XString	getXRecipient() 宛先アドレス(XString)を取得します。
void	setBody(String body) ボディ(通常文字列)を設定します。
void	setRecipient(XString address) 宛先アドレス(XString)を設定します。
void	setRecipients(String[] addresses) 宛先アドレス(通常文字列)を設定します。
void	setSubject(String subject) サブジェクト(通常文字列)を設定します。

クラス Object から継承したメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

MailDraft

public MailDraft()

送信用のメールを生成します。
MailDraft(null, null, null)と同じです。

MailDraft

public MailDraft(String subject,
                 String[] addresses,
                 String body)

送信用のメールを生成します。

各引数に指定できる文字列については、 MailAgent.send(String, String[], String) 時に設定する文字列の扱いと同様ですが、この時点ではメール本文に対する改行文字の正規化は行われません。 改行文字の正規化処理と、正規化処理後の文字列に対するサイズ超過チェックは MailAgent.send(MailDraft) 時に行われます。

パラメータ:

subject - サブジェクト(通常文字列)を指定します。

addresses - 宛先アドレス(通常文字列)を配列で指定します。

body - 本文(通常文字列)を指定します。

例外:

NullPointerException - addressesがnullでない場合に、 配列の要素中にnullの要素が指定されている場合に発生します。

IllegalArgumentException - 実装がサポートしている数以上のメールアドレスを指定した場合に 発生します。

IllegalArgumentException - 引数 subject、addresses、bodyの内容のいずれかが、 iモードメールの仕様に準拠していない場合に発生します。

MailDraft

public MailDraft(String subject,
                 XString address,
                 String body)

送信用のメールを生成します。

各引数に指定できる文字列については、 MailAgent.send(String, XString, String) 時に設定する文字列の扱いと同様ですが、この時点ではメール本文に対する改行文字の正規化は行われません。 改行文字の正規化処理と、正規化処理後の文字列に対するサイズ超過チェックは MailAgent.send(MailDraft) 時に行われます。

パラメータ:

subject - サブジェクト(通常文字列)を指定します。

address - 宛先アドレス(XString)を指定します。 XStringで指定する場合、宛先は1つのみです。

body - 本文(通常文字列)を指定します。

例外:

IllegalArgumentException - 引数 subject、address、bodyの内容のいずれかが、 iモードメールの仕様に準拠していない場合に発生します。

メソッドの詳細

getSubject

public String getSubject()

サブジェクト(通常文字列)を取得します。

戻り値:

サブジェクトを返します。 設定されていない場合、nullを返します。

setSubject

public void setSubject(String subject)

サブジェクト(通常文字列)を設定します。

引数に指定できる文字列については、 MailAgent.send() 時に設定するサブジェクト文字列の扱いと同様です。

パラメータ:

subject - サブジェクトを指定します。 nullを指定するとサブジェクトが削除されます。

例外:

IllegalArgumentException - 引数 subject の内容が、 iモードメールの仕様に準拠していない場合に発生します。

getRecipients

public String[] getRecipients()

宛先アドレス(通常文字列)を取得します。

戻り値:

宛先アドレスを配列で返します。 宛先アドレス(通常文字列)が設定されていない場合、 nullを返します。 返される配列は、このオブジェクトが内部で保持している配列のコピーです。

setRecipients

public void setRecipients(String[] addresses)

宛先アドレス(通常文字列)を設定します。
このメソッドを呼び出すと、 XStringで指定されていた宛先アドレスは破棄されます。

引数に指定できる文字列については、 MailAgent.send() 時に設定する宛先アドレスの配列の扱いと同様です。

パラメータ:

addresses - 宛先アドレスを指定します。 nullや長さ0の配列を指定すると宛先アドレスが削除されます。

例外:

NullPointerException - addressesがnullでない場合に、 配列の要素中にnullの要素が指定されている場合に発生します。

IllegalArgumentException - 実装がサポートしている数以上のメールアドレスを指定した場合に 発生します。

IllegalArgumentException - 引数 addressesの内容が、 iモードメールの仕様に準拠していない場合に発生します。

addRecipient

public void addRecipient(String address)

宛先アドレス(通常文字列)を追加します。

引数に指定できる文字列については、 MailAgent.send() 時に設定する配列型でない宛先アドレスの扱いと同様です。

パラメータ:

address - 宛先アドレスを指定します。

例外:

IllegalStateException - 実装がサポートしている最大数のメールアドレスが 既に設定されている場合に発生します。

NullPointerException - addressがnullの場合に発生します。

IllegalArgumentException - 引数 address の内容が、 iモードメールの仕様に準拠していない場合に発生します。

IllegalStateException - 既に宛先アドレス(XString)が設定されている場合に発生します。

getXRecipient

public XString getXRecipient()

宛先アドレス(XString)を取得します。

戻り値:

宛先アドレスを返します。 宛先アドレス(XString)が設定されていない場合、nullを返します。

setRecipient

public void setRecipient(XString address)

宛先アドレス(XString)を設定します。
このメソッドを呼び出すと、 通常文字列で指定されていた宛先アドレスは破棄されます。

引数に指定できる文字列については、 MailAgent.send() 時に設定する配列型でない宛先アドレスの扱いと同様です。

パラメータ:

address - 宛先アドレスを指定します。 nullを指定すると宛先アドレスが削除されます。

例外:

IllegalArgumentException - 引数 address の内容が、 iモードメールの仕様に準拠していない場合に発生します。

getBody

public String getBody()

ボディ(通常文字列)を取得します。

戻り値:

ボディを返します。 設定されていない場合、nullを返します。

setBody

public void setBody(String body)

ボディ(通常文字列)を設定します。

引数に指定できる文字列については、 MailAgent.send() 時に設定するメール本文の文字列の扱いと同様ですが、この時点では改行文字の正規化は行われません。 改行文字の正規化処理と、正規化処理後の文字列に対するサイズ超過チェックは MailAgent.send(MailDraft) 時に行われます。

パラメータ:

body - ボディを指定します。 nullを指定するとボディが削除されます。

例外:

IllegalArgumentException - 引数 bodyの内容が、 iモードメールの仕様に準拠していない場合に発生します。