Référence de la classe Email

Classe de gestion des emails pour Paaxio Utilise PHPMailer pour l'envoi d'emails via SMTP. Plus de détails...

Graphe de collaboration de Email:

Fonctions membres publiques
	__construct (\Twig\Environment $twig)
	Constructeur de la classe Email.
	sendEmail (string $to, string $toName, string $subject, string $htmlBody, ?string $textBody=null)
	Envoie un email générique.
	sendWelcomeEmail (string $email, string $pseudo, string $type)
	Envoie un email de bienvenue à un nouvel utilisateur.
	sendConfirmationEmail (string $email, string $pseudo, string $confirmationToken)
	Envoie un email de confirmation d'inscription.
	sendPasswordResetEmail (string $email, string $pseudo, string $resetToken)
	Envoie un email de réinitialisation de mot de passe.
	sendNewsletterEmail (string $email, string $subject, string $content, ?string $unsubscribeToken=null)
	Envoie un email de newsletter.
	sendNotificationEmail (string $email, string $pseudo, string $type, array $data=[])
	Envoie un email de notification (nouvel album, nouveau follower, etc.)
	sendContactEmail (string $fromEmail, string $fromName, string $subject, string $message)
	Envoie un email de contact (depuis le formulaire de contact)
	sendBulkEmail (array $recipients, string $subject, string $content)
	Envoie un email en masse à plusieurs destinataires (pour la newsletter)
	testSmtpConnection ()
	Teste la configuration SMTP.
	testEmail ()
	Fonction de test simple de la classe Email avec un nom et un email factices.

Fonctions membres publiques statiques
static	generateToken (int $length=32)
	Génère un token sécurisé

Fonctions membres privées
	loadMailConfig ()
	Charge la configuration email depuis le fichier config.json.
	createMailer ()
	Crée et configure une instance PHPMailer.
	getSiteUrl ()
	Récupère l'URL du site.

Attributs privés
array	$mailConfig
Twig Environment	$twig

Description détaillée

Classe de gestion des emails pour Paaxio Utilise PHPMailer pour l'envoi d'emails via SMTP.

Définition à la ligne 11 du fichier email.class.php.

Documentation des constructeurs et destructeur

__construct()

Email::__construct

(

\Twig\Environment

$twig

)

Constructeur de la classe Email.

Paramètres

\Twig\Environment

$twig

Instance Twig pour le rendu des templates

Définition à la ligne 20 du fichier email.class.php.

Références $twig, et loadMailConfig().

Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

createMailer()

Email::createMailer ( )

private

Crée et configure une instance PHPMailer.

Renvoie

PHPMailer Instance configurée

Définition à la ligne 49 du fichier email.class.php.

Référencé par sendContactEmail(), sendEmail(), et testSmtpConnection().

Voici le graphe des appelants de cette fonction :

generateToken()

static Email::generateToken ( int  $length = 32 )

static

Génère un token sécurisé

Paramètres

int

$length

Longueur du token

Renvoie

string Token généré

Définition à la ligne 342 du fichier email.class.php.

getSiteUrl()

Email::getSiteUrl ( )

private

Récupère l'URL du site.

Renvoie

string URL de base du site

Définition à la ligne 330 du fichier email.class.php.

Référencé par sendConfirmationEmail(), sendContactEmail(), sendNewsletterEmail(), sendNotificationEmail(), sendPasswordResetEmail(), et sendWelcomeEmail().

Voici le graphe des appelants de cette fonction :

loadMailConfig()

Email::loadMailConfig ( )

private

Charge la configuration email depuis le fichier config.json.

Exceptions

Exception

Si le fichier de configuration est introuvable ou invalide

Définition à la ligne 30 du fichier email.class.php.

Référencé par __construct().

Voici le graphe des appelants de cette fonction :

sendBulkEmail()

Email::sendBulkEmail	(	array	$recipients,
		string	$subject,
		string	$content
	)

Envoie un email en masse à plusieurs destinataires (pour la newsletter)

Paramètres

array	$recipients	Tableau d'emails des destinataires
string	$subject	Sujet de l'email
string	$content	Contenu HTML

Renvoie

array Résultats de l'envoi ['success' => int, 'failed' => int, 'errors' => array]

Définition à la ligne 295 du fichier email.class.php.

Références sendNewsletterEmail().

Voici le graphe d'appel pour cette fonction :

sendConfirmationEmail()

Email::sendConfirmationEmail	(	string	$email,
		string	$pseudo,
		string	$confirmationToken
	)

Envoie un email de confirmation d'inscription.

Paramètres

string	$email	Adresse email de l'utilisateur
string	$pseudo	Pseudo de l'utilisateur
string	$confirmationToken	Token de confirmation

Renvoie

bool True si l'envoi a réussi

