imap_headerinfo
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_headerinfo — メッセージヘッダを読み込む
説明
imap_headerinfo(
IMAP\Connection
int
int
int
): stdClass|false
IMAP\Connection
$imap,int
$message_num,int
$from_length = 0,int
$subject_length = 0): stdClass|false
指定したメッセージ番号についての情報を、そのヘッダを読み込んで取得します。
パラメータ
imapIMAP\Connection クラスのインスタンス。
message_num-
メッセージ番号。
from_length-
fetchfromプロパティの文字数。 ゼロ以上でなければなりません。 subject_length-
fetchsubjectプロパティの文字数。 ゼロ以上でなければなりません。 defaulthost-
戻り値
エラー時には false、成功時には
以下のプロパティをもつオブジェクトを返します。
- toaddress - 完全な to: 行。最大 1024 文字。
-
to - To: 行から、次のプロパティを含むオブジェクトの配列を返します。
personal、adl、mailboxおよびhost - fromaddress - 完全な from: 行。最大 1024 文字。
-
from - From: 行から、次のプロパティを含むオブジェクトの配列を返します。
personal、adl、mailboxおよびhost - ccaddress - 完全な cc: 行。最大 1024 文字。
-
cc - Cc: 行から、次のプロパティを含むオブジェクトの配列を返します。
personal、adl、mailboxおよびhost - bccaddress - 完全な bcc: 行。最大 1024 文字。
-
bcc - Bcc: 行から、次のプロパティを含むオブジェクトの配列を返します。
personal、adl、mailboxおよびhost - reply_toaddress - 完全な Reply-To: 行。最大 1024 文字。
-
reply_to - Reply-To: 行から、次のプロパティを含むオブジェクトの配列を返します。
personal、adl、mailboxおよびhost - senderaddress - 完全な sender: 行。最大 1024 文字。
-
sender - Sender: 行から、次のプロパティを含むオブジェクトの配列を返します。
personal、adl、mailboxおよびhost - return_pathaddress - 完全な Return-Path: 行。最大 1024 文字。
-
return_path - Return-Path: 行から、次のプロパティを含むオブジェクトの配列を返します。
personal、adl、mailboxおよびhost - remail -
- date - ヘッダにあるメッセージの日付。
- Date - date と同じ。
- subject - メッセージの件名。
- Subject - subject と同じ。
- in_reply_to -
- message_id -
- newsgroups -
- followup_to -
- references -
-
Recent - 最近の既読メッセージは
R、 最新の未読メッセージはN、 最新でないメッセージは ' '。 -
Unseen - 最新でない未読メッセージは
U、 既読、あるいは最新の未読メッセージは ' '。 -
Flagged - フラグがたっている場合は
F、 そうでない場合は ' '。 -
Answered - 返信した場合は
A、 していない場合は ' '。 -
Deleted - 削除された場合は
D、 されていない場合は ' '。 -
Draft - 草稿である場合は
X、 そうでない場合は ' '。 - Msgno - メッセージ番号。
- MailDate -
- Size - メッセージのサイズ。
- udate - メールメッセージの日付を Unix time で表したもの。
-
fetchfrom - from 行を
from_length文字に適合させたもの。 -
fetchsubject - subject 行を
subject_length文字に適合させたもの。
変更履歴
| バージョン | 説明 |
|---|---|
| 8.1.0 |
引数 imap は、IMAP\Connection
クラスのインスタンスを期待するようになりました。
これより前のバージョンでは、有効な imap リソース が期待されていました。
|
| 8.0.0 |
未使用だった defaulthost が削除されました。
|
＋add a note
User Contributed Notes 5 notes
andyltm ¶
14 years ago
When I was testing imap_headerinfo() with an e-mail that had multiple recipients (multiple e-mails in to to: and/or cc: field), I noticed that imap_headerinfo() was failing hard for me on PHP 5.2.10-2ubuntu6.4 with Suhosin-Patch 0.9.7 (cli).
Rather than providing me an array with each and every e-mail address listed in the to and/or cc fields, it was only providing me the first listed. This was disappointing.
[to] => Array
(
[0] => stdClass Object
(
[mailbox] => game
[host] => blunts.com
)
)
Luckily, there was a cool workaround to this problem:
imap_rfc822_parse_headers(imap_fetchheader( string ); which subsequentally worked like a nice little pet would:
[to] => Array
(
[0] => stdClass Object
(
[mailbox] => game
[host] => blunts.com
)
[1] => stdClass Object
(
[mailbox] => dutch
[host] => masters.com
)
)
TL;DR:
So in other words, instead of imap_headerinfo() use imap_rfc822_parse_headers(imap_fetchheader()).
Hope this helps anyone else that runs into this issue from now into the future. This post was suggested by people in #PHP on FreeNode IRC.
jahservant 13 at gmail dot com ¶
15 years ago
I'm not entirely sure why this is, but if you loop through all of the messages in a mailbox, calling imap_header() each time, you can significantly increase performance by calling imap_headers() first.
Compare this:
<?php
$imap = imap_open("{my.server.com:143}INBOX", "user", "pass");
$n_msgs = imap_num_msg($imap);
$s = microtime(true);
for ($i=0; $i<$n_msgs; $i++) {
$header = imap_header($imap, $i);
}
$e = microtime(true);
echo ($e - $s);
imap_close($imap);
?>
With this:
<?php
$imap = imap_open("{my.server.com:143}INBOX", "user", "pass");
$n_msgs = imap_num_msg($imap);
/****** adding this line: ******/
imap_headers($imap)
/***************************/
$s = microtime(true);
for ($i=0; $i<$n_msgs; $i++) {
$header = imap_header($imap, $i);
}
$e = microtime(true);
echo ($e - $s);
imap_close($imap);
?>
The performance difference, as I have tested on several boxes, connecting to several different servers, is that the second code snippet ALWAYS takes 1/2 the time, if not less.
Perhaps it is because imap_headers() retrieves all of the messages on one connection, whereas imap_header() has to make a new fetch request for each message?? I'm not sure WHY it is faster if imap_headers() is called first, but I do know that it is, so I thought I'd pass on the knowledge. If anyone knows why this is, please let me know....
php at our-software dot com ¶
7 years ago
Please Note : imap_headerinfo only returns a subset of the headers, rather than the entire thing.
Among other things, this means it only shows the first recipient from the "to" section of the email, rather than all recipients.
If you're not seeing something you expected to, you'll be better off using
$hdr_raw = imap_fetchheader($mbox, $mailid);
$hdr = imap_rfc822_parse_headers($hdr_raw);
then you'll see the full set of headers, and be able to do more with it.
scott at fuzzygroup dot com ¶
22 years ago
If you want to extract values from to, from, or other header elements, they are an object and you need to loop over them i.e.
$header = imap_header($mbox, $message_id);
$from = $header->from;
foreach ($from as $id => $object) {
$fromname = $object->personal;
$fromaddress = $object->mailbox . "@" . $object->host;
}
Would give you two variables for the friendly from and the smtp from address
Thanks to www.natrak.net for help with this