4D Doc Center : IMAP

4D Internet Commands v14

IMAP_GetMBStatus


IMAP_GetMBStatus ( imap_ID ; mbName ; msgNber ; newMsgNber ; unseenMsgNber ; mbUID ) -> 戻り値

引数	型	説明
imap_ID	倍長整数	IMAPログイン参照
mbName	テキスト	メールボックス名
msgNber	倍長整数	指定したメールボックス中のメール数
newMsgNber	倍長整数	\Recentフラグがセットされたメッセージ数
unseenMsgNber	倍長整数	\Seenフラグが設定されていないメッセージ数
mbUID	倍長整数	指定したメールボックスのユニークなID
戻り値	整数	エラーコード

説明

IMAP_GetMBStatus コマンドは、mbNameで指定したメールボックスのステータス値を返します。このコマンドはカレントのメールボックスを変更しません (IMAP_SetCurrentMB参照) 、また指定されたメールボックスのステータスにも影響しません (特にメッセージの \Recent フラグを失うようなことはありませんが、これはIMAP4サーバの実装にもよります)。

このコマンドは特に以下のケースで有効です:

メールボックスのユニークIDをチェックまたは取得する
メールボックスのセッションを開かずに、新着や未読のメッセージ数をチェックする

重要: カレントのメールボックスに対してIMAP_GetMBStatus コマンドをコールしないようにすることを強く推奨します。これを行うと問題が発生し、返された情報が不必要にカレントのメールボックスのステータスと同期されてしまうかもしれません (特に新着メール)。

imap_ID はIMAP_Loginで作成されるIMAPログイン参照です。

mbName はステータスを取得する既存のメールボックスの完全名です。

Note: IMAP_ListMBs コマンドと異なり、mbName 引数はワイルドカードを受け入れません。

msgNber にはカレントメールボックスのメッセージ数が返されます (コマンドが呼び出されるとき0に設定され、エラーの際には-1が返されます)。

newMsgNber にはカレントメールボックスの新規メッセージ数が返されます (コマンドが呼び出されるとき0に設定され、エラーの際には-1が返されます)。

unseenMsgNber にはカレントメールボックスの未読メッセージ数が返されます (コマンドが呼び出されるとき0に設定され、エラーの際には-1が返されます)。

mbUID にはメールボックスのユニークIDが返されます (コマンドが呼び出されるとき0に設定され、エラーの際には-1が返されます)。

IMAP4プロトコルでは、メールボックス名はメールボックスを指定する目的で使用するには十分でありません。そこで、ユニークIDがメールボックスに割り当てられています。このIDは特に同期処理に有効です。

メールボックス"A"が"B"に名称変更されていたり、削除されていた場合、ユニークIDを使用してチェックができます。

また、このIDを使用してメールボックス"A"が削除された後に、新しくメールボックス"A"が作成されたかもチェックできます。