Sophie: php-manual-en-4.3.0-2mdk noarch

php-manual-en-4.3.0-2mdk.noarch.rpm

<HTML
><HEAD
><TITLE
>imap_set_quota</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="IMAP, POP3 and NNTP functions"
HREF="ref.imap.html"><LINK
REL="PREVIOUS"
TITLE="imap_search"
HREF="function.imap-search.html"><LINK
REL="NEXT"
TITLE="imap_setacl"
HREF="function.imap-setacl.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.imap-search.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.imap-setacl.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.imap-set-quota"
></A
>imap_set_quota</H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN38993"
></A
><P
>    (PHP 4 &#62;= 4.0.5)</P
>imap_set_quota&nbsp;--&nbsp;Sets a quota for a given mailbox</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN38996"
></A
><H2
>Description</H2
>bool <B
CLASS="methodname"
>imap_set_quota</B
> ( resource imap_stream, string quota_root, int quota_limit)<BR
></BR
><P
>  
     Sets an upper limit quota on a per mailbox basis.  This function
     requires the <TT
CLASS="parameter"
><I
>imap_stream</I
></TT
> to have been opened
     as the mail administrator account.  It will not work if opened as
     any other user. 
    </P
><P
>&#13;     This function is currently only available to users of the c-client2000
     or greater library.
    </P
><P
>&#13;    <TT
CLASS="parameter"
><I
>imap_stream</I
></TT
> is the stream pointer returned from
    a <A
HREF="function.imap-open.html"
><B
CLASS="function"
>imap_open()</B
></A
> call.  This stream must be opened as
    the mail administrator, other wise this function will fail.
    <TT
CLASS="parameter"
><I
>quota_root</I
></TT
> is the mailbox to have a quota set.  This 
    should follow the IMAP standard format for a mailbox, 'user.name'.
    <TT
CLASS="parameter"
><I
>quota_limit</I
></TT
> is the maximum size (in KB) for 
    the <TT
CLASS="parameter"
><I
>quota_root</I
></TT
>. 
    </P
><P
>&#13;     Returns <TT
CLASS="constant"
><B
>TRUE</B
></TT
> on success and <TT
CLASS="constant"
><B
>FALSE</B
></TT
> on error.
    </P
><P
>&#13;     <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN39023"
></A
><P
><B
>Example 1. <B
CLASS="function"
>imap_set_quota()</B
> example</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="php"
>$mbox = imap_open ("{your.imap.host:143}", "mailadmin", "password");

if(!imap_set_quota($mbox, "user.kalowsky", 3000)) {
    print "Error in setting quota\n";
    return;
}

imap_close($mbox);</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
    </P
><P
>&#13;     See also <A
HREF="function.imap-open.html"
><B
CLASS="function"
>imap_open()</B
></A
>, <B
CLASS="function"
>imap_set_quota()</B
>.
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.imap-search.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.imap-setacl.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>imap_search</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.imap.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>imap_setacl</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>