PHP - imap_set_quota() Function

PHP−IMAP functions helps you to access email accounts, IMAP stands for Internet Mail Access Protocol using these functions you can also work with NNTP, POP3 protocols and local mailbox access methods.

The imap_set_quota() function accepts a resource value representing an IMAP stream, a string value representing a quota_root and, integer value representing maximum quota limit as parameters and sets the specified quota for the given mailbox.

Syntax

imap_set_quota($imap_stream, $quota_root, $quota_limit);

Parameters

Sr.No	Parameter & Description
1	imap_stream (Mandatory) This is a string value representing an IMAP stream, return value of the imap_open() function.
2	quota_root (Mandatory) This is a string value representing the quota_root which will be in the user.name form where name is the name of the mailbox.
3	quota_limit (Mandatory) This is an integer value representing the maximum size.

Sr.No

Parameter & Description

imap_stream (Mandatory)

This is a string value representing an IMAP stream, return value of the imap_open() function.

quota_root (Mandatory)

This is a string value representing the quota_root which will be in the user.name form where name is the name of the mailbox.

quota_limit (Mandatory)

This is an integer value representing the maximum size.

Return Values

This function returns a Boolean value which is TRUE in case of success and FALSE in case of failure.

PHP Version

This function was first introduced in PHP Version 4 and works in all the later versions.

Example

This example demonstrates the usage of the imap_set_quota() function −

<html>
   <body>
      <?php
         //Establishing connection
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $pwd = "cohondob_123";
         $imap = imap_open($url, $id, $pwd);
         print("Connection established...."."<br>");
		 
         //Setting the quota root
         $res = imap_set_quota($imap, "user.sample", 3000);
         if($res){
            print("Quota value was set");
         }else{
            print("Error Occurred");
         }
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Quota value was set

Example

Following is another example of this function −

<html>
   <body>
      <?php
         //Establishing connection
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $pwd = "cohondob_123";
         $imap = imap_open($url, $id, $pwd);
         print("Connection established...."."<br>");
		 
         //Setting the quota root
         imap_set_quota($imap, "user.sample", 3000);

         $quota_value = imap_get_quota($imap, "user.sample");
         if (is_array($quota_value)) {
            $storage = $quota_values['STORAGE'];
            print("Usage: " . $storage['usage']);
            print("<br>");
            print("Limit: " . $storage['limit']);
         }
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Usage: 1000
Limit: 3000

php_function_reference.htm

Kickstart Your Career

Get certified by completing the course

Get Started