imap_mailboxmsginfo

(PHP 3 >= 3.0.2, PHP 4, PHP 5)

imap_mailboxmsginfo -- 現在のメールボックスに関する情報を得る

説明

object imap_mailboxmsginfo ( resource imap_stream )

現在のメールボックスに関する情報を返します。 失敗した場合に FALSE を返します。

imap_mailboxmsginfo() 関数は、サーバにおける 現在のメールボックスのステータスを調べます。この関数は imap_status() に似ていますが、メールボックス内の の全メッセージのサイズを合計します。このため、実行時間が 幾分余計にかかります。この関数は、以下のプロパティを有する オブジェクトを返します。

表 1. Mailbox のプロパティ

Date最終変更日
Driverドライバ
Mailboxメールボックスの名前
Nmsgsメッセージ数
Recent最近のメッセージの数
Unread未読のメッセージの数
Deleted削除されたメッセージの数
Sizeメールボックスのサイズ

例 1. imap_mailboxmsginfo() の例

<?php

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

$check = imap_mailboxmsginfo($mbox);

if (
$check) {
    echo
"Date: "     . $check->Date    . "<br />\n" ;
    echo
"Driver: "   . $check->Driver  . "<br />\n" ;
    echo
"Mailbox: "  . $check->Mailbox . "<br />\n" ;
    echo
"Messages: " . $check->Nmsgs   . "<br />\n" ;
    echo
"Recent: "   . $check->Recent  . "<br />\n" ;
    echo
"Unread: "   . $check->Unread  . "<br />\n" ;
    echo
"Deleted: "  . $check->Deleted . "<br />\n" ;
    echo
"Size: "     . $check->Size    . "<br />\n" ;
} else {
    echo
"imap_check() に失敗: " . imap_last_error() . "<br />\n";
}

imap_close($mbox);

?>