• PHP Video Tutorials

PHP - imap_reopen() Function

PHP−IMAP functions helps you to access an 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_reopen() function accepts a resource value representing an IMAP stream, a string value representing the url/name of the mailbox as parameters and reopens the given stream to a new mailbox.

Syntax

imap_reopen($mailbox, $mailbox [$options, $n_retries);

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.
3

options (Optional)

This is an integer value representing the optional parameter which can be one or more of the following −

  • OP_READONLY

  • OP_ANONYMOUS

  • OP_HALFOPEN

  • CL_EXPUNGE

  • OP_DEBUG
4

retries (Optional)

This is an integer value representing the maximum number of attempts.

Return Values

This function returns s 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

Following example demonstrates the usage of the imap_reopen() function.

<html>
   <body>
      <?php
	      //Establishing connection
         $mailbox = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $pwd = "cohondob_123";
         $stream = imap_open($mailbox, $id, $pwd);
         //Reopening a mailbox
         $res = imap_reopen($stream, $mailbox);
         
         if($res){
            print("Connection established....");
         }else{
            print("Connection failed");
         }
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....

Example

Following is an example of the above function with optional parameters.

<html>
   <body>
      <?php
         //Establishing the connection
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $pwd = "cohondob_123";
         $stream = imap_open($url, $id, $pwd);		 

         //Optional parameters
         $options = OP_READONLY;
         $retries = 10;		 
         $res = imap_reopen($stream, $url, $options, $retries);
       
         if($res){
            print("Connection established....");
         } else {
            print("Connection failed");
         }
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....

Example

<html>
   <body>
      <?php
         //Establishing the connection
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "tutorialspoint.test@gmail.com";
         $pwd = "cohondob_123";
         $stream = imap_open($url, $id, $pwd);		 
		 		 
         $submbox = imap_listmailbox($stream, $url, "*");
         if (!$submbox) {
            print("Issue occurred");
            print("<br>");
         } else {
            foreach ($submbox as $name) {
               print($name . PHP_EOL);
               print("<br>");

            }
         }   
         $test = imap_reopen($stream, $url);
         if ($test == false) {
            print("Mailbox re-openeed successfully");
            print("<br>");
         }
      ?>
   </body>
</html>

Output

This will produce the following output −

{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX
php_function_reference.htm
Advertisements