PHP - imap_get_quotaroot() 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_get_quotaroot() function accepts a resource value representing an IMAP stream, a string value representing a quota_root as parameters and retrieves the quota level settings per user.

Syntax

imap_get_quotaroot($imap_stream, $quota_root);

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.

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.

Return Values

This function returns an array value containing the information.

PHP Version

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

Example

Following example demonstrates the usage of the imap_get_quotaroot() 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>");

         $quota = imap_get_quotaroot($imap, "INBOX");
         print_r($quota);
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Array ( 
   [usage] => 349 [limit] => 15728640 [STORAGE] => 
   Array ( [usage] => 349 [limit] => 15728640 ) 
)

Example

Following is another example of the above 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>");

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

Output

This will generate the following output −

Connection established....
Usage: 349
Limit: 15728640

php_function_reference.htm

Kickstart Your Career

Get certified by completing the course

Get Started