Définition à la ligne 141 du fichier email.class.php.

Références getSiteUrl(), et sendEmail().

Voici le graphe d'appel pour cette fonction :

sendContactEmail()

Email::sendContactEmail	(	string	$fromEmail,
		string	$fromName,
		string	$subject,
		string	$message
	)

Envoie un email de contact (depuis le formulaire de contact)

Paramètres

string	$fromEmail	Email de l'expéditeur
string	$fromName	Nom de l'expéditeur
string	$subject	Sujet du message
string	$message	Message

Renvoie

bool True si l'envoi a réussi

Définition à la ligne 256 du fichier email.class.php.

Références createMailer(), et getSiteUrl().

Voici le graphe d'appel pour cette fonction :

sendEmail()

Email::sendEmail	(	string	$to,
		string	$toName,
		string	$subject,
		string	$htmlBody,
		?string	$textBody = null
	)

Envoie un email générique.

Paramètres

string	$to	Adresse email du destinataire
string	$toName	Nom du destinataire
string	$subject	Sujet de l'email
string	$htmlBody	Corps HTML de l'email
string | null	$textBody	Corps texte brut (optionnel)

Renvoie

bool True si l'envoi a réussi

Exceptions

Exception

En cas d'erreur d'envoi

Définition à la ligne 92 du fichier email.class.php.

Références createMailer().

Référencé par sendConfirmationEmail(), sendNewsletterEmail(), sendNotificationEmail(), sendPasswordResetEmail(), et sendWelcomeEmail().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

sendNewsletterEmail()

Email::sendNewsletterEmail	(	string	$email,
		string	$subject,
		string	$content,
		?string	$unsubscribeToken = null
	)

Envoie un email de newsletter.

Paramètres

string	$email	Adresse email du destinataire
string	$subject	Sujet de la newsletter
string	$content	Contenu HTML de la newsletter
string | null	$unsubscribeToken	Token de désinscription

Renvoie

bool True si l'envoi a réussi

Définition à la ligne 200 du fichier email.class.php.

Références getSiteUrl(), et sendEmail().

Référencé par sendBulkEmail().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

sendNotificationEmail()

Email::sendNotificationEmail	(	string	$email,
		string	$pseudo,
		string	$type,
		array	$data = []
	)

Envoie un email de notification (nouvel album, nouveau follower, etc.)

Paramètres

string	$email	Adresse email du destinataire
string	$pseudo	Pseudo du destinataire
string	$type	Type de notification
array	$data	Données additionnelles pour la notification

Renvoie

bool True si l'envoi a réussi

Définition à la ligne 228 du fichier email.class.php.

Références getSiteUrl(), et sendEmail().

Voici le graphe d'appel pour cette fonction :

sendPasswordResetEmail()

Email::sendPasswordResetEmail	(	string	$email,
		string	$pseudo,
		string	$resetToken
	)

Envoie un email de réinitialisation de mot de passe.

Paramètres

string	$email	Adresse email de l'utilisateur
string	$pseudo	Pseudo de l'utilisateur
string	$resetToken	Token de réinitialisation

Renvoie

bool True si l'envoi a réussi

Définition à la ligne 170 du fichier email.class.php.

Références getSiteUrl(), et sendEmail().

Voici le graphe d'appel pour cette fonction :

sendWelcomeEmail()

Email::sendWelcomeEmail	(	string	$email,
		string	$pseudo,
		string	$type
	)

Envoie un email de bienvenue à un nouvel utilisateur.

Paramètres

string	$email	Adresse email de l'utilisateur
string	$pseudo	Pseudo de l'utilisateur
string	$type	Type de compte (artiste, auditeur, producteur)

Renvoie

bool True si l'envoi a réussi

Définition à la ligne 115 du fichier email.class.php.

Références getSiteUrl(), et sendEmail().

Référencé par testEmail().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

testEmail()

Email::testEmail

(

)

Fonction de test simple de la classe Email avec un nom et un email factices.

Cette méthode peut être appelée pour vérifier l'envoi d'un email.

Renvoie

array Informations sur le résultat du test

Définition à la ligne 380 du fichier email.class.php.

Références sendWelcomeEmail().

Voici le graphe d'appel pour cette fonction :

testSmtpConnection()

Email::testSmtpConnection

(

)

Teste la configuration SMTP.

Renvoie

array Résultat du test

Définition à la ligne 351 du fichier email.class.php.

Références createMailer().

Voici le graphe d'appel pour cette fonction :

Documentation des données membres

$mailConfig

array Email::$mailConfig

private

Définition à la ligne 13 du fichier email.class.php.

$twig

Twig Environment Email::$twig

private

Définition à la ligne 14 du fichier email.class.php.

Référencé par __construct().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• email.class.php