PHP Conference Japan 2024

imap_fetch_overview

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

imap_fetch_overview读取给定邮件报头信息的概述

描述

imap_fetch_overview(IMAP\Connection $imap, string $sequence, int $flags = 0): array|false

此函数获取给定sequence的邮件报头,并返回其内容的概述。

参数

imap

一个IMAP\Connection 实例。

sequence

邮件序列描述。您可以使用X,Y语法枚举所需的邮件,或者使用X:Y语法检索区间内的所有邮件。

flags

如果此参数设置为FT_UID,则sequence将包含邮件索引或UID的序列。

返回值

返回一个对象数组,每个对象描述一个邮件报头。只有在属性存在时,对象才会定义该属性。可能的属性包括:

  • subject - 邮件主题
  • from - 发送者
  • to - 收件人
  • date - 发送时间
  • message_id - Message-ID
  • references - 对此邮件 ID 的引用
  • in_reply_to - 对此邮件 ID 的回复
  • size - 大小(字节)
  • uid - 邮件在邮箱中的 UID
  • msgno - 邮件在邮箱中的序列号
  • recent - 此邮件标记为最近的邮件
  • flagged - 此邮件已标记
  • answered - 此邮件标记为已回复
  • deleted - 此邮件已标记为删除
  • seen - 此邮件标记为已读
  • draft - 此邮件标记为草稿
  • udate - 到达日期的 UNIX 时间戳
函数失败时返回false

变更日志

版本 描述
8.1.0 imap参数现在需要一个IMAP\Connection实例;以前需要一个有效的imap 资源

范例

示例 #1 imap_fetch_overview() 示例

<?php
$mbox
= imap_open("{imap.example.org:143}INBOX", "username", "password")
or die(
"无法连接: " . imap_last_error());

$MC = imap_check($mbox);

// 获取收件箱中所有邮件的概述
$result = imap_fetch_overview($mbox,"1:{$MC->Nmsgs}",0);
foreach (
$result as $overview) {
echo
"#{$overview->msgno} ({$overview->date}) - 来自: {$overview->from}
{$overview->subject}\n";
}
imap_close($mbox);
?>

参见

添加笔记

用户贡献笔记

此页面没有用户贡献的笔记。
To Top