com.j_phone.phonedata
インタフェース MailData

すべてのスーパーインタフェース:
DataElement

public interface MailData
extends DataElement

メールデータを扱うためのインタフェースです。

このインタフェースを実装したメールデータオブジェクトは、getType()メソッドの戻り値に"MailData"を返します。

新規に作成したメールデータは各項目に値を設定できますが、 送信メールボックスまたは受信メールボックスから取得したメールデータは、各項目のデータを取得するだけで設定はできません。 メールデータから取得できる項目は、送信メールボックスまたは受信メールボックスから取得したメールデータと、新規作成したメールデータでそれぞれに異なります。

以下にDataElementインタフェースから継承したメソッドを使用して、項目の値を取得および設定する項目の一覧を示します。

メールデータ項目一覧
項目 id値 送信メールボックス
データ
受信メールボックス
データ
新規作成データ 取得メソッド 設定メソッド
取得 設定 取得 設定 取得 設定
送信元メールアドレス FROM_ADDRESS_INFO × × × × × getString() setString()
送信先TOメールアドレス TO_ADDRESS_INFO × ×
送信先CCメールアドレス CC_ADDRESS_INFO × ×
送信先BCCメールアドレス BCC_ADDRESS_INFO × × ×
Reply-Toメールアドレス REPLYTO_ADDRESS_INFO × ×
送信元名前 FROM_NAME_INFO × × × × ×
送信先TO名前 TO_NAME_INFO × × × ×
送信先CC名前 CC_NAME_INFO × × × ×
送信先BCC名前 BCC_NAME_INFO × × × ×
タイトル SUBJECT_INFO × ×
本文 BODY_INFO × ×
受信時間/送信時間 DATE_INFO - - × - getDate() -
メール種別 MAIL_TYPE_INFO × × getInt() setInt()

送信先TO、CC、BCCメールアドレス、およびメールアドレスに対応する名前はデータを複数持つことができます。

MailDataインタフェースは、メールの状態や添付ファイルなどのメールデータの設定を取得するメソッドや設定するメソッドを提供します。 以下にMailDataインタフェースに定義された、メールデータの設定を取得するメソッドおよび設定するメソッドを示します。

メールデータ設定一覧
項目 送信メールボックス
データ
受信メールボックス
データ
新規作成データ 取得メソッド 設定メソッド
取得 設定 取得 設定 取得 設定
メッセージ状態(既読/未読) × × × × isUnRead() setState()
添付ファイルの数 - - - getAttachedFileCount() -
添付ファイルの名前 - - getAttachedFileName() setAttachedFile()
添付ファイルのデータ × × getAttachedFileData() setAttachedData()
メールの続きの有無 × - - × - hasRemainder() -
送信状況 - × - × - hasSendState() -
配信確認 - × - × - - setConfirm()
優先度 - × - × - - setPriority()

受信メールボックスのメールデータは、メールデータの一部分だけを受信しており 受信していないメールの続きの部分がメールサーバに存在している場合があります。 メールサーバに受信していないメールの続き部分があるかどうかはhasRemainder()メソッドによって取得できます。 メールサーバに存在するメールの続き部分を受信する場合は、 MailAgentクラスのreceiveRemainder()メソッドを呼び出します。 receiveRemainder()メソッドを呼び出したあとは受信メールボックスの内容が変わるので、 受信メールボックスの取得からメールデータの取得をやり直す必要があります。

導入されたバージョン:
JSCL 1.2

フィールドの概要
static int ADREAD
          setState()により設定するメールステータスで、既読を示します(=1)。
static int BCC_ADDRESS_INFO
          Bcc メールアドレスを示す id 値(=4)です。
static int BCC_NAME_INFO
          Bcc メールアドレスに対応する名前を示す id 値(=9)です。
static int BODY_INFO
          本文を示す id 値(=11)です。
static int CC_ADDRESS_INFO
          Cc メールアドレスを示す id 値(=3)です。
static int CC_NAME_INFO
          Cc メールアドレスに対応する名前を示す id 値(=8)です。
static int CONFIRM_OFF
          setConfirm()により設定する配信確認の設定で、配信確認OFFを示します(=0)。
static int CONFIRM_ON
          setConfirm()により設定する配信確認の設定で、配信確認ONを示します(=1)。
static int DATE_INFO
          受信時間または送信時間を示す id 値(=12)です。
static int FROM_ADDRESS_INFO
          From メールアドレスを示す id 値(=1)です。
