imap_get_quota
(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)
imap_get_quota — Obtener la cuota de ajustes por usuario, y las estadísticas de uso por buzón
Descripción
imap_get_quota(resource $imap_stream
, string $quota_root
): array
Para una versión de usuario no administrador de esta función,
por favor véase la función imap_get_quotaroot() de PHP.
Parámetros
-
imap_stream
-
IMAP stream devuelto por
imap_open().
-
quota_root
-
quota_root
normalmente debería estar en la forma
ususario.nombre
donde nombre es el buzón del que se
quiere obtener información.
Valores devueltos
Devuelve un array con valores integer de límite y uso par el buzón
dado. El valor del límite representa la cantidad total de espacio
permitido a este buzón. El valor de uso representa el nivle de capacidad
actual de los buzones. Devolverá false
en caso de error.
Desde PHP 4.3, la función refleja de manera más apropiada la
funcionalidad como está dictada en » RFC2087.
El array de valores devuelto ha cambiado para soportar un número ilimitado de recursos
devueltos (es decir, mensajes, o subcarpetas) con cada recurso nombrado recibiendo
una clave de array individual. Cada valor de la clave contiene otro array con
los valores uso y límite dentro de él.
Por razones de retrocompatibilidad, los métodos de acceso originales aún
están disponibles, aunque se sugiere actualizar.
Ejemplos
Ejemplo #1 Ejemplo de imap_get_quota()
<?php
$mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN)
or die("no se puede conectar: " . imap_last_error());
$quota_value = imap_get_quota($mbox, "user.kalowsky");
if (is_array($quota_value)) {
echo "Usage level is: " . $quota_value['usage'];
echo "Limit level is: " . $quota_value['limit'];
}
imap_close($mbox);
?>
Ejemplo #2 Ejemplo de imap_get_quota() 4.3 o superiro
<?php
$mbox = imap_open("{imap.example.org}", "mailadmin", "password", OP_HALFOPEN)
or die("no se puede conectar: " . imap_last_error());
$quota_values = imap_get_quota($mbox, "user.kalowsky");
if (is_array($quota_values)) {
$storage = $quota_values['STORAGE'];
echo "STORAGE usage level is: " . $storage['usage'];
echo "STORAGE limit level is: " . $storage['limit'];
$message = $quota_values['MESSAGE'];
echo "MESSAGE usage level is: " . $message['usage'];
echo "MESSAGE limit is: " . $message['limit'];
/* ... */
}
imap_close($mbox);
?>
Notas
Esta función está actualmente disponible para usuarios de la biblioteca
c-client2000 o superior.
El imap_stream
dado debe ser abierto como el administrador
de correo, si no la función fallará.