関数・クラス解説

imap_status

現在のメールボックス以外のメールボックスのステータス情報を返す

公式リファレンス

書式

imap_status ( resource $imap_stream , string $mailbox , int $options ) : object

説明

指定したメールボックス mailbox についてのステータス情報を取得します。

パラメータ

imap_stream

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

mailbox

メールボックス名。詳細は imap_open() を参照ください。

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

options

以下のフラグが使用できます。

• SA_MESSAGES - $status->messages にメールボックスのメッセージ数を設定する
• SA_RECENT - $status->recent にメールボックスの最近のメッセージ数を設定する
• SA_UNSEEN - $status->unseen にメールボックスの未読の(新規)メッセージ数を設定する
• SA_UIDNEXT - $status->uidnext にメールボックスの次の UID を設定する
• SA_UIDVALIDITY - メールボックスの UID がもはや有効ではない場合に変化する定数を $status->uidvalidity に設定する
• SA_ALL - 上記のものをすべて設定する

返値

この関数は、ステータス情報を含むオブジェクトを返します。このオブジェクトには messages、 recent、unseen、 uidnext および uidvalidity というプロパティが含まれます。 flags にも、 上の各定数に対応するビットマスクを設定することができます。

注意

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

サンプル

例1 imap_status() の例
 

$mbox = imap_open("{imap.example.com}", "username", "password", OP_HALFOPEN)
      or die("接続できません: " . imap_last_error());

$status = imap_status($mbox, "{imap.example.org}INBOX", SA_ALL);
if ($status) {
  echo "Messages:   " . $status->messages    . "\n";
  echo "Recent:     " . $status->recent      . "\n";
  echo "Unseen:     " . $status->unseen      . "\n";
  echo "UIDnext:    " . $status->uidnext     . "\n";
  echo "UIDvalidity:" . $status->uidvalidity . "\n";
} else {
  echo "imap_status failed: " . imap_last_error() . "\n";
}

imap_close($mbox);

ワード検索

関数名アルファベット別

最終更新一覧

●stristr
　大文字小文字を区別せず文字列を検索し、ヒット箇所以降（あるいは以前）の文字列を返却

●stripslashes
　バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

●stripos
　大文字小文字を区別せずに文字列が最初に現れる位置を取得する

●stripcslashes
　addcslashes() でクォートされた文字列をアンクォートする

●strip_tags
　文字列から HTML と PHP のタグを除去して返却

●strcspn
　指定した文字が最初に現れる位置を調べる

●strcoll
　ロケールに基づいて2つの文字列を比較し同じか（あるいは大小）を判定する

●strcmp
　2つの文字列を比較し同じか（あるいは大小）を判定する

●strchr
　strstr() のエイリアス

●strcasecmp
　2つの文字列を比較（大文字小文字を区別せず同じとみなす）

カテゴリー一覧

PHP の振る舞いの変更
音声フォーマットの操作
認証サービス
コマンドライン関連
圧縮およびアーカイブ
暗号
データベース関連
日付および時刻関連
ファイルシステム
自然言語および文字エンコーディング
画像処理および作成
メール関連
数学
テキスト以外の MIME 型
プロセス制御
その他の基本モジュール
その他のサービス
検索エンジン用の拡張モジュール
サーバー固有のモジュール
セッション関連
テキスト処理
変数・データ型関連
ウェブサービス
Windows 用のモジュール
XML 操作
GUI用の拡張モジュール