PHP: imap_listscan - Manual

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

search for in the

imap_listsubscribed imap_listmailbox

Last updated: Fri, 26 Jan 2007

view this page in

# imap_listscan

(no version information, might be only in CVS)

imap_listscan -- Returns the list of mailboxes that matches the given text

## Описание

array imap_listscan ( resource imap_stream, string ref, string pattern, string content )

Returns an array containing the names of the mailboxes that have `content` in the text of the mailbox.

This function is similar to imap_listmailbox(), but it will additionally check for the presence of the string `content` inside the mailbox data.

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

`imap_stream`

  An IMAP stream returned by imap_open().

`ref`

  `ref` should normally be just the server specification as described in imap_open()

`pattern`

  Specifies where in the mailbox hierarchy to start searching.

  There are two special characters you can pass as part of the `pattern`: '*' and '%'. '*' means to return all mailboxes. If you pass `pattern` as '*', you will get a list of the entire mailbox hierarchy. '%' means to return the current level only. '%' as the `pattern` parameter will return only the top level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox in the ~/mail directory, but none in subfolders of that directory

`content`

  The searched string

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

Returns an array containing the names of the mailboxes that have `content` in the text of the mailbox.

## Смотрите также

imap_listmailbox()
imap_search()

add a note User Contributed Notes
imap_listscan
There are no user contributed notes for this page.
imap_listsubscribed imap_listmailbox

Last updated: Fri, 26 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