imap_uid

指定したメッセージシーケンス番号の UID を返す

説明

intfalse imap_uid(IMAP\Connection $imap, int $message_num)

この関数は、指定したメッセージシーケンス番号の UID を返します。 メッセージ番号はメールボックスの内容を変更する度に変わる可能性が ありますが、UID はユニークな ID であり時間が経過しても変わりません。

この関数は、imap_msgno の逆関数です。

パラメータ

imap

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

message_num

メッセージ番号。

戻り値

指定したメッセージの UID を返します。

変更履歴

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

注意

注意:

この関数は、POP3 メールボックスではサポートされません。

参考

  • imap_msgno