static int FROM_NAME_INFO
          From メールアドレスに対応する名前を示す id 値(=6)です。
static int MAIL_TYPE_GREETING
          MAIL_TYPE_INFO によって取得または設定するメール種別でグリーティングメールを示す値です(=2)。
static int MAIL_TYPE_INFO
          メール種別を示す id 値(=13)です。
static int MAIL_TYPE_SKY
          MAIL_TYPE_INFO によって取得または設定するメール種別でスカイメールを示す値です(=1)。
static int MAIL_TYPE_SUPER
          MAIL_TYPE_INFO によって取得または設定するメール種別でスーパーメールを示す値です(=0)。
static int PRIORITY_NOMAL
          setPriority()により設定する優先順位で、普通を示します(=0)。
static int PRIORITY_URGENT
          setPriority()により設定する優先順位で、速達を示します(=1)。
static int REPLYTO_ADDRESS_INFO
          Reply-To メールアドレスを示す id 値(=5)です。
static int SEND_STATE_CANCEL
          hasSendState()により取得するメールの送信状況で、送信がキャンセルされたことを示します(=2)。
static int SEND_STATE_FAIL
          hasSendState()により取得するメールの送信状況で、送信できなかったことを示します(=3)。
static int SEND_STATE_MIDST
          hasSendState()により取得するメールの送信状況で、送信中であることを示します(=0)。
static int SEND_STATE_NO_MESSAGE
          hasSendState()により取得するメールの送信状況で、送信状況のメッセージがないことを示します(=4)。
static int SEND_STATE_SUCCESS
          hasSendState()により取得するメールの送信状況で、送信が完了したことを示します(=1)。
static int SUBJECT_INFO
          タイトルを示す id 値(=10)です。
static int TO_ADDRESS_INFO
          To メールアドレスを示す id 値(=2)です。
static int TO_NAME_INFO
          To メールアドレスに対応する名前を示す id 値(=7)です。
static int UNREAD
          setState()により設定するメールステータスで、未読を示します(=0)。
 
インタフェース com.j_phone.phonedata.DataElement から継承したフィールド
BOOLEAN, DATE, INT, STRING
 
メソッドの概要
 int getAttachedFileCount()
          添付ファイルの数を取得します。
 byte[] getAttachedFileData(int index)
          添付ファイルのデータを取得します。
 java.lang.String getAttachedFileName(int index)
          添付ファイルの名前を取得します。
 boolean hasRemainder()
          メールの続きの有無を取得します。
 int hasSendState()
          メールの送信状況を取得します。
 boolean isUnRead()
          未読かどうかを取得します。
 void removeAttachedFile(int index)
          メールに設定されている添付ファイルを解除します。
 int setAttachedData(byte[] data, java.lang.String attachedFileName, int fileType)
          メールにバイトデータを添付ファイルとして設定します。
 int setAttachedFile(java.lang.String pathname)
          メールに添付ファイルを設定します。
 void setConfirm(int confirm)
          配信確認を設定します。
 void setPriority(int priority)
          優先度を設定します。
 void setState(int state)
          メールのステータス(未読/既読)を設定します。
 
インタフェース com.j_phone.phonedata.DataElement から継承したメソッド
createClone, getBoolean, getDataType, getDate, getElementCount, getInt, getString, getType, isListElement, setBoolean, setInt, setString
 

フィールドの詳細

FROM_ADDRESS_INFO

public static final int FROM_ADDRESS_INFO
From メールアドレスを示す id 値(=1)です。

受信メールボックスのメールの From に設定されたメールアドレスを取得する場合に使用します。 送信メールボックスのメールおよび新規作成したメールには使用できません。


TO_ADDRESS_INFO

public static final int TO_ADDRESS_INFO
To メールアドレスを示す id 値(=2)です。

受信メールボックスまたは送信メールボックスのメールの To に設定されたメールアドレスを取得する場合、 および新規作成したメールの To メールアドレスを取得または設定する場合に使用します。

メールアドレスは複数設定されていることがあります。 メールアドレスの設定数は、DataElement クラスのgetElementCount()メソッドにより取得できます。 メールアドレスの設定数の制限は、To、Cc、Bcc 合わせて5件(スカイメールへの設定数は To 1件)です。 メールアドレスと電話番号を混在して指定できるかどうかは機種に依存します。


CC_ADDRESS_INFO

