« imap_mail_move
imap_mime_header_decode »

imap_mailboxmsginfo

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

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

説明

function imap_mailboxmsginfo(IMAP\Connection $imap): stdClass

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

パラメータ

imap

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

戻り値

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

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

変更履歴

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

例

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

?>

関連キーワード:
imap   check   メールボックス   mailboxmsginfo   メッセージ   Mailbox   Connection   Date   Driver   Recent   Unread   Deleted   Size   mbox   インスタンス   プロパティ   Nmsgs   期待   example   last   mail   move   mime   header   decode
関連する関数・ページ:
function.imap-check   function.imap-delete   function.imap-num-msg   function.imap-num-recent   function.imap-append   function.imap-deletemailbox