imap_check
(PHP 4, PHP 5)
imap_check — Check current mailbox
Description
object imap_check
( resource
$imap_stream
)Checks information about the current mailbox.
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.
Examples
Example #1 imap_check() example
<?php
$imap_obj = imap_check($imap_stream);
var_dump($imap_obj);
?>
The above example will output something similar to:
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) }
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения для работы с почтой
- IMAP, POP3 и NNTP
- imap_8bit
- imap_alerts
- imap_append
- imap_base64
- imap_binary
- imap_body
- imap_bodystruct
- imap_check
- imap_clearflag_full
- imap_close
- imap_create
- imap_createmailbox
- imap_delete
- imap_deletemailbox
- imap_errors
- imap_expunge
- imap_fetch_overview
- imap_fetchbody
- imap_fetchheader
- imap_fetchmime
- imap_fetchstructure
- imap_fetchtext
- imap_gc
- imap_get_quota
- imap_get_quotaroot
- imap_getacl
- imap_getmailboxes
- imap_getsubscribed
- imap_header
- imap_headerinfo
- imap_headers
- imap_last_error
- imap_list
- imap_listmailbox
- imap_listscan
- imap_listsubscribed
- imap_lsub
- imap_mail_compose
- imap_mail_copy
- imap_mail_move
- imap_mail
- imap_mailboxmsginfo
- imap_mime_header_decode
- imap_msgno
- imap_num_msg
- imap_num_recent
- imap_open
- imap_ping
- imap_qprint
- imap_rename
- imap_renamemailbox
- imap_reopen
- imap_rfc822_parse_adrlist
- imap_rfc822_parse_headers
- imap_rfc822_write_address
- imap_savebody
- imap_scan
- imap_scanmailbox
- imap_search
- imap_set_quota
- imap_setacl
- imap_setflag_full
- imap_sort
- imap_status
- imap_subscribe
- imap_thread
- imap_timeout
- imap_uid
- imap_undelete
- imap_unsubscribe
- imap_utf7_decode
- imap_utf7_encode
- imap_utf8
Коментарии
Running this on a mailbox will mark recent/new messages as checked.
You can prevent imap_check from flagging new/recent messages as checked by calling imap_open with the "/readonly" or OP_READONLY flags.
The imap_check ($stream); function will return real-time information about the e-mail box (at least imap) during one connection :)
You can NOT prevent imap_check from flagging new/recent messages when using POP3 enabling the "/readonly" or OP_READONLY flags or options.