PHP 8.3.4 Released!

imap_check

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

imap_checkCheck current mailbox

Descripción

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

Checks information about the current mailbox.

Parámetros

imap

An IMAP\Connection instance.

Valores devueltos

Returns the information in an object with following properties:

  • Date - current system time formatted according to » RFC2822
  • Driver - protocol used to access this mailbox: POP3, IMAP, NNTP
  • Mailbox - the mailbox name
  • Nmsgs - number of messages in the mailbox
  • Recent - number of recent messages in the mailbox

Returns false on failure.

Historial de cambios

Versión Descripción
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap recurso was expected.

Ejemplos

Ejemplo #1 imap_check() example

<?php

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

?>

El resultado del ejemplo sería algo similar a:

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

User Contributed Notes 4 notes

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
1
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
1
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
1
rasmus at flajm dot com
20 years ago
Running this on a mailbox will mark recent/new messages as checked.
To Top