PHP - imap_createmailbox() 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_createmailbox() function accepts a resource value representing an IMAP stream, a string value representing the url/name of the mailbox and creates a new mailbox.

Syntax

imap_createmailbox ($imap_stream, $mailbox);

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	mailbox(Mandatory) This is a string value representing the name/URL of the mailbox. It contains the server name, mailbox path.

Sr.No

Parameter & Description

imap_stream (Mandatory)

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

mailbox(Mandatory)

This is a string value representing the name/URL of the mailbox. It contains the server name, mailbox path.

Return Values

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

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_createmailbox() function −

<html>
   <body>
      <?php
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $pwd = "cohondob_123";
         $mailbox = imap_open($url, $id, $pwd);
         print("Connection established....");
         print("<br>");

         //Creating a mailbox
         $newmailbox = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.new_mail_box";
         $res = imap_createmailbox($mailbox, imap_utf7_encode($newmailbox));
		 
         if($res){
            print("Mailbox created successfully");
         } else {
            print("Error occurred");
         }		 
      ?>
   </body>
</html>

Output

The above program generates the following output −

Connection established....
Mailbox created successfully

Example

Following is another example of this function −

<html>
   <body>
      <?php
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $pwd = "cohondob_123";
         $mailbox = imap_open($url, $id, $pwd);
         print("Connection established....");
         print("<br>");

         //Creating a mailbox
         $newmailbox = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail1";
         $res = imap_createmailbox($mailbox, imap_utf7_encode($newmailbox));
		 
         //Retrieving the contents of mail boxes
         $list = imap_getmailboxes($mailbox, $url, "*");
         foreach ($list as $key => $val) {
            print_r($val->name);
            print("<br>");
         }   
      ?>
   </body>
</html>

Output

The above program generates the following output −

Connection established....
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail1

php_function_reference.htm