PHP - Función imap_fetch_overview ()

Las funciones PHP − IMAP le ayudan a acceder a las cuentas de correo electrónico, IMAP significa IInternet Mafligir Aacceso Protocol al utilizar estas funciones también puede trabajar con protocolos NNTP, POP3 y métodos de acceso al buzón local.

los imap_fetch_overview() La función acepta un valor de recurso que representa un flujo IMAP, un valor de cadena que representa un mensaje en el buzón como parámetros y devuelve la descripción general de la información del encabezado del método especificado.

Sintaxis

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

Parámetros

No Señor Descripción de parámetros
1

imap_stream (Mandatory)

Este es un valor de cadena que representa un flujo IMAP, valor de retorno del imap_open() función.

2

str (Mandatory)

Este es un valor de cadena que representa la secuencia de los números de mensaje. También puede especificar un intervalo de mensajes como 4:12.

3

options(Optional)

Este es un valor entero que representa un valor opcional FT_UID, si se especifica, la secuencia contendrá UID en lugar de números de mensaje.

Valores devueltos

Esta función devuelve una matriz de objetos, cada uno de los cuales contiene información sobre los encabezados individuales.

Versión PHP

Esta función se introdujo por primera vez en PHP versión 4 y funciona en todas las versiones posteriores.

Ejemplo

El siguiente ejemplo demuestra el uso de imap_fetch_overview() función -

<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>

Salida

Esto generará la siguiente salida:

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 
   ) 
)

Ejemplo

A continuación se muestra un ejemplo de la función anterior con parámetros opcionales:

<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>

Salida

Esto generará la siguiente salida:

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