PHP: imap_check - Manual

downloads | documentation | faq | getting help | mailing lists | reporting bugs | php.net sites | links | conferences | my php.net

search for in the

imap_clearflag_full imap_bodystruct

Last updated: Sat, 27 Jan 2007

view this page in

# imap_check

(PHP 3, PHP 4, PHP 5)

imap_check -- Check current mailbox

## Описание

object imap_check ( resource imap_stream )

Checks information about the current mailbox.

## Список параметров

`imap_stream`

  An IMAP stream returned by imap_open().

## Возвращаемые значения

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.

## Примеры

Пример 1. imap_check() example

`<?php $imap_obj = imap_check($imap_stream); var_dump($imap_obj); ?>`

Результатом выполнения данного примера будет что-то подобное:

    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
imap_check
JUNIOR TELLO
27-Jan-2006 06:43
`You can NOT prevent imap_check from flagging new/recent messages when using POP3 enabling the "/readonly" or OP_READONLY flags or options.`
erik at phpcastle dot com
13-Dec-2005 07:49
`The imap_check ($stream); function will return real-time information about the e-mail box (at least imap) during one connection :)`
28-Oct-2004 12:21
`You can prevent imap_check from flagging new/recent messages as checked by calling imap_open with the "/readonly" or OP_READONLY flags.`
rasmus at flajm dot com
18-Dec-2003 08:06
`Running this on a mailbox will mark recent/new messages as checked.`
add a note
imap_clearflag_full imap_bodystruct

Last updated: Sat, 27 Jan 2007
show source | credits | stats | sitemap | contact | advertising | mirror sites
Copyright © 2001-2007 The PHP Group
All rights reserved.
This mirror generously provided by: Yahoo! Inc.
Last updated: Sat Mar 10 09:32:46 2007 PST