com.docomostar.system.MessageDraft
|
|||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | ||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | ||||||||
Object
public final class MessageDraft
メッセージStar アプリの送信用メッセージを定義します。
メッセージ機能では、
メッセージの取得や送信を行うクラスと
メッセージそのものを表すクラスが区別されています。
このクラスはメッセージそのものを表しますが、
メッセージの取得や送信はMessageAgentクラスで行います。
メッセージを新規に作成し、送信するためには、
コンストラクタによりMessageDraftオブジェクトを生成します。
生成したオブジェクトに対して宛先等の設定、取得、および
MessageAgent.send(MessageDraft)
メソッドによる送信を行うことができます。
送信の成否にかかわらず、
送信に使用したMessageDraftオブジェクトの状態は変化しません。
通常、宛先アドレスの指定は、 通常文字列(の配列)またはXStringの文字列1つのいずれかです。 しかし、再送信または返信メッセージの場合に限って、 宛先アドレスとしてXStringの配列が設定されることがあります。 この3つの指定方法は排他的であり、いずれか1つの方法でしか指定できません。 ある方法で指定を行うと、その他の方法での指定はすべて無効になります。 XStringの配列は、 再送信または返信メッセージを生成することにより自動的に生成されます。 その編集は、配列の要素であるアドレスの削除のみ可能です。 なお、空文字列の宛先アドレスは、 メッセージStar アプリのメッセージの仕様に準拠していないとみなされます。
[Star-1.1 まで]
メッセージ本文およびメッセージ Star アプリ固有のバイナリデータをコンストラクタおよびset系メソッドで設定することができますが、
そのサイズチェックはメッセージ本文またはメッセージ Star アプリ固有のバイナリデータに対してのみ個別に行われ、
メッセージ全体のサイズのチェックは行われません。
また、メッセージ本文のみに対するサイズチェック時には、メッセージ本文中の改行文字の正規化は行われません。
メッセージ本文中の改行文字の正規化、及び、
メッセージ全体のサイズチェックは、
MessageAgent.send(MessageDraft)
メソッドにより行われます。
[Star-1.2 以降]
このクラスではサブジェクト、宛先アドレス、メッセージ本文、メッセージ Star アプリ固有のバイナリデータが
メッセージ Star アプリのメッセージの仕様に準拠しているかどうかのチェックは行いません。
チェックは MessageAgent.send(MessageDraft)
で行われます。
MessageAgent| フィールドの概要 |
|---|
| インタフェース com.docomostar.system.MailConstants から継承されたフィールド |
|---|
ADDRESS_DOMAIN, ADDRESS_FULL, ADDRESS_USER, RECEIVED, SENT, UNSENT |
| コンストラクタの概要 | |
|---|---|
MessageDraft()
送信用のメッセージを生成します。 |
|
MessageDraft(Message message,
boolean all)
返信用または再送信用のメッセージを生成します。 |
|
MessageDraft(String subject,
String[] addresses,
String body,
byte[] data)
送信用のメッセージを生成します。 |
|
MessageDraft(String subject,
XString address,
String body,
byte[] data)
送信用のメッセージを生成します。 |
|
| メソッドの概要 | |
|---|---|
void |
addRecipient(String address)
宛先アドレス(通常文字列)を追加します。 |
String |
getBody()
メッセージ本文(通常文字列)を取得します。 |
byte[] |
getData()
メッセージ Star アプリ固有のバイナリデータを取得します。 |
String[] |
getRecipients()
宛先アドレス(通常文字列)を取得します。 |
String |
getSubject()
サブジェクト(通常文字列)を取得します。 |
XString |
getXRecipient()
宛先アドレス(XString)を取得します。 |
XString[] |
getXRecipients()
宛先アドレス(XStringの配列)を取得します。 |
void |
removeXRecipient(XString address)
宛先アドレス(XStringの配列)の1つを削除します。 |
void |
setBody(String body)
メッセージ本文(通常文字列)を設定します。 |
void |
setData(byte[] data)
メッセージ Star アプリ固有のバイナリデータを設定します。 |
void |
setRecipient(XString address)
宛先アドレス(XString)を設定します。 |
void |
setRecipients(String[] addresses)
宛先アドレス(通常文字列)を設定します。 |
void |
setSubject(String subject)
サブジェクト(通常文字列)を設定します。 |
| クラス Object から継承されたメソッド |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| コンストラクタの詳細 |
|---|
public MessageDraft()
MessageDraft(null, null, null, null)と同じです。
public MessageDraft(String subject,
String[] addresses,
String body,
byte[] data)
各引数にはnullや長さ0の配列を指定することができます。
subject - サブジェクト(通常文字列)を指定します。addresses - 宛先アドレス(通常文字列)を配列で指定します。body - メッセージ本文(通常文字列)を指定します。data - メッセージ Star アプリ固有のバイナリデータを指定します。
NullPointerException -
IllegalArgumentException -
IllegalArgumentException -
public MessageDraft(String subject,
XString address,
String body,
byte[] data)
各引数にはnullや長さ0の配列を指定することができます。
subject - サブジェクト(通常文字列)を指定します。address - 宛先アドレス(XString)を指定します。body - メッセージ本文(通常文字列)を指定します。data - メッセージ Star アプリ固有のバイナリデータを指定します。
IllegalArgumentException -
public MessageDraft(Message message,
boolean all)
引数に送信または未送信メッセージを指定した場合、
再送信用のメッセージを生成します。
指定された送信または未送信メッセージと同一の内容
(宛先アドレス、サブジェクト、メッセージ本文、メッセージ Star アプリ固有のバイナリデータ)を設定します。
すなわち、
メッセージStar アプリのメッセージ送信機能により作成(保存)された
送信および未送信メッセージについては、
そのメッセージStar アプリでの作成状況に応じて、
通常文字列またはXStringまたはXString配列の宛先アドレスが設定されています
(送信時のオブジェクトが復元されたように見えます)。
メッセージStar アプリ以外により作成されたメッセージの場合、
XString配列の宛先アドレスが設定されています。
未送信メッセージから生成したメッセージの送信が成功した場合、
元の未送信メッセージは削除されます。
引数に受信メッセージを指定した場合、返信用のメッセージを生成します。 宛先アドレスを除いて、指定された受信メッセージと同一の内容 (サブジェクト、メッセージ本文、メッセージ Star アプリ固有のバイナリデータ)を設定します。 引数 all が false の場合、 受信メッセージの差出人アドレスをXStringの宛先アドレスとして設定します。 引数 all が true の場合、設定される宛先アドレスはXStringの配列です。 この場合、配列の先頭の要素が受信メッセージの差出人アドレスであり、 続く配列の要素が受信メッセージの宛先アドレス(存在する場合)になります。
message - メッセージを指定します。all - 受信メッセージの宛先アドレスも含めて返信する場合、
true を指定します。
差出人アドレスへの返信のみの場合、
false を指定します。
送信および未送信メッセージに対しては無視されます。
NullPointerException -
| メソッドの詳細 |
|---|
public String getSubject()
MessageSent.getSubject()
の内容と同じです。
返信用メッセージの場合、生成直後は
MessageReceived.getSubject()
の内容と同じです。public void setSubject(String subject)
subject - サブジェクトを指定します。
nullを指定するとサブジェクトが削除されます。
IllegalArgumentException -
public String[] getRecipients()
MessageSent.getRecipients()
の内容と同じです。
返信用メッセージの場合、生成直後は null を返します。
public void setRecipients(String[] addresses)
addresses - 宛先アドレスを指定します。
nullや長さ0の配列を指定すると宛先アドレスが削除されます。
NullPointerException -
IllegalArgumentException -
IllegalArgumentException -
public void addRecipient(String address)
address - 宛先アドレスを指定します。
IllegalStateException -
NullPointerException -
IllegalArgumentException -
IllegalStateException -
public XString getXRecipient()
MessageSent.getXRecipient(ADDRESS_FULL)
の内容と同じです。
返信用メッセージの場合、生成直後は、
引数 all が false であった場合は受信メッセージの差出人アドレス(XString)を返します。
引数 all が true であった場合は null を返します。public void setRecipient(XString address)