Lee los cuotas de los buzones de correo así como las estadísticas sobre cada uno de ellos

# imap_get_quota

(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)

imap_get_quota — Lee los cuotas de los buzones de correo así como las estadísticas sobre cada uno de ellos

### Descripción

function imap_get_quota(IMAP\Connection `$imap`, string `$quota_root`): array|false

Lee los cuotas de los buzones de correo así como las estadísticas sobre cada uno de ellos.

Para una versión de usuario, no administrador, de esta función, refiérase a la función imap_get_quotaroot().

### Parámetros

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

  `quota_root` debe ser de la forma : "`user.nom`", donde "nom" es el nombre del buzón de correo que se desea analizar.

### Valores devueltos

Devuelve un array que contiene los valores de cuota y actuales del buzón de correo `quota_root`. La cuota representa el tamaño máximo del buzón de correo. El valor actual es el espacio actualmente utilizado por el buzón de correo. imap_get_quota() devolverá `false` en caso de fallo.

Desde PHP 4.3, la función refleja más fielmente las funcionalidades dictadas por la » RFC2087. El array devuelto ha cambiado para soportar un número ilimitado de recursos devueltos (i.e. mensajes o subcarpetas) con cada recurso nombrado que es identificado por una clave. Cada clave contiene entonces otro array con el uso y la cuota. El ejemplo a continuación muestra cómo utilizarlo.

Por razones de compatibilidad, el método de acceso original sigue estando disponible, pero se recomienda abandonarlo.

### 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 #1 Ejemplo con imap_get_quota()

    <?php
    $mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN)
          or die("Imposible conectarse : " . imap_last_error());

    $quota_value = imap_get_quota($mbox, "user.kalowsky");
    if (is_array($quota_value)) {
        echo "Nivel de uso : " . $quota_value['usage'];
        echo "Cuota : " . $quota_value['limit'];
    }

    imap_close($mbox);
    ?>

Ejemplo #2 Ejemplo con imap_get_quota() 4.3 o superior

    <?php
    $mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN)
          or die("Imposible conectarse : " . imap_last_error());

    $quota_values = imap_get_quota($mbox, "user.kalowsky");
    if (is_array($quota_values)) {
       $storage = $quota_values['STORAGE'];
       echo "Uso actual de la capacidad de almacenamiento : " .  $storage['usage'];
       echo "Cuota actual de almacenamiento  : " .  $storage['limit'];

       $message = $quota_values['MESSAGE'];
       echo "Nivel de uso de MESSAGE  : " .  $message['usage'];
       echo "Cuota de MESSAGE : " .  $message['limit'];

       /* ...  */
    }

    imap_close($mbox);
    ?>

### Notas

imap_get_quota() funciona actualmente solo con las bibliotecas c-client2000.

El `imap` dado debe estar abierto como administrador de correo, de lo contrario esta función falla.

### Ver también

- imap_open() - Abre un flujo IMAP hacia un buzón de correo
- imap_set_quota() - Modifica el cupo de un buzón de correo
- imap_get_quotaroot() - Lee los cuotas de cada usuario

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open