imap_set_quota

指定したメールボックスにクォータを設定する

説明

bool imap_set_quota(IMAP\Connection $imap, string $quota_root, int $mailbox_size)

メールボックス単位でクォータ上限(最大容量)を設定します。

パラメータ

imap

IMAP\Connection クラスのインスタンス。

quota_root

クォータを設定するメールボックス。 これは、メールボックスの IMAP 標準フォーマット 'user.name' に基づき指定する必要があります。

mailbox_size

quota_root の最大サイズ (KB 単位)。

戻り値

成功した場合に true を、失敗した場合に false を返します。

変更履歴

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

例1 imap_set_quota の例

<?php
$mbox = imap_open("{imap.example.org:143}", "mailadmin", "password");

if (!imap_set_quota($mbox, "user.kalowsky", 3000)) {
    echo "クォータの設定に失敗\n";
    return;
}

imap_close($mbox);
?>

注意

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

メール管理者のアカウントでオープンされている imap が必要です。 他のユーザーでオープンされている場合は、この関数は動作しません。

参考

  • imap_open
  • imap_get_quota