PHP 8.1.0 Released!

imap_check

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

imap_checkVérifie la boîte aux lettres courante

Description

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

Vérifie les informations de la boîte aux lettres courante.

Liste de paramètres

imap

Une instance de IMAP\Connection.

Valeurs de retour

Retourne les informations dans un objet contenant les propriétés suivantes :

  • Date - Date de dernière modification du contenu de la boîte aux lettres en accord avec la » RFC2822
  • Driver - protocole utilisé pour accéder à la boîte aux lettres: POP3, IMAP, NNTP.
  • Mailbox - nom de la boîte aux lettres
  • Nmsgs - nombre de messages de la boîte aux lettres
  • Recent - nombre de messages récents de la boîte aux lettres

Retourne false si une erreur survient.

Historique

Version Description
8.1.0 La paramètre imap attend désormais une instance de IMAP\Connection ; auparavant, une ressource était attendu.

Exemples

Exemple #1 Exemple avec imap_check()

<?php

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

?>

Résultat de l'exemple ci-dessus est similaire à :

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
15 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
17 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
15 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
17 years ago
Running this on a mailbox will mark recent/new messages as checked.
To Top