public static final int CC_ADDRESS_INFO
Cc メールアドレスを示す id 値(=3)です。

受信メールボックスまたは送信メールボックスのメールの Cc に設定されたメールアドレスを取得する場合、 および新規作成したメールの Cc メールアドレスを取得または設定する場合に使用します。

メールアドレスは複数設定されていることがあります。 メールアドレスの設定数は、DataElement インタフェースのgetElementCount()メソッドにより取得できます。 メールアドレスの設定数の制限は、To、Cc、Bcc 合わせて5件です。 スカイメールへの設定は無効になります。 メールアドレスと電話番号を混在して指定できるかどうかは機種に依存します。


BCC_ADDRESS_INFO

public static final int BCC_ADDRESS_INFO
Bcc メールアドレスを示す id 値(=4)です。

送信メールボックスのメールの Bcc に設定されたメールアドレスを取得する場合、 および新規作成したメールの Bcc メールアドレスを取得または設定する場合に使用します。 受信メールボックスのメールには使用できません。

メールアドレスは複数設定されていることがあります。 メールアドレスの設定数は、DataElement クラスのgetElementCount()メソッドにより取得できます。 メールアドレスの設定数の制限は、To、Cc、Bcc 合わせて5件です。 スカイメールへの設定は無効になります。 メールアドレスと電話番号を混在して指定できるかどうかは機種に依存します。


REPLYTO_ADDRESS_INFO

public static final int REPLYTO_ADDRESS_INFO
Reply-To メールアドレスを示す id 値(=5)です。

受信メールボックスまたは送信メールボックスのメールの Reply-To に設定されたメールアドレスを取得する場合、 および新規作成したメールの Reply-To メールアドレスを取得または設定する場合に使用します。 スカイメールへの設定は無効になります。


FROM_NAME_INFO

public static final int FROM_NAME_INFO
From メールアドレスに対応する名前を示す id 値(=6)です。

FROM_ADDRESS_INFO で取得するメールアドレスに対応する名前を取得する場合に使用します。 アドレス帳にメールアドレスに対応する名前が登録されていない場合 null が返ります。


TO_NAME_INFO

public static final int TO_NAME_INFO
To メールアドレスに対応する名前を示す id 値(=7)です。

TO_ADDRESS_INFO で取得するメールアドレスに対応する名前を取得する場合に使用します。 TO_ADDRESS_INFO と異なり、受信メールボックスのメールには使用できません。 アドレス帳にメールアドレスに対応する名前が登録されていない場合 null が返ります。


CC_NAME_INFO

public static final int CC_NAME_INFO
Cc メールアドレスに対応する名前を示す id 値(=8)です。

CC_ADDRESS_INFO で取得するメールアドレスに対応する名前を取得する場合に使用します。 CC_ADDRESS_INFO と異なり、受信メールボックスのメールには使用できません。 アドレス帳にメールアドレスに対応する名前が登録されていない場合 null が返ります。


BCC_NAME_INFO

public static final int BCC_NAME_INFO
Bcc メールアドレスに対応する名前を示す id 値(=9)です。

BCC_ADDRESS_INFO で取得するメールアドレスに対応する名前を取得する場合に使用します。 アドレス帳にメールアドレスに対応する名前が登録されていない場合 null が返ります。


SUBJECT_INFO

public static final int SUBJECT_INFO
タイトルを示す id 値(=10)です。

受信メールボックスまたは送信メールボックスのメールからタイトルを取得する場合、 および新規作成したメールのタイトルを取得または設定する場合に使用します。


BODY_INFO

public static final int BODY_INFO
本文を示す id 値(=11)です。

受信メールボックスまたは送信メールボックスのメールから本文を取得する場合、 および新規作成したメールの本文を取得または設定する場合に使用します。


DATE_INFO

public static final int DATE_INFO
受信時間または送信時間を示す id 値(=12)です。

受信メールボックスのメールの受信時間、または送信メールボックスのメールの送信時間を取得する場合に使用します。


MAIL_TYPE_INFO

public static final int MAIL_TYPE_INFO
メール種別を示す id 値(=13)です。

メール種別を取得または設定する場合に使用します。


MAIL_TYPE_SUPER

public static final int MAIL_TYPE_SUPER
MAIL_TYPE_INFO によって取得または設定するメール種別でスーパーメールを示す値です(=0)。

MAIL_TYPE_SKY

public static final int MAIL_TYPE_SKY
MAIL_TYPE_INFO によって取得または設定するメール種別でスカイメールを示す値です(=1)。

