IMAP_Login

4D Internet Commands v16

IMAP_Login


IMAP_Login ( nomServeur ; nomUtilisateur ; motDePasse ; imap_ID {; paramSession} ) -> Résultat

Paramètre	Type	Description
nomServeur	Chaîne	Nom ou adresse IP du serveur de courrier IMAP
nomUtilisateur	Chaîne	Nom de l’utilisateur
motDePasse	Chaîne	Mot de passe
imap_ID	Entier long	Référence de cette connexion IMAP
paramSession	Entier long	1 = Utiliser SSL, 0 ou omis = Ne pas utiliser SSL
Résultat	Entier	Code d'erreur

Description

La commande IMAP_Login connecte l’utilisateur défini par nomUtilisateur et motDePasse au serveur de courrier IMAP.

IMAP_Login retourne un numéro d’identification spécifique pour la connexion (imap_ID) que les commandes IMAP ultérieures devront utiliser.

La connexion peut être close via la commande IMAP_Logout ou si le compteur d’inactivité du serveur IMAP a atteint le délai de timeout.

Le paramètre nomServeur contient le nom ou l’adresse IP du serveur de courrier IMAP. Il est généralement conseillé d’utiliser le nom du serveur.

Le paramètre nomUtilisateur contient le nom de l’utilisateur du serveur de courrier IMAP. Ce nom ne doit pas contenir le nom du domaine. Par exemple, dans le cas de l’adresse “jack@4d.com”, le nomUtilisateur est “jack”.

Le paramètre motDePasse est le mot de passe correspondant au nomUtilisateur sur le serveur de courrier IMAP.

Le paramètre imap_ID est une variable de type Entier long dans laquelle la référence de la connexion venant d’être établie est renvoyée. Une variable 4D doit être passée à ce paramètre afin d’accepter les résultats retournés. Cette variable devra être utilisée par toutes les commandes suivantes effectuant des actions liées à cette connexion. Si la commande IMAP_Login échoue, imap_ID prend la valeur zéro.

Le paramètre optionnel paramSession vous permet d'activer le protocole SSL pour la connexion :

si vous passez 1, la connexion au serveur IMAP sera effectuée en SSL (mode synchrone),
si vous passez 0 ou omettez ce paramètre, la connexion sera effectuée en mode standard non sécurisé.

Exemple

Voici une séquence type de connexion :

 $ErrorNum:=IMAP_Login(vHost;vUserName;vUserPassword;vImap_ID;1)

 If($ErrorNum =0)

    C_TEXT(vCapability)

    $ErrorNum:=IMAP_Capability(vImap_ID;vCapability))

  ` Commandes IMAP utilisant le paramètre vImap_ID

 End if

 $ErrorNum:=IMAP_Logout(vImap_ID)

Voir aussi

IMAP_Logout
IMAP_VerifyID