PHP - imap_unsubscribe() 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_unsubscribe() function accepts a resource value representing an IMAP stream, an integer value representing a message in the mailbox as parameters and unsubscribes from the given mailbox.

Syntax

imap_unsubscribe($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 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_unsubscribe() 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);
         print("subscribed to a mailbox"."<br>");	
		 
         print("List of subscribed mailboxes"."<br>");	
         print_r(imap_lsub($imap, $url, "*" ));
         print("<br>");
		  		 
         //Unsubscribing to the mailbox
         print("Unsubscribed to the mailboxes: "."<br>");
         imap_unsubscribe($imap, $url);		 
		 
         //Retrieving the list of subscribed mailboxes
         print("List of subscribed mailboxes: "."<br>");
         $list = imap_lsub($imap, $url, "*" );	
         print_r($list);		 

         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
subscribed to a mailbox
List of subscribed mailboxes
Array ( [0] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX )
Unsubscribed to the mailboxes:
List of subscribed mailboxes:

Example

This 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>");
		 
         //Creating a mailbox
         $newmailbox1 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mbox_1";
         $newmailbox2 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mbox_2";
         $newmailbox3 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mbox_3";
         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>");
         }
		 		 
         //Unsubscribing to mailboxes
         imap_unsubscribe($imap, $newmailbox3);		 

         //List of subscribed mailboxes
         print("List of subscribed mailboxes after unsubscribing : "."<br>");
         $list = imap_listsubscribed($imap, $url, "*" );		 
         foreach($list as $ele){
            print($ele."<br>");
         }	 

         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate 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.mbox_1
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mbox_2
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mbox_3
List of subscribed mailboxes after unsubscribing :
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mbox_1
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mbox_2

php_function_reference.htm