[函数]imap_undelete()函数—用法及示例

函数名：imap_undelete()

适用版本：PHP 4, PHP 5, PHP 7

用法：imap_undelete(resource $imap_stream, int $msg_number, int $options = 0) : bool

说明：imap_undelete() 函数用于取消删除已标记为删除的邮件。

参数：

• $imap_stream：必需，一个有效的 IMAP 流。
• $msg_number：必需，要取消删除的邮件的消息号。
• $options：可选，选项参数，默认为0。可以是以下值的按位或：
  • 0：不执行任何操作。
  • FT_UID：msg_number 是 UID。
  • FT_PEEK：返回消息而不将其标记为已读。

返回值：成功时返回 true，失败时返回 false。

示例：

// 连接到 IMAP 服务器
$imap_stream = imap_open("{imap.example.com:993/imap/ssl}INBOX", "username", "password");

// 取消删除邮件
$msg_number = 5;
if (imap_undelete($imap_stream, $msg_number)) {
    echo "邮件已成功取消删除！";
} else {
    echo "取消删除邮件失败！";
}

// 关闭 IMAP 连接
imap_close($imap_stream);

注意事项：

• 在使用该函数之前，必须通过 imap_open() 函数建立与 IMAP 服务器的连接。
• 取消删除邮件只是将邮件从标记为删除的状态恢复为正常状态，并没有真正地将邮件从邮箱中删除。要彻底删除邮件，可以使用 imap_delete() 函数。
• 如果使用 FT_PEEK 选项，函数将返回邮件内容，但不会将邮件标记为已读。