<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.imap.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.imap-set-quota.php',
    1 => 'imap_set_quota',
    2 => '指定したメールボックスにクォータを設定する',
  ),
  'up' => 
  array (
    0 => 'ref.imap.php',
    1 => 'IMAP 関数',
  ),
  'prev' => 
  array (
    0 => 'function.imap-search.php',
    1 => 'imap_search',
  ),
  'next' => 
  array (
    0 => 'function.imap-setacl.php',
    1 => 'imap_setacl',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/imap/functions/imap-set-quota.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.imap-set-quota" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">imap_set_quota</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.5, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">imap_set_quota</span> &mdash; <span class="dc-title">指定したメールボックスにクォータを設定する</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.imap-set-quota-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>imap_set_quota</strong></span>(<span class="methodparam"><span class="type"><a href="class.imap-connection.php" class="type IMAP\Connection">IMAP\Connection</a></span> <code class="parameter">$imap</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$quota_root</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$mailbox_size</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   メールボックス単位でクォータ上限(最大容量)を設定します。
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.imap-set-quota-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    <dt><code class="parameter">imap</code></dt><dd><p class="para"><span class="classname"><a href="class.imap-connection.php" class="classname">IMAP\Connection</a></span> クラスのインスタンス。</p></dd>
    
     <dt><code class="parameter">quota_root</code></dt>
     <dd>
      <p class="para">
       クォータを設定するメールボックス。
       これは、メールボックスの IMAP 標準フォーマット
       &#039;user.name&#039; に基づき指定する必要があります。
      </p>
     </dd>
    
    
     <dt><code class="parameter">mailbox_size</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">quota_root</code> の最大サイズ (KB 単位)。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.imap-set-quota-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   成功した場合に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を、失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.imap-set-quota-changelog">
  <h3 class="title">変更履歴</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>バージョン</th>
      <th>説明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  引数 <code class="parameter">imap</code> は、<span class="classname"><a href="class.imap-connection.php" class="classname">IMAP\Connection</a></span>
  クラスのインスタンスを期待するようになりました。
  これより前のバージョンでは、有効な <code class="literal">imap</code> <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> が期待されていました。
 </td>
</tr>

    </tbody>
   
  </table>

 </div>

 
 <div class="refsect1 examples" id="refsect1-function.imap-set-quota-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>imap_set_quota()</strong></span> の例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$mbox </span><span style="color: #007700">= </span><span style="color: #0000BB">imap_open</span><span style="color: #007700">(</span><span style="color: #DD0000">"{imap.example.org:143}"</span><span style="color: #007700">, </span><span style="color: #DD0000">"mailadmin"</span><span style="color: #007700">, </span><span style="color: #DD0000">"password"</span><span style="color: #007700">);<br /><br />if (!</span><span style="color: #0000BB">imap_set_quota</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">, </span><span style="color: #DD0000">"user.kalowsky"</span><span style="color: #007700">, </span><span style="color: #0000BB">3000</span><span style="color: #007700">)) {<br />    echo </span><span style="color: #DD0000">"クォータの設定に失敗\n"</span><span style="color: #007700">;<br />    return;<br />}<br /><br /></span><span style="color: #0000BB">imap_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$mbox</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>

 <div class="refsect1 notes" id="refsect1-function.imap-set-quota-notes">
  <h3 class="title">注意</h3>
  <p class="para">
   この関数は、現在は c-client2000 以降のライブラリのユーザーのみ使用可能です。
  </p>
  <p class="para">
   メール管理者のアカウントでオープンされている
   <code class="parameter">imap</code> が必要です。
   他のユーザーでオープンされている場合は、この関数は動作しません。
  </p>
 </div>

 <div class="refsect1 seealso" id="refsect1-function.imap-set-quota-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.imap-open.php" class="function" rel="rdfs-seeAlso">imap_open()</a> - メールボックスへの IMAP ストリームをオープンする</span></li>
    <li><span class="function"><a href="function.imap-get-quota.php" class="function" rel="rdfs-seeAlso">imap_get_quota()</a> - クオータレベルの設定、メールボックス毎の使用状況を取得する</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>