IMAP, POP3 및 NNTP imap_list
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_list — 사서함 목록 읽기
설명
imap_list(IMAP\Connection $imap, string $reference, string $pattern): array|false
사서함 목록을 읽습니다.
매개변수
imap- IMAP\Connection 인스턴스입니다.
referencereference는 일반적으로 imap_open()에 설명된 대로 서버 사양이어야 합니다.경고 imap.enable_insecure_rsh가 비활성화되지 않는 한 신뢰할 수 없는 데이터를 이 매개변수에 전달하는 것은 안전하지 않습니다.
pattern- 사서함 계층에서 검색을 시작할 위치를 지정합니다.
pattern의 일부로 전달할 수 있는 두 가지 특수 문자('*' 및 '%')가 있습니다. '*'는 모든 메일함을 반환함을 의미합니다.pattern을 '*'로 전달하면 전체 사서함 계층 구조의 목록이 표시됩니다. '%'는 현재 수준만 반환한다는 의미입니다.pattern매개변수로 '%'는 최상위 메일박스만 반환합니다. UW_IMAPD의 '~/mail/%'는 ~/mail 디렉토리의 모든 편지함을 리턴하지만 해당 디렉토리의 하위 폴더에서는 아무 것도 리턴하지 않습니다.
반환 값
사서함의 이름을 포함하는 배열을 반환하거나 실패할 경우 false를 반환합니다.
변경 로그
| 버전 | 설명 |
|---|---|
| 8.1.0 | imap 매개변수는 이제 IMAP\Connection 인스턴스를 필요로 합니다. 이전에는 리소스가 필요했습니다. |
Examples
예제 #1 imap_list() 예제
<?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);
?>
기타
- imap_getmailboxes() - 사서함 목록을 읽고 각 사서함에 대한 자세한 정보를 반환합니다.
- imap_lsub() - 구독한 모든 사서함 나열