imap_mail_move

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

imap_mail_moveDéplace des messages dans une boîte aux lettres

Description

imap_mail_move(
    IMAP\Connection$imap,
    string$message_nums,
    string$mailbox,
    int$flags = 0
): bool

imap_mail_move() déplace les messages spécifiés par message_nums dans la boîte aux lettres mailbox. À noter que les messages sont en réalité copiées à la boîte au lettres mailbox, et les messages originaux sont marquées pour être supprimés. Ceci implique que les messages dans mailbox sont assignées des nouveaux UIDs.

Liste de paramètres

imap

Une instance de IMAP\Connection.

message_nums

message_nums est un intervalle, et pas seulement une liste de messages (comme décrit dans la » RFC2060).

mailbox

Le nom de la boîte aux lettres, voir la documentation de la fonction imap_open() pour plus de détails

Avertissement

Passer des données qui ne sont pas digne de confiance à ce paramètre est dangereux, sauf si, imap.enable_insecure_rsh est désactivé.

flags

flags est un champ de bits et peut contenir une seule valeur :

  • CP_UID - La séquence de nombres contient des UID

Valeurs de retour

Cette fonction retourne true en cas de succès ou false si une erreur survient.

Historique

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

Notes

Note:

imap_mail_move() va marquer l'email original avec un marqueur de suppression, pour effectivement le supprimer, un appel à imap_expunge() est nécessaire.

Voir aussi

To Top