array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'de', ), 'this' => array ( 0 => 'function.imap-fetchstructure.php', 1 => 'imap_fetchstructure', 2 => 'Liefert die Struktur einer Nachricht', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'IMAP Funktionen', ), 'prev' => array ( 0 => 'function.imap-fetchmime.php', 1 => 'imap_fetchmime', ), 'next' => array ( 0 => 'function.imap-fetchtext.php', 1 => 'imap_fetchtext', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'de', 'path' => 'reference/imap/functions/imap-fetchstructure.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

imap_fetchstructure

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

imap_fetchstructure — Liefert die Struktur einer Nachricht

Beschreibung

imap_fetchstructure(IMAP\Connection $imap, int $message_num, int $flags = 0): stdClass|false

Gibt alle Strukturinformationen für die angegebene Nachricht zurück.

Parameter-Liste

imap

Eine IMAP\Connection-Instanz.

message_num

Die Nummer der Nachricht

flags

Dieser optionale Parameter hat nur eine einzige Option, FT_UID, die angibt, dass message_num als UID behandelt werden soll.

Rückgabewerte

Gibt ein Objekt mit Eigenschaften zurück, die in der Tabelle weiter unten aufgelistet werden. Bei einem Fehler wird false zurückgegeben.

Zurückgegebenes Objekt für imap_fetchstructure()
type Primärer Typ des Textkörpers
encoding Übertragungskodierung des Textkörpers
ifsubtype true, falls ein Untertyp-Eintrag existiert
subtype MIME-Untertyp
ifdescription true, falls ein Beschreibungstext existiert
description Beschreibungstext
ifid true, falls ein Identifikationstext existiert
id Identifikationstext
lines Anzahl der Zeilen
bytes Größe in Bytes
ifdisposition true, falls ein Eintrag zur Verwendungsart (disposition) existiert
disposition Verwendungsart
ifdparameters true, falls ein dparameters-Array existiert
dparameters Ein Array von Objekten, wobei jedes Objekt eine "attribute"- und eine "value"-Eigenschaft hat, die den Parametern der MIME-Kopfzeile Content-disposition entsprechen.
ifparameters true, falls ein "parameters"-Array existiert
parameters Ein Array von Objekten mit je einer "attribute"- und einer "value"-Eigenschaft.
parts Wenn der Nachrichtenteil selbst weitere untergeordnete MIME-Nachrichtenteile enthält, wird hier ein Array mit Objekten für diese Teile angelegt. Die Elemente dieses Arrays sind selbst jeweils wieder Objekte mit der hier beschriebenen Struktur.

Gängige primäre Nachrichtentypen (der Wert kann sich je nach Bibliothek ändern; die Verwendung der Konstanten wird empfohlen)
WertTypKonstante
0textTYPETEXT
1multipartTYPEMULTIPART
2messageTYPEMESSAGE
3applicationTYPEAPPLICATION
4audioTYPEAUDIO
5imageTYPEIMAGE
6videoTYPEVIDEO
7modelTYPEMODEL
8otherTYPEOTHER

Gängige Übertragungskodierungen (der Wert kann sich je nach Bibliothek ändern; die Verwendung der Konstanten wird empfohlen)
WertTypKonstante
07bitENC7BIT
18bitENC8BIT
2BinaryENCBINARY
3Base64ENCBASE64
4Quoted-PrintableENCQUOTEDPRINTABLE
5otherENCOTHER

Changelog

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

Siehe auch