PHP 8.4.1 Released!

imap_headerinfo

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

imap_headerinfoLiefert Informationen über die Kopfdaten einer Nachricht

Beschreibung

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

Liest die Kopfdaten der Nachricht mit der Nummer message_num und gibt daraus gewonnene Informationen zurück.

Parameter-Liste

imap

Eine IMAP\Connection-Instanz.

message_num

Die Nummer der Nachricht

from_length

Die maximale Anzahl Zeichen für die Eigenschaft fetchfrom (muss größer oder gleich Null sein).

subject_length

Die maximale Anzahl Zeichen für die Eigenschaft fetchsubject (muss größer oder gleich Null sein).

defaulthost

Rückgabewerte

Gibt bei einem Fehler false zurück oder bei Erfolg die Informationen in einem Objekt mit folgenden Eigenschaften:

  • toaddress - der Inhalt der "To:"-Zeile (max. 1024 Zeichen)
  • to - ein Array von Objekten aus der "To:"-Zeile mit den folgenden Eigenschaften: personal, adl, mailbox und host
  • fromaddress - der Inhalt der "From:"-Zeile (max. 1024 Zeichen)
  • from - ein Array von Objekten aus der "From:"-Zeile mit den folgenden Eigenschaften: personal, adl, mailbox und host
  • ccaddress - der Inhalt der "Cc:"-Zeile (max. 1024 Zeichen)
  • cc - ein Array von Objekten aus der "Cc:"-Zeile mit den folgenden Eigenschaften: personal, adl, mailbox und host
  • bccaddress - der Inhalt der "Bcc:"-Zeile (max. 1024 Zeichen)
  • bcc - ein Array von Objekten aus der "Bcc:"-Zeile mit den folgenden Eigenschaften: personal, adl, mailbox und host
  • reply_toaddress - der Inhalt der "Reply-To:"-Zeile (max. 1024 Zeichen)
  • reply_to - ein Array von Objekten aus der "Reply-To:"-Zeile mit den folgenden Eigenschaften: personal, adl, mailbox und host
  • senderaddress - der Inhalt der "Sender:"-Zeile (max. 1024 Zeichen)
  • sender - ein Array von Objekten aus der "Sender:"-Zeile mit den folgenden Eigenschaften: personal, adl, mailbox und host
  • return_pathaddress - der Inhalt der "Return-Path:"-Zeile (max. 1024 Zeichen)
  • return_path - ein Array von Objekten aus der "Return-Path:"-Zeile mit den folgenden Eigenschaften: personal, adl, mailbox und host
  • remail -
  • date - das Sendedatum der Nachricht laut Kopfdaten
  • Date - enthält die gleichen Daten wie 'date'
  • subject - die Betreffzeile der Nachricht
  • Subject - enthält die gleichen Daten wie 'subject'
  • in_reply_to -
  • message_id -
  • newsgroups -
  • followup_to -
  • references -
  • Recent - R, wenn kürzlich eingetroffen und gelesen, N, wenn kürzlich eingetroffen und ungelesen, ' ', wenn nicht kürzlich eingetroffen.
  • Unseen - U, wenn nicht kürzlich eingetroffen UND ungelesen, ' ', wenn gelesen ODER ungelesen und kürzlich eingetroffen.
  • Flagged - F, wenn als wichtig markiert, sonst ' '
  • Answered - A, wenn beantwortet, sonst ' '
  • Deleted - D, wenn zum Löschen vorgemerkt, sonst ' '
  • Draft - X, wenn als Entwurf markiert, sonst ' '
  • Msgno - die Nummer der Nachricht
  • MailDate -
  • Size - die Größe der Nachricht in Bytes
  • udate - das Sendedatum als Unix-Timestamp
  • fetchfrom - die "From:"-Zeile limitiert auf from_length Zeichen
  • fetchsubject - die "Subject:"-Zeile, limitiert auf subject_length Zeichen

Changelog

Version Beschreibung
8.1.0 Der Parameter imap erwartet nun eine IMAP\Connection-Instanz; vorher wurde eine gültige imap-Ressource erwartet.
8.0.0 Der nicht verwendete Parameter defaulthost wurde entfernt.

Siehe auch

add a note

User Contributed Notes 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
14 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