imap_check

PHP 4, PHP 5, PHP 7, PHP 8
imap_check - Check current mailbox
Manual
Code Examples

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

Checks information about the current mailbox.

Parameters

imap

An IMAP\Connection instance.

Return Values

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.

Changelog

Version Description
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a resource was expected.

Example of imap_check

Show all examples for imap_check

PHP Version:


Function imap_check:

IMAP, POP3 and NNTP Functions

Most used PHP functions