imap_num_msg

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

imap_num_msg現在のメールボックスのメッセージ数を取得する

説明

imap_num_msg(IMAP\Connection $imap): int|false

現在のメールボックスにあるメッセージ数を返します。

パラメータ

imap

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

戻り値

現在のメールボックスのメッセージ数を整数として返します。 またはエラー時に false を返します。

変更履歴

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

参考

  • imap_num_recent() - 現在のメールボックスにある新規メッセージ数を取得する
  • imap_status() - 現在のメールボックス以外のメールボックスのステータス情報を返す

関連キーワード:  メールボックス, メッセージ, 取得, num, Connection, バージョン, recent, クラス, インスタンス, 期待