$mail.createFolder

Description

Crée un dossier sur le serveur mail. Cette méthode n'est fonctionnelle que sur les serveurs IMAP.

Syntaxe

$mail.createFolder( path , options )

Paramètres

path string

Chemin du dossier à créer. Il est possible de créer une arborescence en notant par exemple "archive/2025/06". La méthode se charge alors de créer tous les niveaux.

options string

Options de connexion. Les options mailbox, type, host, port, username, password, security et properties fonctionnent selon le même principe que décrit dans la méthode $mail.read.

Retour

Retourne true si la création a réussi (ou si le dossier existe déjà) et false si le dossier n'a pas pu être créé.

Exemple

$mail.createFolder("archive/2025/03", {
    mailbox: "mail.hostname.com"
});