(PHP 4, PHP 5)
imap_getsubscribed — List all the subscribed mailboxes
$imap_stream
, string $ref
, string $pattern
)Gets information about the subscribed mailboxes.
Identical to imap_getmailboxes(), except that it only returns mailboxes that the user is subscribed to.
imap_streamUm stream IMAP retornado por imap_open().
ref
ref should normally be just the server
specification as described in imap_open()
pattern
Especifica aonde na hierarquia da caixa de mensagens deve começar a procura.
Existem dois caracteres especiais que você
pode passar como parte para o pattern:
'*' e '%'.
'*' significa retornar todas as caixas de mensagens. Se você passar
pattern como '*', você terá
uma lista de toda a hierarquia da caixa de mensagens.
'%'
significa retornar o nível atual apenas.
'%' como o parâmetro pattern
ira retornar apenas as caixar de mensagem do nível superior;
'~/mail/%' em UW_IMAPD irá retornar cada caixa de mensagem no diretório ~/mail, mais nenhuma em subpastas deste diretório.
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.