Home > PHP > Function > IMAP > imap_uid()

imap_uid()

imap_uid - This function returns the UID for the given message sequence number

Syntax

int imap_uid (resource $imap_stream, int $msg_number)

Arguments

  • imap_stream - An IMAP stream returned by imap_open().
  • msg_number - The message number.

Description

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.

Version

PHP 4, 5

Return value

The UID of the given message.