函数名:imap_expunge()
适用版本:PHP 4、PHP 5、PHP 7
函数说明:imap_expunge() 函数用于从当前邮箱中永久删除所有标记为删除的邮件。
语法:bool imap_expunge ( resource $imap_stream )
参数:
- $imap_stream:一个有效的 IMAP 流资源,通过 imap_open() 函数返回。
返回值:成功时返回 true,失败时返回 false。
示例:
// 连接到 IMAP 服务器
$imap_server = "{imap.example.com:993/imap/ssl}INBOX";
$imap_username = "your_username";
$imap_password = "your_password";
$imap_stream = imap_open($imap_server, $imap_username, $imap_password);
// 检查连接是否成功
if (!$imap_stream) {
die("无法连接到 IMAP 服务器");
}
// 标记邮件为删除
imap_setflag_full($imap_stream, "1,2,3", "\\Deleted");
// 永久删除标记为删除的邮件
if (imap_expunge($imap_stream)) {
echo "成功删除标记为删除的邮件";
} else {
echo "删除邮件失败";
}
// 关闭 IMAP 连接
imap_close($imap_stream);
在上面的示例中,我们首先通过 imap_open() 函数连接到 IMAP 服务器,并成功验证用户凭据。然后,我们使用 imap_setflag_full() 函数将邮件 1、2 和 3 标记为删除。最后,我们使用 imap_expunge() 函数永久删除所有标记为删除的邮件。如果成功删除邮件,将输出 "成功删除标记为删除的邮件",否则输出 "删除邮件失败"。最后,我们使用 imap_close() 函数关闭 IMAP 连接。
请注意,此函数只能在与 IMAP 服务器的连接处于打开状态时使用。