imap_list

(PHP 4, PHP 5)

imap_listRead the list of mailboxes

Описание

array imap_list ( resource $imap_stream , string $ref , string $pattern )

Read the list of mailboxes.

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

imap_stream

Поток IMAP, полученный из imap_open().

ref

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

pattern

Определяет начало поиска в иерархии почтовых ящиков.

Есть два специальных символа, которые можно использовать при передаче как часть pattern: '*' и '%'. '*' возвращает все почтовые ящики. Если вы передадите pattern как '*', то получите полный список иерархии почтовых ящиков. '%' вернет только текущий уровень. '%', переданный как параметр pattern, вернет почтовые ящики только на самом верхнем уровне; '~/mail/%' на UW_IMAPD вернет все ящики в директории ~/mail, кроме тех, которые находятся в ее поддиректориях.

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

Returns an array containing the names of the mailboxes.

Примеры

Пример #1 imap_list() example

<?php
$mbox 
imap_open("{imap.example.org}""username""password"OP_HALFOPEN)
      or die(
"can't connect: " imap_last_error());

$list imap_list($mbox"{imap.example.org}""*");
if (
is_array($list)) {
    foreach (
$list as $val) {
        echo 
imap_utf7_decode($val) . "\n";
    }
} else {
    echo 
"imap_list failed: " imap_last_error() . "\n";
}

imap_close($mbox);
?>

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

Коментарии

if there is an error imap_list returns FALSE not an empty array (as expected by docs)
2007-06-05 05:13:13
http://php5.kiev.ua/manual/ru/function.imap-list.html
imap_list returns a simple array of strings that look just like the $ref parameter one needs to specify:

<?php

  $srv 
'{imap.example.com}';

 
$conn imap_open($srv'me''mypass');

 
$boxes imap_list($conn$srv'*');

 
print_r($boxes);
 
imap_close($conn);
?>

Output:

<pre>
Array
(
    [0] => {imap.example.com}Calendar
    [1] => {imap.example.com}Contacts
    [2] => {imap.example.com}Deleted Items
    [3] => {imap.example.com}Drafts
    [4] => {imap.example.com}Journal
    [5] => {imap.example.com}Junk E-mail
    [6] => {imap.example.com}Notes
    [7] => {imap.example.com}Outbox
    [8] => {imap.example.com}RSS Feeds
    [9] => {imap.example.com}Sent Items 
    [10] => {imap.example.com}Tasks
)
</pre>

These directly fill in the $ref argument for every function that takes one.
2008-09-16 15:00:13
http://php5.kiev.ua/manual/ru/function.imap-list.html
With the values returned from the imap_list function, you can search a message in the folder, but you have to use the imap_reopen function before . Continuing the previous example (from c6h1206free at gmail dot com )

<?php
  $srv 
'{imap.example.com}';
 
$conn imap_open($srv'me''mypass');
 
$boxes imap_list($conn$srv'*');
  foreach(
$boxes as $box
  {
   
imap_reopen($srv$box);
   
var_dump(imap_search($srv"ALL"));
  }
 
imap_close($conn);
?>
2014-03-29 16:02:20
http://php5.kiev.ua/manual/ru/function.imap-list.html

    Поддержать сайт на родительском проекте КГБ