PHP マニュアル: ユーザー単位のクォータ設定を取得する

説明

arrayfalse imap_get_quotaroot(IMAP\Connection $imap, string $mailbox)

ユーザー単位のクォータ設定を取得します。 limit の値は、このユーザーがメールボックスで使用可能な総容量を表します。 usage の値は、ユーザーが現在メールボックスで使用している容量を表します。

パラメータ

imap: IMAP\Connection クラスのインスタンス。
mailbox: mailbox はどのメールボックスを調べるかを指定します（例: INBOX）。

戻り値

指定したユーザーのメールボックスに関連する整数値を配列で返します。すべての値にはリソース名に基づいたキーがつけられており、 usage および limit 値を保持する配列が関連付けられています。

コールが失敗した場合、およびサーバーからの応答内容をパースできなかった場合にはこの関数は false を返します。

変更履歴

バージョン	説明
8.1.0	引数 `imap` は、IMAP\Connection クラスのインスタンスを期待するようになりました。これより前のバージョンでは、有効な `imap` リソースが期待されていました。

例

例1 imap_get_quotaroot の例

<?php
$mbox = imap_open("{imap.example.org}", "kalowsky", "password", OP_HALFOPEN)
      or die("接続できません: " . imap_last_error());

$quota = imap_get_quotaroot($mbox, "INBOX");
if (is_array($quota)) {
   $storage = $quota['STORAGE'];
   echo "STORAGE usage level is: " .  $storage['usage'];
   echo "STORAGE limit level is: " .  $storage['limit'];

   $message = $quota['MESSAGE'];
   echo "MESSAGE usage level is: " .  $message['usage'];
   echo "MESSAGE limit level is: " .  $message['limit'];

   /* ...  */

}

imap_close($mbox);
?>

注意

この関数は、現在は c-client2000 以降のライブラリを使用しているユーザーのみ利用可能です。

imap は、調べたいメールボックスを所有するユーザーがオープンしなければなりません。

参考

imap_open
imap_set_quota
imap_get_quota