PHP - Função imap_listmailbox ()

As funções PHP-IMAP ajudam você a acessar contas de e-mail, IMAP significa IInternet Maflição Acesso Protocol usando essas funções, você também pode trabalhar com NNTP, protocolos POP3 e métodos de acesso à caixa de correio local.

o imap_listmailbox() função é um alias de imap_list() ele aceita um valor de recurso que representa um fluxo IMAP, dois valores de string que representam a especificação do servidor e a hierarquia da caixa de correio como parâmetros e lê a lista de caixas de correio especificadas.

Sintaxe

imap_listmailbox($imap_stream, $ref, $pattern);

Parâmetros

Sr. Não	Parâmetro e Descrição
1	imap_stream (Mandatory) Este é um valor de string que representa um fluxo IMAP, valor de retorno do imap_open() função.
2	ref (Mandatory) Este é um valor de string que representa a especificação do servidor.
3	pattern (Mandatory) Este é um valor de string que representa o início da pesquisa de hierarquia de caixa de correio.

Valores Retornados

Esta função retorna um array que contém os nomes das caixas de correio em caso de sucesso, e retorna um valor booleano FALSE em caso de falha.

Versão PHP

Esta função foi introduzida pela primeira vez no PHP Versão 4 e funciona em todas as versões posteriores.

Exemplo

O exemplo a seguir demonstra o uso do imap_listmailbox() função -

<html>
   <body>
      <?php
         //Establishing connection
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "[email protected]";
         $pwd = "cohondob_123";
         $imap = imap_open($url, $id, $pwd);
         print("Connection established...."."<br>");
		 
         //list of mailboxes
         $res = imap_listmailbox($imap, $url, "*");
         print_r($res);		 
         
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Resultado

Isso irá gerar a seguinte saída -

Connection established....
Array ( [0] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX [1] =>)

Exemplo

A seguir está outro exemplo desta função -

<html>
   <body>
      <?php
         $url = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX";
         $id = "[email protected]";
         $pwd = "cohondob_123";
         $mailbox = imap_open($url, $id, $pwd);
         print("Connection established....");
         print("<br>");

         //Creating a mailbox
         $newmailbox1 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail1";
         $newmailbox2 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail2";   
         $res = imap_createmailbox($mailbox, imap_utf7_encode($newmailbox1));
         $res = imap_createmailbox($mailbox, imap_utf7_encode($newmailbox2));		 
		 
         //Retrieving the contents of mail boxes
         $list = imap_listmailbox($mailbox, $url, "*");
         foreach ($list as $key => $val) {
            print_r($val);
            print("<br>");
         }	 
      ?>
   </body>
</html>

Resultado

Isso irá gerar a seguinte saída -

Connection established....
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail1
{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail2

↰ Previous page