imap_fetch_overview

(PHP 4, PHP 5, PHP 7)

imap_fetch_overview — Liefert einen Auszug aus den Kopfdaten von Nachrichten

Beschreibung

imap_fetch_overview ( resource $imap_stream , string $sequence [, int $options = 0 ] ) : array

Die Funktion fragt die Kopfdaten der mit sequence() angegebenen Nachrichten ab und liefert einen Auszug daraus zurück.

Parameter-Liste

imap_stream

Eine von imap_open() zurückgegebene IMAP-Verbindung.

sequence

Beschreibung der gewünschten Nachrichten. Mehrere Nachrichten können durch Komma getrennt angegeben werden (X,Y), Nachrichtenbereiche durch einen Doppelpunkt zwischen erster und letzter Nachricht (X:Y).

options

Wenn dieser Parameter auf FT_UID gesetzt wird, werden die einzelnen Einträge der Nachrichtenliste sequence als UIDs und nicht als Nachrichtennummern interpretiert.

Rückgabewerte

Gibt ein Array von Objekten, die jeweils einen Nachrichtenkopf beschreiben, zurück. Das Objekt hat eine Eigenschaft nur dann, wenn sie auch existiert. Die möglichen Eigenschaften sind:

  • subject - die Betreffzeile der Nachricht
  • from - der Absender
  • to - der Empfänger
  • date - Sendezeitpunkt der Nachricht
  • message_id - die Message-ID der Nachricht
  • references - die Nachricht bezieht sich auf eine andere Nachricht mit dieser Message-ID
  • in_reply_to - die Nachricht ist eine Antwort auf eine andere Nachricht mit dieser Message-ID
  • size - Größe der Nachricht in Bytes
  • uid - die UID der Nachricht innerhalb des Postfachs
  • msgno - die aktuelle Nachrichtennummer innerhalb des Postfachs
  • recent - diese Nachricht ist als kürzlich eingetroffen markiert
  • flagged - diese Nachricht ist als wichtig markiert
  • answered - diese Nachricht ist als beantwortet markiert
  • deleted - diese Nachricht ist zur Löschung vorgemerkt
  • seen - diese Nachricht ist als bereits gelesen markiert
  • draft - diese Nachricht ist als Entwurf markiert
  • udate - der UNIX-Zeitstempel des Ankunftsdatums

Changelog

Version Beschreibung
5.3.3 Die udate Eigenschaft wurde hinzugefügt.

Beispiele

Beispiel #1 imap_fetch_overview()-Beispiel

<?php
$mbox = imap_open("{imap.example.org:143}INBOX", "username", "password")
     or die("kann nicht verbinden: " . imap_last_error());

$MC = imap_check($mbox);

// Hole eine Übersicht aller Nachrichten in der INBOX
$result = imap_fetch_overview($mbox,"1:{$MC->Nmsgs}",0);
foreach ($result as $overview) {
    echo "#{$overview->msgno} ({$overview->date}) - From: {$overview->from}
    {$overview->subject}\n";
}
imap_close($mbox);
?>

Siehe auch