imap_status

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

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

説明

imap_status(IMAP\Connection $imap, string $mailbox, int $flags): stdClass|false

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

パラメータ

imap

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

mailbox

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

警告

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

flags

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

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

戻り値

この関数は、ステータス情報を含むオブジェクトを返します。失敗した場合に false を返します。このオブジェクトには messages、 recent、unseen、 uidnext および uidvalidity というプロパティが含まれます。

flags にも、上の各定数に対応するビットマスクを設定することができます。

変更履歴

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

例

例1 imap_status() の例

<?php
$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    . "<br />\n";
  echo "Recent:     " . $status->recent      . "<br />\n";
  echo "Unseen:     " . $status->unseen      . "<br />\n";
  echo "UIDnext:    " . $status->uidnext     . "<br />\n";
  echo "UIDvalidity:" . $status->uidvalidity . "<br />\n";
} else {
  echo "imap_status failed: " . imap_last_error() . "\n";
}

imap_close($mbox);
?>

Improve This Page

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

＋add a note

User Contributed Notes 1 note

down

mwwaygoo AT hotmail DOT com ¶

12 years ago

I had issues with imap_status not working correctly, while other imap functions seemed okay. I always got the ['flags']=0 response. No notes here and Google searching suggests it doesn't working properly with Exchange, so I wrote a little workaround, to at least get some information.

<?php
    function my_imap_status($stream, $mailbox='', $info=SA_ALL)
    {
        // get current mailbox name (and info)
        $curr_obj=imap_check($stream);
        if(!$curr_obj) return false;
        
        // if request if for current mailbox then just return it
        if( (empty($mailbox)) || ($mailbox==$curr_obj->Mailbox) ) return $curr_obj;
        
        // get current mailbox
        $current_mailbox=$curr_obj->Mailbox;
        
        //switch to new mailbox
        if(!imap_reopen($stream, $mailbox)) return false;
        
        // get info
        $obj=imap_check($stream);
        
        // switch back to original mailbox
        imap_reopen($stream, $current_mailbox);
        
        //return info
        return $obj;
    }
?>

＋add a note