imap_get_quotaroot

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

imap_get_quotarootRecupera as configurações de cota por usuário

Descrição

imap_get_quotaroot(IMAP\Connection $imap, string $mailbox): array|false

Recupera as configurações de cota por usuário. O valor limite representa a quantidade total de espaço permitida para o uso total da caixa de correio deste usuário. O valor de uso representa a capacidade total atual da caixa de correio do usuário.

Parâmetros

imap

Uma instância de IMAP\Connection.

mailbox

mailbox normalmente deve estar no formato de identificação da caixa de correio (ou seja, INBOX).

Valor Retornado

Retorna um array de valores inteiros pertencentes à caixa de correio do usuário especificado. Todos os valores contêm uma chave com base no nome do recurso e um array correspondente com os valores de uso e limite internamente.

Esta função retornará false no caso de falha de chamada, e um array de informações sobre a conexão mediante uma resposta não analisável do servidor.

Registro de Alterações

Versão Descrição
8.1.0 O parâmetro imap agora espera uma instância de IMAP\Connection; anteriormente, um resource imap válido era esperado.

Exemplos

Exemplo #1 Exemplo de imap_get_quotaroot()

<?php
$mbox
= imap_open("{imap.example.org}", "kalowsky", "password", OP_HALFOPEN)
or die(
"Não foi possível conectar: " . imap_last_error());

$quota = imap_get_quotaroot($mbox, "INBOX");
if (
is_array($quota)) {
$storage = $quota['STORAGE'];
echo
"Nível de uso de STORAGE: " . $storage['usage'];
echo
"Nível limite de STORAGE: " . $storage['limit'];

$message = $quota['MESSAGE'];
echo
"Nível de uso de MESSAGE: " . $message['usage'];
echo
"Nível limite de MESSAGE: " . $message['limit'];

/* ... */

}

imap_close($mbox);
?>

Notas

Esta função está disponível atualmente apenas para usuários da biblioteca c-client2000 ou superior.

O imap deve ser aberto como o usuário cuja caixa de correio deve ser verificada.

Veja Também

  • imap_open() - Abre um fluxo IMAP para uma caixa de correio
  • imap_set_quota() - Define uma cota para uma determinada caixa de correio
  • imap_get_quota() - Recupera as configurações de nível de cota e estatísticas de uso por caixa de correio

adicione uma nota

Notas Enviadas por Usuários (em inglês) 2 notes

up
5
thomas dot hebinck at digionline dot de
21 years ago
['STORAGE']['usage'] and ['STORAGE']['limit'] are values in KB (1024 Bytes)
up
2
uphonesimon at gmail dot com
19 years ago
just to make a note for all the people that are wondering the differences between $quota['STORAGE'] and $quot['MESSAGE']
the $quot['STORAGE'] is the size of the mailbox in KB
but $quota['MESSAGE'] is actually the number of messages stored in the mailbox and the up limit of the total messages allowed
To Top