imap_fetch_overview

(PHP 4, PHP 5)

imap_fetch_overview — Lit le sommaire des en-têtes de messages

Description

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

Lit les en-têtes des courriers électroniques de la séquence sequence et retourne un sommaire de leur contenu.

Liste de paramètres

imap_stream: Un flux IMAP retourné par la fonction imap_open().
sequence: Une description de la séquence du message. Vous pouvez énumérer les messages désirés avec la syntaxe X,Y, ou récupérer tous les messages d'un intervalle, avec la syntaxe X:Y
options: sequence va contenir une séquence d'indice de message ou d'UID, si flags contient FT_UID.

Valeurs de retour

Retourne un tableau d'objets décrivant l'en-tête de chaque message. L'objet ne définira une propriété que si elle existe. Les propriétés possibles sont :

subject : le sujet du message
from : l'expéditeur
to : le destinataire
date : la date d'expédition
message_id : l'identification du message
references : la référence sur l'id de ce message
in_reply_to : la réponse à cet identifiant de message
size : la taille en octets
uid : UID du message dans la boîte aux lettres
msgno : le numéro de séquence du message dans la boîte
recent : ce message est récent
flagged : ce message est marqué
answered : ce message a donné lieu à une réponse
deleted : ce message est marqué pour l'effacement
seen : ce message est déjà lu
draft : ce message est un brouillon

Exemples

Exemple #1 Exemple avec imap_fetch_overview()

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

$MC = imap_check($mbox);

// Récupère le sommaire pour tous les messages contenus dans 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);
?>

Voir aussi

imap_fetchheader() - Retourne l'en-tête d'un message