• PHP Video Tutorials

PHP - imap_scanmailbox() 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_scanmailbox() function is an alias of imap_listscan(). It accepts a resource value representing an IMAP stream, three string values representing the server specification, mailbox hierarchy and text, as parameters and, searches for the mailboxes containing the given text and returns the names of the matched mailboxes in an array.

Syntax

imap_scanmailbox($imap_stream, $ref, $pattern, $txt);

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

ref (Mandatory)

This is a string value representing the server specification.

3

pattern (Mandatory)

This is a string value representing the start of the mailbox hierarchy search.

4

txt (mandatory)

This is a string value representing the text to be searched.

Return Values

This function returns an array which contains the names of mailboxes that contain the given text.

PHP Version

This function was first introduced in PHP Version 4 and works in all the later versions.

Example

This example demonstrates the usage of the imap_scanmailbox() 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>");
		 
         //list of mailboxes
         $res = imap_scanmailbox($imap, $url, "%", "");
         print_r($res);		 

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

Output

This generates the following output −

Test_mail1
Test_mail2
Test_mail3
php_function_reference.htm
Advertisements