PHPのお勉強！

PHP TOP
PHP 8.4.2 Released!

    imap_getsubscribed

    (PHP 4, PHP 5, PHP 7, PHP 8)

    imap_getsubscribed — 購読中の全メールボックスの一覧を取得する

    説明

    imap_getsubscribed(IMAP\Connection $imap, string $reference, string $pattern): array|false

    購読中のメールボックスの情報を取得します。

    imap_getmailboxes() と同じ動作をしますが、 ユーザーが購読しているメールボックスのみを返すという点が異なります。

    パラメータ

    imap

    IMAP\Connection クラスのインスタンス。

    reference

    reference は、通常は imap_open() で指定したサーバー情報です。

    警告

    信頼できないデータをこのパラメータに渡すのであれば、 imap.enable_insecure_rsh を無効にしておかなければ危険です。

    pattern

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

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

    戻り値

    メールボックス情報を有するオブジェクトの配列を返します。各オブジェクトには、 メールボックスの完全な名前である name、 このメールボックスの階層の区切りを示す属性 delimiter、 そして attributes が存在します。 attributes はビットマスクであり、 次のものについて調べることができます。

    • LATT_NOINFERIORS - このメールボックスには 「子供」はいません（このボックスの中にメールボックスはありません）。
    • LATT_NOSELECT - 単なるコンテナであり、 メールボックスではありません - これをオープンすることはできません。
    • LATT_MARKED - このメールボックスにはマークが つけられています。UW-IMAPD でのみ使用されます。
    • LATT_UNMARKED - このメールボックスにはマークが つけられていません。UW-IMAPD でのみ使用されます。

    • LATT_REFERRAL - このコンテナはリモートメールボックスと関連を持ちます。

    • LATT_HASCHILDREN - このメールボックスは選択可能な子を持ちます。

    • LATT_HASNOCHILDREN - このメールボックスは選択可能な子を持ちません。

    この関数は、失敗した時に false を返します。

    変更履歴

    バージョン 説明
    8.1.0 引数 imap は、IMAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、有効な imap リソース が期待されていました。

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top