購読しているすべてのメールボックスの一覧を得る

# imap_lsub

(PHP 4, PHP 5, PHP 7)

imap_lsub — 購読しているすべてのメールボックスの一覧を得る

### 説明

imap_lsub ( resource `$imap_stream` , string `$ref` , string `$pattern` ) : array

購読しているすべてのメールボックスの配列を取得します。

### パラメータ

`imap_stream`

  imap_open() が返す IMAP ストリーム。

`ref`

  通常、`ref` は imap_open() で述べられているサーバー定義です。

`pattern`

  検索を開始するメールボックスの階層を指定します。

  `pattern` の中で使用できる特別な文字として '*' および '%' があります。 '*' は、すべてのメールボックスを意味します。 `pattern` に '*' を指定すると、 メールボックス階層全体のリストが得られます。 '%' は現在のレベルのみを意味します。 '%' を `pattern` に指定すると、 トップレベルのメールボックスのみを返します。UW_IMAPD の場合、 '~/mail/%' は ~/mail ディレクトリ内のすべてのメールボックスを返しますが、 そのディレクトリのサブフォルダにあるメールボックスは返しません。

### 返り値

購読しているすべてのメールボックスの配列を返します。

### 参考

- imap_list() - メールボックスのリストを読み込む
- imap_getmailboxes() - メールボックスのリストを読み込み、各ボックスに関する詳細な情報を返す