imap_ping

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

imap_pingVérifie que le flux IMAP est toujours actif

Description

imap_ping(IMAP\Connection $imap): bool

Vérifie que le flux est toujours actif, en lui envoyant un ping. Cette fonction permet de se rendre compte qu'un mail est arrivé : c'est même la méthode préconisée pour des tests périodiques de vérification du courrier. Cette fonction peut aussi servir à garder une connexion ouverte, avec les serveurs dotés d'un délai d'expiration.

Liste de paramètres

imap

Une instance de IMAP\Connection.

Valeurs de retour

Retourne true si le flux est toujours actif, false sinon.

Historique

Version Description
8.1.0 La paramètre imap attend désormais une instance de IMAP\Connection ; auparavant, une ressource imap était attendue.

Exemples

Exemple #1 Exemple avec imap_ping()

<?php

$imap
= imap_open("{imap.example.org}", "mailadmin", "password");

// après une pause
if (!imap_ping($imap)) {
// effectuez un traitement pour se reconnecter
}

?>

add a note add a note

User Contributed Notes 1 note

up
-18
Anonymous
21 years ago
This is a great solution for a webmail class if you want to make sure that a user is still logged in. Example:

<?php
if(!(imap_ping($stream)) {
die(
"The user is no longer logged in.");
?>
To Top