Liefert Statusinformationen zum angegebenen Postfach

Beschreibung

imap_status(IMAP\Connection $imap, string $mailbox, int $flags): stdClass|false

Gibt Statusinformationen zum Postfach mailbox zurück.

Parameter-Liste

imap

Eine IMAP\Connection-Instanz.

mailbox

Der Name des Postfachs, siehe imap_open() für weitere Informationen.

Warnung

Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist unsicher,falls imap.enable_insecure_rsh nicht deaktiviert ist.

flags

Eine Bitmaske mit folgenden möglichen Werten:

SA_MESSAGES - setzt $status->messages auf die Anzahl der Nachrichten im Postfach
SA_RECENT - setzt $status->recent auf die Anzahl kürzlich eingetroffener Nachrichten im Postfach
SA_UNSEEN - setzt $status->unseen auf die Anzahl ungelesener (neuer) Nachrichten im Postfach
SA_UIDNEXT - setzt $status->uidnext auf die nächste diesem Postfach zugeteilte UID
SA_UIDVALIDITY - setzt $status->uidvalidity auf eine Konstante, die sich ändert, falls die UIDs im Postfach ihre Gültigkeit verloren haben könnten
SA_ALL - setzt alle Flags

Rückgabewerte

Diese Funktion gibt ein Objekt mit Statusinformationen zurück. Bei einem Fehler wird false zurückgegeben. Das Objekt hat die folgenden Eigenschaften: messages, recent, unseen, uidnext und uidvalidity.

flags wird ebenfalls gesetzt und enthält eine Bitmaske, mit der die tatsächlich zurückgegebenen Informationen mit Hilfe der oben beschriebenen Konstanten geprüft werden können.

Changelog

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

Beispiele

Beispiel #1 imap_status()-Beispiel

<?php
$mbox = imap_open("{imap.example.com}", "username", "password", OP_HALFOPEN)
      or die("Kann keine Verbindung aufbauen: " . imap_last_error());

$status = imap_status($mbox, "{imap.example.org}INBOX", SA_ALL);
if ($status) {
  echo "Nachrichten:   " . $status->messages    . "<br />\n";
  echo "Neueste:     " . $status->recent      . "<br />\n";
  echo "Ungelesen:     " . $status->unseen      . "<br />\n";
  echo "UIDnext:    " . $status->uidnext     . "<br />\n";
  echo "UIDvalidity:" . $status->uidvalidity . "<br />\n";
} else {
  echo "imap_status schlug fehl: " . imap_last_error() . "\n";
}

imap_close($mbox);
?>