PHP - Função imap_fetch_overview ()

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_fetch_overview() A função aceita um valor de recurso que representa um fluxo IMAP, um valor de string que representa uma mensagem na caixa de correio como parâmetros e retorna a visão geral das informações do cabeçalho do método especificado.

Sintaxe

imap_fetch_overview($imap_stream, $str [, $options]);

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

str (Mandatory)

Este é um valor de string que representa a sequência dos números da mensagem. Você também pode especificar um intervalo das mensagens como 4:12.

3

options(Optional)

Este é um valor inteiro que representa um valor opcional FT_UID; se especificado, a sequência conterá UIDs em vez de números de mensagem.

Valores Retornados

Esta função retorna uma matriz de objetos, cada um contendo informações sobre os cabeçalhos individuais.

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_fetch_overview() 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>");
		 
         //Fetching the contents of a message
         print("Overview of the first message: "."<br>");
         $overview = imap_fetch_overview($imap, 1);
         print_r($overview);
    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Resultado

Isso irá gerar a seguinte saída -

Connection established....
Overview of the first message:
Array ( 
   [0] => stdClass Object ( 
      [from] => Tutorialspoint [to] => [email protected] 
      [date] => Thu, 22 Oct 2020 20:10:17 +0530 [message_id] => 
      [size] => 4857 [uid] => 19 [msgno] => 1 [recent] => 0 
      [flagged] => 0 [answered] => 0 [deleted] => 0 
      [seen] => 1 [draft] => 0 [udate] => 1603377656 
   ) 
)

Exemplo

A seguir está um exemplo da função acima com parâmetros opcionais -

<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>");
		 
         //Fetching the contents of a message
         print("Overview of the first message: "."<br>");
         $MC = imap_check($imap);
         $overview = imap_fetch_overview($imap, "1:{$MC->Nmsgs}");
         
         //print_r($overview);
         foreach ($overview as $obj) {
            print($obj->date);
            print("<br>");
            print($obj->size);
            print("<br>");
            print($obj->uid);	
            print("<br>");
         }    
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Resultado

Isso irá gerar a seguinte saída -

Connection established....
Overview of the first message:
Thu, 22 Oct 2020 20:10:17 +0530
4857
19
Thu, 22 Oct 2020 20:10:52 +0530
4858
20
Sun, 25 Oct 2020 16:11:22 +0530
4880
42
Sun, 25 Oct 2020 17:22:41 +0530
4882
49
Sun, 25 Oct 2020 17:23:10 +0530
4884
50
Sun, 25 Oct 2020 17:24:25 +0530
4883
51