4D Doc Center : IMAP

4D Internet Commands v14

IMAP_SubscribeMB


IMAP_SubscribeMB ( imap_ID ; mbName ; mbSubscribe ) -> 戻り値

引数	型	説明
imap_ID	倍長整数	IMAPログイン参照
mbName	テキスト	購読開始または停止するメールボックス名
mbSubscribe	整数	0 = 購読しない; 1= 購読する
戻り値	整数	エラーコード

説明

IMAP_SubscribeMB コマンドを使用して、IMAPサーバーの"購読済み"ユーザーメールボックスに指定したメールボックス名を追加したり、またはそこから取り除くことができます。

このコマンドを利用することで、ユーザは数多くの利用可能なメールボックスの中から、通常閲覧を行うメールボックスを指定し、リストの数を減らすことができます。これを行うには、単にIMAP_ListMBs コマンドをsubscribedMB オプション引数に1を指定して実行します (IMAP_ListMBs参照)。

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

mbName は購読を開始または停止するメールボックスのフル名です。

mbSubscribe に0を渡すと購読を停止します。1を渡すと購読を開始します。