PHP - Función imap_getsubscriptions ()

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

los imap_getsubscribed() La función acepta un valor de recurso que representa un flujo IMAP, dos valores de cadena que representan la especificación del servidor y la jerarquía del buzón como parámetros y lee / recupera información sobre todos los buzones suscritos.

Sintaxis

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

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

ref (Mandatory)

Este es un valor de cadena que representa la especificación del servidor.

3

pattern (Mandatory)

Este es un valor de cadena que representa el inicio de la búsqueda de la jerarquía del buzón.

Valores devueltos

Esta función devuelve una matriz de objetos donde cada objeto contiene información sobre los buzones de correo suscritos.

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_getsubscribed() 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>");
		 
         //Subscribing to the mailbox
         $res = imap_subscribe($imap, $url);
		 
         //Retrieving the list of subscribed mailboxes
         $list = imap_getsubscribed($imap, $url, "*" );	
         print_r($list);		 

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

Salida

Esto generará la siguiente salida:

Connection established....
Array ( 
   [0] => stdClass Object ( 
      [name] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX 
      [attributes] => 64 [delimiter] => / 
   ) 
   [1] => stdClass Object ( 
      [name] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box1 
      [attributes] => 64 [delimiter] => / 
   ) 
   [2] => stdClass Object ( 
      [name] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mail_box2 
      [attributes] => 64 [delimiter] => / 
   ) 
   [3] => stdClass Object (
      [name] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mbox_1 
      [attributes] => 64 [delimiter] => / 
   ) 
   [4] => stdClass Object ( 
      [name] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.mbox_2 
      [attributes] => 64 [delimiter] => / 
   ) 
)

Ejemplo

A continuación se muestra otro ejemplo de esta 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>");
		 
         //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";
         $newmailbox3 = "{imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail3";
         imap_createmailbox($imap, imap_utf7_encode($newmailbox1));
         imap_createmailbox($imap, imap_utf7_encode($newmailbox2));
         imap_createmailbox($imap, imap_utf7_encode($newmailbox3));
         print("Mailboxes Created . . . . "."<br>");
		 		 
         //Subscribing to the mailbox
         $res = imap_subscribe($imap, $newmailbox1);
         $res = imap_subscribe($imap, $newmailbox2);
         $res = imap_subscribe($imap, $newmailbox3);
         print("Subscribed to the created mailboxes . . . . "."<br>");
		   
         //List of subscribed mailboxes
         print("List of subscribed mailboxes . . . . "."<br>");
         $list = imap_getsubscribed($imap, $url, "*" );		 
         print_r($list);
	  
         //Closing the connection
         imap_close($imap);   
      ?>
   </body>
</html>

Salida

Esto generará la siguiente salida:

Connection established....
Mailboxes Created . . . .
Subscribed to the created mailboxes . . . .
List of subscribed mailboxes . . . .
Array ( 
   [0] => stdClass Object (
      [name] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX 
      [attributes] => 64 [delimiter] => / 
   ) 
   [1] => stdClass Object (
      [name] => [delimiter] => / 
   ) 
   [9] => stdClass Object ( 
      [name] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail1 
      [attributes] => 64 [delimiter] => / 
   ) 
   [10] => stdClass Object (
      [name] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail2 
      [attributes] => 64 [delimiter] => / 
   ) 
   [11] => stdClass Object (
      [name] => {imap.gmail.com:993/imap/ssl/novalidate-cert}INBOX.test_mail3 
      [attributes] => 64 [delimiter] => / 
   ) 
)