関数・クラス解説
imap_getsubscribed
version:PHP 4, PHP 5, PHP 7 (公式)購読中の全メールボックスの一覧を取得する
公式リファレンス
書式
imap_getsubscribed ( resource $imap_stream , string $ref , string $pattern ) : array
説明
購読中のメールボックスの情報を取得します。
imap_getmailboxes() と同じ動作をしますが、 ユーザーが購読しているメールボックスのみを返すという点が異なります。
パラメータ
- imap_stream
- imap_open()が返す IMAP ストリーム。
- ref
- ref は、通常は 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 - このメールボックスは選択可能な子を持ちません。
注意
警告信頼できないデータをこのパラメータに渡すのであれば、imap.enable_insecure_rshを無効にしておかなければ危険です。
ワード検索
※入力キーワードが、関数名・説明文・タグに含まれるものを検索関数名アルファベット別
最終更新一覧
●stristr
大文字小文字を区別せず文字列を検索し、ヒット箇所以降（あるいは以前）の文字列を返却
●stripslashes
バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く
●stripos
大文字小文字を区別せずに文字列が最初に現れる位置を取得する
●stripcslashes
addcslashes() でクォートされた文字列をアンクォートする
●strip_tags
文字列から HTML と PHP のタグを除去して返却
●strcspn
指定した文字が最初に現れる位置を調べる
●strcoll
ロケールに基づいて2つの文字列を比較し同じか（あるいは大小）を判定する
●strcmp
2つの文字列を比較し同じか（あるいは大小）を判定する
●strchr
strstr() のエイリアス
●strcasecmp
2つの文字列を比較（大文字小文字を区別せず同じとみなす）
カテゴリー一覧
PHP の振る舞いの変更
音声フォーマットの操作
認証サービス
コマンドライン関連
圧縮およびアーカイブ
暗号
データベース関連
日付および時刻関連
ファイルシステム
自然言語および文字エンコーディング
画像処理および作成
メール関連
数学
テキスト以外の MIME 型
プロセス制御
その他の基本モジュール
その他のサービス
検索エンジン用の拡張モジュール
サーバー固有のモジュール
セッション関連
テキスト処理
変数・データ型関連
ウェブサービス
Windows 用のモジュール
XML 操作
GUI用の拡張モジュール