函数名称:imap_mail_copy() 适用版本:PHP 4, PHP 5, PHP 7
函数描述: imap_mail_copy() 函数用于将指定的邮件从一个邮箱复制到另一个邮箱。该函数使用 IMAP 扩展库来实现。
语法: bool imap_mail_copy ( resource $imap_stream , string $msglist , string $mailbox [, int $options = 0 ] )
参数:
- $imap_stream:IMAP 邮箱连接资源,通过 imap_open() 函数获得。
- $msglist:要复制的邮件的消息号。可以是单个消息号(例如"1")或一系列消息号(例如"2:4,6")。
- $mailbox:目标邮箱的名称,可以是相对路径(相对于邮箱的当前位置)或绝对路径。
- $options(可选):可选的参数,用于指定复制操作的选项,例如 CP_UID(使用 UID 而不是消息号)和 CP_MOVE(将邮件从原始邮箱中移动到目标邮箱)。
返回值: 如果复制成功,则返回 true。如果复制失败,则返回 false。
示例:
// 连接到 IMAP 邮箱
$imap_stream = imap_open("{imap.example.com:993/imap/ssl}INBOX", "username", "password");
// 将邮件 1 复制到目标邮箱 "Archive"
if (imap_mail_copy($imap_stream, "1", "Archive")) {
echo "邮件复制成功!";
} else {
echo "邮件复制失败。";
}
// 关闭 IMAP 邮箱连接
imap_close($imap_stream);
注意事项:
- 在使用该函数之前,必须通过 imap_open() 函数连接到 IMAP 邮箱。
- 邮件的消息号可以通过 imap_search() 函数或其他方式获得。
- 目标邮箱的名称可以是相对路径(例如 "INBOX.Archive")或绝对路径(例如 "{imap.example.com:993/imap/ssl}INBOX.Archive")。
- 可以使用 $options 参数来指定复制操作的选项,例如使用 UID 而不是消息号,或将邮件从原始邮箱中移动到目标邮箱。