Home/ Manual/ imap / functions/ imap_uid

imap_uid

PHP function Edit on GitHub ✎

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

This function returns the UID for the given message sequence number

Description

imap_uid(IMAP\Connection $imap, int $message_num): int|false

This function returns the UID for the given message sequence number. An UID is a unique identifier that will not change over time while a message sequence number may change whenever the content of the mailbox changes.

This function is the inverse of imap_msgno().

Parameters

message_num: The message number.

Return Values

The UID of the given message.

Changelog

Version	Description

Notes

Note

This function is not supported by POP3 mailboxes.