PHP - imap_subscribe() 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_subscribe()accepts a resource value representing an IMAP stream, a string value representing the URL/name of the mailbox as parameters and subscribes to a new mailbox.

Syntax

imap_subscribe($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_subscribe() 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>");
		 
         //Subscribing to the mailbox
         $res = imap_subscribe($imap, $url);
		 
         if($res){
            print("Subscribed successfully"."<br>");
         } else {
            print("Error Occurred"."<br>");
         } 
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This generates the following output −

Connection established....
Subscribed successfully

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>");
		 
         //Creating a mailbox
         $newmailbox1 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box1";
         $newmailbox2 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box2";
         $newmailbox3 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box3";
         imap_createmailbox($imap, imap_utf7_encode($newmailbox1));
         imap_createmailbox($imap, imap_utf7_encode($newmailbox2));
         imap_createmailbox($imap, imap_utf7_encode($newmailbox3));
         print("Mailboxes Created . . . . "."<br>");
		 		 
         //Subscribing to the mailbox
         $res = imap_subscribe($imap, $newmailbox1);
         $res = imap_subscribe($imap, $newmailbox2);
         $res = imap_subscribe($imap, $newmailbox3);
         print("Subscribed to the created mailboxes . . . . "."<br>");
		 
         //List of subscribed mailboxes
         print("List of subscribed mailboxes . . . . "."<br>");
         $list = imap_listsubscribed($imap, $url, "*" );		 
         foreach($list as $ele){
            print($ele."<br>");
         }
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This generates the following output −

Connection established....
Mailboxes Created . . . .
Subscribed to the created mailboxes . . . .
List of subscribed mailboxes . . . .
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box1
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box2
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box3

php_function_reference.htm