# imap_getsubscribed

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

imap_getsubscribed — List all the subscribed mailboxes

### Descripción

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

Gets information about the subscribed mailboxes.

Identical to imap_getmailboxes(), except that it only returns mailboxes that the user is subscribed to.

### Parámetros

`imap`

  An IMAP\Connection instance.

`reference`

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

  Advertencia

  El paso de datos no confiables a este parámetro es inseguro, a menos que imap.enable_insecure_rsh esté inhabilitado.

`pattern`

  Especifica donde en la jerarquía del buzón para empezar a buscar.

  Hay dos caracteres especiales que se pueden pasar como parte del `pattern`: '`*`' y '`%`'. '`*`' significa devolver todos los buzones. Si se pasa el `pattern` como '`*`', se obtendrá una lista de toda la jerarquía del buzón. '`%`' significa devolver sólo el nivel actual. '`%`' como el parámetro `pattern` devolverá solamente el nivel superior de los buzones; '`~/mail/%`' en `UW_IMAPD` devolverá cada buzón en el directorio ~/mail, pero no en los subdirectorios de ese directorio.

### Valores devueltos

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.
- `LATT_REFERRAL` - This container has a referral to a remote mailbox.
- `LATT_HASCHILDREN` - This mailbox has selectable inferiors.
- `LATT_HASNOCHILDREN` - This mailbox has no selectable inferiors.

The function returns `false` on failure.

### Historial de cambios

Versión | Descripción
--- | ---
8.1.0 | The `imap` parameter expects an IMAP\Connection instance now; previously, a valid `imap` recurso was expected.