imap_get_quotaroot

(PHP 4 >= 4.3.0, PHP 5)

imap_get_quotaroot --  ユーザ単位のクォータ設定を取得する

説明

array imap_get_quotaroot ( resource imap_stream, string quota_root )

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

limit の値は、このユーザがメールボックスで使用可能な総容量を表します。 usage の値は、ユーザが現在メールボックスで使用している容量を表します。 コールが失敗した場合、およびサーバからの応答内容をパースできなかった場合には この関数は FALSE を返します。

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

imap_streamimap_open() のコールにより返される値である必要があります。このストリームは、 調べたいメールボックスを所有するユーザがオープンするべきです。 quota_root はどのメールボックスを調べるかを 指定します(例: INBOX)。

例 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_values['STORAGE'];
   echo
"STORAGE usage level は: " .  $storage['usage'];
   echo
"STORAGE limit level は: " .  $storage['limit'];

   
$message = $quota_values['MESSAGE'];
   echo
"MESSAGE usage level は: " .  $message['usage'];
   echo
"MESSAGE usage level は: " .  $message['limit'];

   
/* ...  */

}

imap_close($mbox);
?>

imap_open()imap_set_quota() および imap_get_quota() も参照ください。