imap_list

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_listRead the list of mailboxes

Опис

imap_list(IMAP\Connection $imap, string $reference, string $pattern): array|false

Read the list of mailboxes.

Параметри

imap

Примірник IMAP\Connection.

reference

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

Увага

Передавати у цей параметр неперевірені дані небезпечно, якщо увімкнено imap.enable_insecure_rsh.

pattern

Визначає, де в ієрархії поштових скриньок почати пошук.

У значенні параметру pattern можна використовувати два спеціальні символи: "*" і "%". "*" — повернути всі поштові скриньки. Якщо значення pattern дорівнюватиме "*", то повернеться список усієї ієрархії поштових скриньок. "%" — повернути тільки поточний рівень. Якщо значення pattern дорівнюватиме "%", то повернеться тільки верхній рівень поштових скриньок; "~/mail/%" на UW_IMAPD поверне усі поштові скриньки в теці ~/mail, крім тих, що в її підтеках.

Значення, що повертаються

Returns an array containing the names of the mailboxes or false in case of failure.

Журнал змін

Версія Опис
8.1.0 Тепер параметр imap має бути примірником IMAP\Connection; раніше очікувався дійсний resource imap.

Приклади

Приклад #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);
?>

Прогляньте також

add a note

User Contributed Notes 2 notes

up
5
Anonymous
6 years ago
use echo mb_convert_encoding($val, "utf-8", "UTF7-IMAP");for cyrrilic folder names
up
2
c6h1206free at gmail dot com
16 years ago
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.
To Top