Php/docs/function.imap-mailboxmsginfo

提供:Dev Guides
< Php
移動先:案内検索

imap_mailboxmsginfo

(PHP 4, PHP 5, PHP 7)

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


説明

imap_mailboxmsginfo ( resource $imap_stream ) : object

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


パラメータ

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


返り値

以下のプロパティを有するオブジェクトを返します。

Mailbox のプロパティ
Date 最終変更日 (現在の日付時刻)
Driver ドライバ
Mailbox メールボックスの名前
Nmsgs メッセージ数
Recent 最近のメッセージの数
Unread 未読のメッセージの数
Deleted 削除されたメッセージの数
Size メールボックスのサイズ

Returns false on failure.


例1 imap_mailboxmsginfo() example

<?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_mailboxmsginfo() に失敗: " . imap_last_error() . "<br />\n";}imap_close($mbox);?>