MAIL_TYPE_GREETING

public static final int MAIL_TYPE_GREETING
MAIL_TYPE_INFO によって取得または設定するメール種別でグリーティングメールを示す値です(=2)。 新規作成したメールデータのメール種別にグリーティングメールは設定できません。

PRIORITY_NOMAL

public static final int PRIORITY_NOMAL
setPriority()により設定する優先順位で、普通を示します(=0)。

PRIORITY_URGENT

public static final int PRIORITY_URGENT
setPriority()により設定する優先順位で、速達を示します(=1)。

CONFIRM_OFF

public static final int CONFIRM_OFF
setConfirm()により設定する配信確認の設定で、配信確認OFFを示します(=0)。

CONFIRM_ON

public static final int CONFIRM_ON
setConfirm()により設定する配信確認の設定で、配信確認ONを示します(=1)。

UNREAD

public static final int UNREAD
setState()により設定するメールステータスで、未読を示します(=0)。

ADREAD

public static final int ADREAD
setState()により設定するメールステータスで、既読を示します(=1)。

SEND_STATE_MIDST

public static final int SEND_STATE_MIDST
hasSendState()により取得するメールの送信状況で、送信中であることを示します(=0)。

SEND_STATE_SUCCESS

public static final int SEND_STATE_SUCCESS
hasSendState()により取得するメールの送信状況で、送信が完了したことを示します(=1)。

SEND_STATE_CANCEL

public static final int SEND_STATE_CANCEL
hasSendState()により取得するメールの送信状況で、送信がキャンセルされたことを示します(=2)。

SEND_STATE_FAIL

public static final int SEND_STATE_FAIL
hasSendState()により取得するメールの送信状況で、送信できなかったことを示します(=3)。

SEND_STATE_NO_MESSAGE

public static final int SEND_STATE_NO_MESSAGE
hasSendState()により取得するメールの送信状況で、送信状況のメッセージがないことを示します(=4)。
メソッドの詳細

isUnRead

public boolean isUnRead()
                 throws java.io.IOException
未読かどうかを取得します。

受信メールボックス以外のメールに対して呼び出された場合は false を返します。

戻り値:
true:未読
例外:
java.io.IOException - データの読み込みに失敗した場合などに発生する

hasRemainder

public boolean hasRemainder()
                     throws java.io.IOException
メールの続きの有無を取得します。

メールサーバに受信していないメールの続き部分があるかどうかを返します。 受信メールボックス以外のメールに対して呼び出された場合は false を返します。

戻り値:
true:続き有り
例外:
java.io.IOException - データの読み込みに失敗した場合などに発生する

hasSendState

public int hasSendState()
                 throws java.io.IOException
メールの送信状況を取得します。
戻り値:
送信状況。SEND_STATE_MIDSTSEND_STATE_SUCCESSSEND_STATE_CANCELSEND_STATE_FAILSEND_STATE_NO_MESSAGEのどれか。
例外:
java.io.IOException - データの読み込みに失敗した場合などに発生する

getAttachedFileCount

public int getAttachedFileCount()
                         throws java.io.IOException
添付ファイルの数を取得します。
戻り値:
添付ファイル数
例外:
java.io.IOException - データの読み込みに失敗した場合などに発生する

getAttachedFileName

public java.lang.String getAttachedFileName(int index)
                                     throws java.io.IOException
添付ファイルの名前を取得します。

添付ファイルのデータ種別は拡張子から判断します。 添付ファイル番号は 1 から始まり、添付ファイル数が最後の添付ファイル番号となります。 データが存在しない添付ファイル番号を指定された場合は null を返します。

パラメータ:
index - 添付ファイル番号
戻り値:
添付ファイル名
例外:
SecurityException - シークレット状態のメールデータから呼び出された場合に発生する
java.io.IOException - データの読み込みに失敗した場合などに発生する

getAttachedFileData

public byte[] getAttachedFileData(int index)
                           throws java.io.IOException
添付ファイルのデータを取得します。 データが存在しない添付ファイル番号を指定された場合は null を返します。 setAttachedFile()を使用して設定されたファイルは取得できません。
パラメータ:
index - 添付ファイル番号
戻り値:
添付ファイルデータ
例外:
SecurityException - シークレット状態のメールデータから呼び出された場合に発生する
java.io.IOException - データの読み込みに失敗した場合などに発生する

