imap_uid

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

imap_uidThis function returns the UID for the given message sequence number

说明

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().

参数

imap

IMAP\Connection 实例。

message_num

The message number.

返回值

The UID of the given message.

更新日志

版本 说明
8.1.0 现在 imap 参数接受 IMAP\Connection 实例,之前接受有效的 imap resource

注释

注意:

This function is not supported by POP3 mailboxes.

参见

  • imap_msgno() - Gets the message sequence number for the given UID

添加备注

用户贡献的备注 4 notes

up
8
Denis Rendler
9 years ago
I would like to point out that, at least in the case of Gmail, the UIDs of emails are changed if they are moved from one folder to another. Even if moved back to the same folder the UIDs get incremented and thus changed.
I found this the hard way after relaying on the notion that UIDs do not change as I found almost everywhere in the docs.
up
5
steve_foley at excite dot com
22 years ago
Please note that message_id in the header is NOT the UID - and its dangerous to use as many mail progs don't put a message id in
up
4
Maikel
14 years ago
Be aware that the uid is unique in a single mailbox. That means a message can have as much uids as mailboxes
up
2
Andreas Seeger
16 years ago
The uid will change in case of unsing imap_expunge. Be shure that
all work ist done before using imap_expunge.
To Top