imap_getsubscribed
(PHP 4, PHP 5, PHP 7)
imap_getsubscribed — List all the subscribed mailboxes
설명
array imap_getsubscribed
( resource $imap_stream
, string $ref
, string $pattern
)
Identical to imap_getmailboxes(), except that it only
returns mailboxes that the user is subscribed to.
인수
-
imap_stream
-
imap_open()이
반환한 IMAP 스트림입니다.
-
ref
-
ref
should normally be just the server
specification as described in imap_open()
-
pattern
-
검색을 시작할 우편함 계층을
지정합니다.
pattern
부분에 사용할 수 있는
두 개의 특수 문자가 존재합니다: '*'와
'%'. '*'는 모든
우편함을 반환합니다. pattern
이
'*'라면, 전체 우편함 계층 목록을 얻습니다.
'%'은 현재 레벨을 의미합니다.
pattern
인수로 '%'을
사용하면, 최고 레벨 우편함들만 반환합니다; UW_IMAPD에
'~/mail/%'는 ~/mail
디렉토리 안에 있는 모든 우편함을 반환하지만, 서브 디렉토리 안에 있는 우편함은
반환하지 않습니다.
반환값
Returns an array of objects containing mailbox information. Each
object has the attributes name
, specifying
the full name of the mailbox; delimiter
,
which is the hierarchy delimiter for the part of the hierarchy
this mailbox is in; and
attributes
. Attributes
is a bitmask that can be tested against:
-
LATT_NOINFERIORS
- This mailbox has no
"children" (there are no mailboxes below this one).
-
LATT_NOSELECT
- This is only a container,
not a mailbox - you cannot open it.
-
LATT_MARKED
- This mailbox is marked.
Only used by UW-IMAPD.
-
LATT_UNMARKED
- This mailbox is not marked.
Only used by UW-IMAPD.