PHP - imap_undelete() Function

Quiz

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_udelete() function accepts a resource value representing an IMAP stream, an integer value representing a message in the mailbox as parameters and unmarks the messages that are marked for deletion (using the delete() function).

Syntax

imap_undelete($imap_stream, $msg);

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	msg (Mandatory) This is an integer value representing the message/mail number, that is to marked for deletion.
3	flags (Optional) This is an optional parameter representing the flag.

Sr.No

Parameter & Description

imap_stream (Mandatory)

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

msg (Mandatory)

This is an integer value representing the message/mail number, that is to marked for deletion.

flags (Optional)

This is an optional parameter representing the flag.

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_undelete() 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>");
		 		 
         //Marking message for deletion
         $res = imap_delete($imap, 4);

         if($res){
            print("Message marked for deletion"."<br>");
         }		 
         //Deleting messages
         $res = imap_undelete($imap, 4);	 	
         if($res){
            print("Message un-marked successfully"."<br>");
         } else {
            print("Error Occured");
         }	 		 
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Output

This will generate the following output −

Connection established....
Message marked for deletion
Message un-marked successfully

php_function_reference.htm

Print Page