imap_status

imap_status(IMAP\Connection $imap, string $mailbox, int $flags): stdClass
```php

Devuelve la información de estado sobre el buzón de correo `mailbox`.

## Parámetros

`imap`  
Una instancia de `IMAP\Connection`.

`mailbox`  
El nombre del buzón de correo, ver la documentación de la función `imap_open` para más detalles

> [!WARNING]
> Pasar datos no confiables a este parámetro es *inseguro*, a menos que [imap.enable_insecure_rsh](#ini.imap.enable-insecure-rsh) esté desactivado.

`flags`  
Los flags válidos son:

- `SA_MESSAGES` - establece el valor de `$status->messages` al número de mensajes en el buzón de correo.

- `SA_RECENT` - establece el valor de `$status->recent` al número de mensajes recientes en el buzón de correo.

- `SA_UNSEEN` - establece el valor de `$status->unseen` al número de mensajes no leídos en el buzón de correo.

- `SA_UIDNEXT` - establece el valor de `$status->uidnext` al siguiente valor de uid que será utilizado.

- `SA_UIDVALIDITY` - establece el valor de `$status->uidvalidity` a una constante, que cambia cuando el uid del buzón de correo ya no es válido.

- `SA_ALL` - establece todos los valores anteriores.

## Valores devueltos

Esta función devuelve un objeto que contiene la información de estado, o `false` si ocurre un error. El objeto tiene las siguientes propiedades: `messages`, `recent`, `unseen`, `uidnext`, y `uidvalidity`.

`flags` también está definido, que contiene una máscara con una de las constantes anteriores.

## Historial de cambios

| Versión | Descripción |
|----|----|
| 8.1.0 | El parámetro `imap` ahora espera una instancia de `IMAP\Connection` ; anteriormente, se esperaba un `resource` `imap` válido. |

## Ejemplos

Ejemplo con `imap_status`