imap_fetch_overview

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_fetch_overviewLee el resumen de los encabezados de los mensajes

Descripción

imap_fetch_overview(IMAP\Connection $imap, string $sequence, int $flags = 0): array|false

Lee los encabezados de los correos electrónicos de la secuencia sequence y devuelve un resumen de su contenido.

Parámetros

imap

An IMAP\Connection instance.

sequence

Una descripción de la secuencia del mensaje. Se pueden enumerar los mensajes deseados con la sintaxis X,Y, o recuperar todos los mensajes de un intervalo, con la sintaxis X:Y

flags

sequence contendrá una secuencia de índice de mensaje o de UID, si flags contiene FT_UID.

Valores devueltos

Devuelve un array de objetos que describen el encabezado de cada mensaje. El objeto solo definirá una propiedad si existe. Las propiedades posibles son:

  • subject : el asunto del mensaje
  • from : el remitente
  • to : el destinatario
  • date : la fecha de envío
  • message_id : la identificación del mensaje
  • references : la referencia sobre el id de este mensaje
  • in_reply_to : la respuesta a este identificador de mensaje
  • size : el tamaño en bytes
  • uid : UID del mensaje en el buzón
  • msgno : el número de secuencia del mensaje en el buzón
  • recent : este mensaje es reciente
  • flagged : este mensaje está marcado
  • answered : este mensaje ha dado lugar a una respuesta
  • deleted : este mensaje está marcado para el borrado
  • seen : este mensaje ya ha sido leído
  • draft : este mensaje es un borrador
  • udate : el horario UNIX de la hora de llegada
La función devuelve false en caso de fallo.

Historial de cambios

Versión Descripción
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap recurso was expected.

Ejemplos

Ejemplo #1 Ejemplo con imap_fetch_overview()

<?php
$mbox
= imap_open("{imap.example.org:143}INBOX", "username", "password")
or die(
"Conexión imposible: " . imap_last_error());

$MC = imap_check($mbox);

// Recupera el resumen para todos los mensajes contenidos en 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

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top