com.docomostar.opt.system
クラス MailAgent2

Object
  com.docomostar.opt.system.MailAgent2

public final class MailAgent2
extends Object

携帯電話のネイティブのメール機能にアクセスする手段を提供します。 MailAgent の機能を拡張したクラスです。

導入されたバージョン:

Star-1.5

関連項目:

MailAgent, MailDraft, AttachmentData

フィールドの概要

static int

ATTACHMENT_IMAGE_JPEG このアプリケーションからネイティブメーラに添付可能なファイル種別の1つで、 JPEG フォーマットの画像データを表します(=0)。

メソッドの概要

static boolean	canAttach(AttachmentData data) 指定したデータが添付可能であるかどうかを返します。
static int[]	getSupportedAttachmentFileTypes() ネイティブメーラに添付可能なファイル種別のリストを取得します。
static boolean	send(com.docomostar.system.MailDraft mail, AttachmentData[] data) ユーザ操作によりメールを送信します。

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

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

フィールドの詳細

ATTACHMENT_IMAGE_JPEG

public static final int ATTACHMENT_IMAGE_JPEG

このアプリケーションからネイティブメーラに添付可能なファイル種別の1つで、 JPEG フォーマットの画像データを表します(=0)。

関連項目:

定数フィールド値

メソッドの詳細

getSupportedAttachmentFileTypes

public static int[] getSupportedAttachmentFileTypes()

ネイティブメーラに添付可能なファイル種別のリストを取得します。

リストの値は、このクラスで定義されているファイル種別の定数になります。

戻り値:

ネイティブメーラに添付可能なファイル種別のリストを返します。

例外:

com.docomostar.lang.UnsupportedOperationException -
ネイティブメーラへのファイル添付機能をサポートしていない場合に発生します。

canAttach

public static boolean canAttach(AttachmentData data)
                         throws com.docomostar.system.StoreException

指定したデータが添付可能であるかどうかを返します。

以下の場合、添付不可能と判断されます。

• 添付不可能なファイル種別のデータである場合
• ファイル種別独自の添付制限の対象となるデータである場合

パラメータ:

data - 添付ファイルの対象となるデータを指定します。

戻り値:

指定したデータが添付可能である場合は true を、 そうでない場合は false を返します。

例外:

com.docomostar.lang.UnsupportedOperationException -
ネイティブメーラへのファイル添付機能をサポートしていない場合に発生します。

NullPointerException -
引数 data が null の場合に発生します。

SecurityException -
ロック機能などのネイティブ独自のセキュリティ設定により、 添付対象のデータにアクセスできない場合に発生します。 なお、再配布識不可別子などの理由によってこのアプリケーションで扱えないデータにアクセスしようとした場合も含まれます。

com.docomostar.system.StoreException -
(NOT_FOUND)
エントリ ID に対応したデータが存在しない場合に発生します。

send

public static boolean send(com.docomostar.system.MailDraft mail,
                           AttachmentData[] data)
                    throws com.docomostar.system.MailException,
                           com.docomostar.system.InterruptedOperationException,
                           com.docomostar.system.StoreException,
                           AttachmentDataException

ユーザ操作によりメールを送信します。

引数 mail に指定した MailDraft オブジェクトに設定されたサブジェクト、宛先アドレス、メール本文の文字列の扱いについては、 MailAgent のクラスの説明を参照してください。

引数 data に指定した AttachmentData オブジェクトに設定されたエントリ種別とエントリID に対応したデータを添付ファイルとして、 配列要素 0 番目から昇順にネイティブメーラに渡します。 ただし、以下の場合には例外が発生します。

• このアプリケーションで扱えないデータである場合
• ネイティブメーラの添付ファイル数の上限をデータ数が超えている場合
• ネイティブメーラの添付ファイルサイズの上限を各データの合計サイズが超えている場合
• ネイティブメーラにおいて、添付不可のファイル種別のデータである場合
• ネイティブメーラにおいて、ファイル種別独自の添付制限の対象となるデータである場合

引数 data に null を指定した場合は、MailAgent.send(MailDraft mail) と同じ振る舞いとなります。

送信の成否にかかわらず、送信に使用した MailDraft オブジェクトと AttachmentData オブジェクトの状態は変化しません。

送信処理においてサーバが正常応答を返した場合、true を返します。 送信処理中にサーバがエラーを返した場合、MailExceptionをスローします。 送信せずに保存した場合も含めて、それ以外の場合には false を返します。 宛先が複数の場合、いずれかの宛先へのメールの送信に失敗した場合、 その失敗の原因に応じて例外を発生またはfalseを返します。 すべての宛先への送信が成功した場合、true を返します。

パーミッションとしてネイティブメーラの利用が許可されている トラステッドStar アプリのみこのメソッドを呼び出すことができます。 このメソッドを呼び出すとサスペンドします。

マルチタスク機能によってメーラが起動されていて未保存のデータがある状態の時にこのメソッドが呼ばれた場合、 現在実行中の Star アプリはサスペンドされ、 ユーザ確認のダイアログが表示されます。 ユーザがメーラの起動を許可した場合は、 ユーザ操作によりメールを送信します。 ユーザが起動を許可しなかった場合は、 このメソッドから戻って Star アプリの実行を継続します。

パラメータ:

mail - 送信するメールを指定します。

data - 添付ファイルの対象となるデータを指定します。

戻り値:

送信が完了した場合、true を返します。 それ以外の場合、false を返します。

例外:

com.docomostar.lang.UnsupportedOperationException -
ネイティブメーラへのファイル添付機能をサポートしていない場合に発生します。

NullPointerException -
引数 mail が null の場合に発生します。

NullPointerException -
引数 data のいずれかの要素に null が含まれていた場合に発生します。

IllegalArgumentException -
引数 mail に指定された MailDraft のサブジェクト、宛先アドレス、メール本文の内容のいずれかが、 i モードメールの仕様に準拠していない場合に発生します。

IllegalArgumentException -
引数 data の要素数が 0 の場合に発生します。

IllegalArgumentException -
引数 data の要素数が添付ファイル数の上限を超えた場合に発生します。

SecurityException -
ロック機能などのネイティブ独自のセキュリティ設定により、 メールを送信できない場合に発生します。

SecurityException -
ロック機能などのネイティブ独自のセキュリティ設定により、 添付対象のデータにアクセスできない場合に発生します。 なお、再配布識不可別子などの理由によってこのアプリケーションで扱えないデータにアクセスしようとした場合も含まれます。

com.docomostar.system.StoreException -
(STORE_FULL)
送信または未送信フォルダにメールを追加できないため、 メールを送信できない場合に発生します。

com.docomostar.system.StoreException -
(NOT_FOUND)
引数 data のいずれかの要素において、エントリ ID に対応したデータが存在しない場合に発生します。

AttachmentDataException -
(INVALID_DATA)
引数 data のいずれかの要素でデータ添付に失敗した場合に発生します。

AttachmentDataException -
(SIZE_OVER)
引数 data の各要素の合計サイズが添付可能サイズの上限を超えた場合に発生します。

com.docomostar.lang.IllegalStateException -
UIM 読み込み中の場合に発生します。

com.docomostar.system.MailException -
User Unknownなどによりサーバ側からメール送信を拒否された場合に発生します。

com.docomostar.system.InterruptedOperationException -
競合条件などにより、送信操作が異常終了した場合に発生します。