PHP 8.4.2 Released!

imap_headerinfo

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

imap_headerinfoЧитает заголовок сообщения

Описание

imap_headerinfo(
    IMAP\Connection $imap,
    int $message_num,
    int $from_length = 0,
    int $subject_length = 0
): stdClass|false

Извлекает информацию о сообщении из его заголовка.

Список параметров

imap

Экземпляр класса IMAP\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
  • fetchfrom - поле from, отформатированное в соответствии с from_length
  • fetchsubject - поле subject, отформатированное в соответствии с subject_length

Список изменений

Версия Описание
8.1.0 Параметр imap теперь ожидает экземпляр класса IMAP\Connection; раньше параметр ждал ресурс (resource) imap.
8.0.0 Неиспользуемый параметр defaulthost был удалён.

Смотрите также

  • imap_fetch_overview() - Считывает обзор информации из заголовков сообщений

Добавить

Примечания пользователей 5 notes

up
24
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.
up
9
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....
up
3
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.
up
5
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
up
1
Murray
9 years ago
An email without a subject line will not generate the 'subject' property.

Before using the 'subject' property you should test for it.
if (property_exists($header, 'subject')) echo $header->subject;
To Top