imap_fetchstructure

(PHP 4, PHP 5, PHP 7)

imap_fetchstructureErmittelt die Struktur einer Nachricht

Beschreibung

imap_fetchstructure ( resource $imap_stream , int $msg_number [, int $options = 0 ] ) : object

Liefert alle Strukturinformationen für die gegebene Nachricht.

Parameter-Liste

imap_stream

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

msg_number

Die gewünschte Nachrichtennummer

options

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

Rückgabewerte

Gibt ein Objekt mit dem Envelope, dem internen Datum, der Größe, den Flags und der Body-Struktur zusammen mit ähnlichen Objekten für jeden Mime-Anhang zurück. Die Struktur der zurückgegebenen Objekte ist wie folgt:

Zurückgegebene Objekte für imap_fetchstructure()
type Primärer Typ des Nachrichtenteils
encoding Das Transfer-Encoding des Nachrichtenteils
ifsubtype TRUE, wenn ein Untertyp-Eintrag existiert
subtype MIME Untertyp
ifdescription TRUE, wenn ein Beschreibungstext existiert
description Beschreibungstext
ifid TRUE, wenn ein Identifikationstext existiert
id Identifikationstext
lines Anzahl der Zeilen
bytes Größe in Bytes
ifdisposition TRUE, wenn ein "disposition" Eintrag (Verwendungsart) existiert
disposition Verwendungsart
ifdparameters TRUE, wenn ein dparameters Array existiert
dparameters Ein Array von Objekten mit je einer "attribute"- und einer "value"-Eigenschaft. Jedes dieser Objekte enthält je einen Eintrag aus der Content-disposition MIME Kopfzeile.
ifparameters TRUE, wenn ein "parameters"-Array existiert
parameters Ein Array von Objekten mit je einer "attribute"- und einer "value"-Eigenschaft.
parts Wenn der Nachrichtenteil selbst weitere untergeorgnete MIME Nachrichtenteile enthält, so 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

Siehe auch