imap_fetch_overview

(PHP 4, PHP 5, PHP 7)

imap_fetch_overview — Leer una visión general de la información de las cabeceras del mensaje dado

Descripción

imap_fetch_overview ( resource $imap_stream , string $sequence [, int $options = 0 ] ) : array

Esta función obtiene las cabeceras del correo de la secuencia dada por sequence y devuelve una visión general de sus contenidos.

Parámetros

imap_stream

IMAP stream devuelto por imap_open().

sequence

Una descripción de la secuencia de mensajes. Puede enumerar los mensajes deseados con la sintaxis X,Y, o recuperar todos los mensajes dentro de un intervalo con la sintaxis X:Y

options

sequence contendrá una secuencia de índices de mensajes; o UIDs, si este parámetro está establecido a FT_UID.

Valores devueltos

Devuelve un array de objetos que describen una cabecera de mensaje cada uno. El objeto sólo definirá una propiedad si ésta existe. Las propiedades posibles son:

  • subject - el sujeto del mensaje
  • from - quién lo envió
  • to - destinatario
  • date - cuándo fue enviado
  • message_id - ID del mensaje
  • references - es una referencia a este id de mensaje
  • in_reply_to - es una respueste a este id de mensaje
  • size - tamaño en bytes
  • uid - UID del mensaje que está en el buzón
  • msgno - número de secuencia de mensaje en el buzón
  • recent - este mensaje está marcado como reciente
  • flagged - este mensaje está marcado
  • answered - este mensaje está marcado como respondido
  • deleted - este mensaje está marcado para su eliminación
  • seen - este mensaje está marcado como ya leído
  • draft - este mensaje está marcado como borrador

Ejemplos

Ejemplo #1 Ejemplo de imap_fetch_overview()

<?php
$mbox = imap_open("{imap.example.org:143}INBOX", "username", "password")
     or die("no se puede conectar: " . imap_last_error());

$MC = imap_check($mbox);

// Obtener una visión general de todos los mensajes de INBOX
$result = imap_fetch_overview($mbox,"1:{$MC->Nmsgs}",0);
foreach ($result as $overview) {
    echo "#{$overview->msgno} ({$overview->date}) - From: {$overview->from}
    {$overview->subject}\n";
}
imap_close($mbox);
?>

Ver también