setState

public void setState(int state)
              throws java.io.IOException
メールのステータス(未読/既読)を設定します。
パラメータ:
state - 未読(UNREAD)、既読(ADREAD)のどちらか
例外:
java.lang.IllegalArgumentException - 引数stateが不正な場合に発生する
SecurityException - シークレット状態のメールデータから呼び出された場合に発生する
java.io.IOException - 変更できないメールに対して実行した場合、または変更に失敗した場合に発生する

setAttachedFile

public int setAttachedFile(java.lang.String pathname)
                    throws java.io.IOException
メールに添付ファイルを設定します。

引数pathnameに指定する添付ファイルはパス名です。 パス名は、StorageConnectionインタフェースと同じ形式で指定してください。 設定できる添付ファイルの形式は任意のファイル形式です。 新規作成したメールデータに設定できます。受信メールボックスまたは送信メールボックスにある既存メールへは設定できません。 添付ファイルの最大設定数は20ファイルです。

パラメータ:
pathname - パス名
戻り値:
添付ファイル番号
例外:
IllegalStateException - 最大設定数まで設定されている場合に発生する
java.io.IOException - 設定できないメールに対して実行した場合、または送信不可のファイルが指定された場合に発生する
NullPointerException - 引数pathnameが null の場合に発生する

setAttachedData

public int setAttachedData(byte[] data,
                           java.lang.String attachedFileName,
                           int fileType)
                    throws java.io.IOException
メールにバイトデータを添付ファイルとして設定します。

バイトデータの配列を添付ファイルとしてメールに設定します。 引数attachedFileNameに指定する添付ファイル名の規定はありません。添付ファイルとして識別できる名前を指定してください。 引数filetypeにはStorageConnectionインタフェースに定義されているファイルタイプを指定してください。 新規作成したメールデータに設定できます。受信メールボックスまたは送信メールボックスにある既存メールへは設定できません。 添付ファイルの最大設定数は20ファイルです。

パラメータ:
data - バイトデータ
attachedFileName - ファイル名
fileType - ファイルタイプ
戻り値:
添付ファイル番号
例外:
IllegalStateException - 最大設定数まで設定されている場合に発生する
java.lang.IllegalArgumentException - 無効なfileTypeを指定した場合に発生します
java.io.IOException - 設定できないメールに対して実行した場合に発生する
NullPointerException - 引数が null の場合に発生する

removeAttachedFile

public void removeAttachedFile(int index)
                        throws java.io.IOException
メールに設定されている添付ファイルを解除します。

メールと添付ファイルの関連を解除します。 このメソッドは、新規作成したメールデータに対して呼び出すことができます。 受信メールボックスまたは送信メールボックスにある既存メールデータに対して呼び出すことはできません。

パラメータ:
index - 添付ファイル番号
例外:
java.lang.IllegalArgumentException - 引数indexに添付ファイルが設定されていない場合に発生する
java.io.IOException - 設定できないメールに対して実行した場合に発生する

setConfirm

public void setConfirm(int confirm)
                throws java.io.IOException
配信確認を設定します。

新規作成したメールデータに設定できます。受信メールボックスまたは送信メールボックスにある既存メールデータへは設定できません。 新規作成したメールデータの配信確認の初期値は CONFIRM_OFF に設定されています。

送信先メールアドレスが複数設定されているメールデータや、送信先メールアドレスがEメールアドレスのメールデータは、 配信確認を設定しても無視されます。

パラメータ:
confirm - 配達確認 CONFIRM_ONCONFIRM_OFFのどちらか
例外:
java.lang.IllegalArgumentException - 引数confirmが不正な場合に発生する
java.io.IOException - 設定できないメールに対して実行した場合に発生する

setPriority

public void setPriority(int priority)
                 throws java.io.IOException
優先度を設定します。

新規作成したメールデータに設定できます。受信メールボックスまたは送信メールボックスにある既存メールへは設定できません。 新規作成したメールデータの優先度の初期値は PRIORITY_NOMAL に設定されています。

送信先メールアドレスが複数設定されているメールデータや、送信先メールアドレスがEメールアドレスのメールデータは、 優先度を設定しても無視されます。

パラメータ:
priority - 優先度 PRIORITY_NOMALPRIORITY_URGENTのどちらか
例外:
java.lang.IllegalArgumentException - 引数priorityが不正な場合に発生する
java.io.IOException - 設定できないメールに対して実行した場合に発生する