PHP 5.6.0 released

imap_status

(PHP 4, PHP 5)

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

説明

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

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

パラメータ

imap_stream

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

mailbox

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

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 - 上記のものをすべて設定する

返り値

この関数は、ステータス情報を含むオブジェクトを返します。このオブジェクトには messagesrecentunseenuidnext および uidvalidity というプロパティが含まれます。

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

例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);
?>

add a note add a note

User Contributed Notes 3 notes

up
0
mwwaygoo AT hotmail DOT com
2 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;
    }
?>
up
0
razonklnbd at hotmail dot com
6 years ago
another tips is to get only total number of message and recent message

$imap_obj = imap_status($mbox, '{mail.mysrv.com:143/imap}INBOX', SA_MESSAGES+SA_RECENT);
echo('<pre>'); var_dump($imap_obj); echo('</pre>');
up
0
jille at DIESPAMMERShexon dot cx
7 years ago
In 'reply' to my previous post;
I`m not sure of that anymore
I think this trick works,
but the rest of my script just sucks..

Conclusion:
You can get the last UID by using status->uidnext-1
BUT: This is not a good way, if another message is added after your append and before your status; you are screwed
To Top