imap_check

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

imap_checkPrüft das aktuelle Postfach

Beschreibung

imap_check(IMAP\Connection $imap): stdClass|false

Prüft Informationen zum aktuellen Postfach.

Parameter-Liste

imap

Eine IMAP\Connection-Instanz.

Rückgabewerte

Die Informationen werden als Objekt mit folgenden Eigenschaften zurückgegeben:

  • Date - Die aktuelle Serverzeit, formatiert gemäß » RFC2822
  • Driver - Das Protokoll des Postfachs: POP3, IMAP oder NNTP
  • Mailbox - Der Name des Postfachs
  • Nmsgs - Die Anzahl der Nachrichten im Postfach
  • Recent - Die Anzahl kürzlich eingetroffener Nachrichten im Postfach

Gibt bei einem Fehler false zurück.

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_check()-Beispiel

<?php

$imap
= imap_check($imap_stream);
var_dump($imap);

?>

Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:

object(stdClass)(5) {
  ["Date"]=>
  string(37) "Wed, 10 Dec 2003 17:56:54 +0100 (CET)"
  ["Driver"]=>
  string(4) "imap"
  ["Mailbox"]=>
  string(54)
  "{www.example.com:143/imap/user="foo@example.com"}INBOX"
  ["Nmsgs"]=>
  int(1)
  ["Recent"]=>
  int(0)
}

add a note add a note

User Contributed Notes 4 notes

up
3
erik at phpcastle dot com
18 years ago
The imap_check ($stream); function will return real-time information about the e-mail box (at least imap) during one connection :)
up
3
Anonymous
19 years ago
You can prevent imap_check from flagging new/recent messages as checked by calling imap_open with the "/readonly" or OP_READONLY flags.
up
0
JUNIOR TELLO
18 years ago
You can NOT prevent imap_check from flagging new/recent messages when using POP3 enabling the "/readonly" or OP_READONLY flags or options.
up
0
rasmus at flajm dot com
20 years ago
Running this on a mailbox will mark recent/new messages as checked.
To Top