PHP Conference Japan 2024

imap_fetch_overview

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

imap_fetch_overview讀取指定郵件標頭資訊的概覽

說明

imap_fetch_overview(IMAP\Connection $imap, 字串 $sequence, 整數 $flags = 0): 陣列|false

此函式會擷取給定 sequence 的郵件標頭,並返回其內容的概覽。

參數

imap

一個 IMAP\Connection 實例。

sequence

訊息序列描述。您可以使用 X,Y 語法枚舉所需的訊息,或使用 X:Y 語法擷取區間內的所有訊息。

flags

如果此參數設定為 FT_UID,則 sequence 將包含訊息索引或 UID 的序列。

返回值

返回一個物件陣列,每個物件描述一個訊息標頭。物件只會定義存在的屬性。可能的屬性如下:

  • subject - 訊息主旨
  • from - 寄件者
  • to - 收件者
  • date - 寄送時間
  • message_id - 訊息 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