PHP 8.1.0 Released!

imap_lsub

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

imap_lsubList all the subscribed mailboxes

Descrição

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

Gets an array of all the mailboxes that you have subscribed.

Parâmetros

imap

An IMAP\Connection instance.

reference

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

Aviso

Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.

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.

Valor Retornado

Returns an array of all the subscribed mailboxes, ou false em caso de falha.

Changelog

Versão Descrição
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a resource was expected.

Veja Também

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top