AlternC, Documentation Développeur
PrécédentChapitre 7. Les classes php, détails de l'implémentationSuivant

m_mails, Gestion des comptes email pop et des alias mails des domaines hébergés.

Cette classe gere la création / modification / destructions des comptes POP et des alias de messageries associés aux domaines du membre courant.

Voici la liste des fonctions disponibles dans la classe m_mails

$ma->enum_domains()

Retourne un tableau contenant les domaines ayant l'email géré par le membre courant.

Retour :

array Retourne un tableau indexé contenant les domaines dont le mail est hébergé sur ce serveur, pour le membre courant. Retourne FALSE si une erreur s'est produite.

$ma->enum_doms_mails($dom)

Retourne un tableau contenant les mails du domaine $dom gérés par le membre courant.

Paramètres :

$dom Domaine hébergé chez le membre courant, dont on souhaite la liste des emails

Retour :

array Retourne un tableau indexé contenant la partie gauche de l'@ des mails gérés sur ce domaine pour le membre courant. Ne retourne que les mails principaux, mais ni les listes de discussion, ni les mails particuliers (sympa, listmaster...) Retourne FALSE si une erreur s'est produite.

$ma->get_mail_details($mail)

Retourne un tableau contenant les details d'un mail gere par le membre courant

Paramètres :

$mail Email COMPLET (login@domaine.tld) dont on souhaite obtenir les informations.

Retour :

boolean Retourne un tableau associatif avec les informations du mail sous la forme : 

	r["mail"]     = Rappel du mail complet.
	r["login"]    = Login pop éventuel
	r["password"] = Mot de passe en clair
	r["alias"]    = Contient la liste des redirections (1 mail par ligne)
	r["pop"]      = Un compte pop est-il associé ?
Retourne FALSE si une erreur s'est produite.

$ma->change_password($mail,$pass)

Change le mot de passe du mail spécifié, hébergé chez le membre courant.

Paramètres :

$mail Email dont on souhaite changer le mot de passe POP.

$pass Nouveau mot de passe, (max 32 Caractères)

Retour :

boolean Retourne FALSE si une erreur s'est produite, TRUE sinon.

$ma->put_mail_details($mail,$pop,$pass,$alias)

Modifie les paramètres d'un email existant.

Paramètres :

$mail mail complet dont on souhaite modifier les valeurs. il doit être hébergé par le membre courant.

$pop Vaut 1 pour un compte pop, ou 0 pour un alias seul

$pass Mot de passe POP si pop vaut 1

$alias Liste des emails devant recevoir une copie des mails reçus, un par ligne.

Retour :

boolean Retourne FALSE si une erreur s'est produite, TRUE sinon.

$ma->add_mail($dom,$mail,$pop,$pass,$alias)

Cree un nouveau mail associe a ce membre $dom est le domaine. $mail est un login pop (pour un mail direct). $pop vaut 1 pour creer un compte pop $pass est le mot de passe (en clair) $alias est une chaine de redirections eventuelles (un email par ligne) si $mail est vide, il s'agit du CATCH-ALL.

Paramètres :

$dom Domaine du mail (partie droite du @)

$mail Partie gauche du @

$pop Vaut 1 pour un compte pop, ou 0 pour un alias seul

$pass Mot de passe POP si pop vaut 1

$alias Liste des emails devant recevoir une copie des mails reçus, un par ligne.

Retour :

boolean Retourne FALSE si une erreur s'est produite, TRUE sinon.

$ma->del_mail($mail)

Détruit le compte mail demandé, appartenant au membre courant.

Paramètres :

$mail Email complet que l'on souhaite supprimer.

Retour :

boolean Retourne FALSE si une erreur s'est produite, TRUE sinon.

PrécédentSommaireSuivant
m_ftp, Gestion des comptes FTP hébergésNiveau supérieurm_error, Gestion des erreurs et des logs.