| Methods |
public
|
__construct(
EntityManagerInterface $em,
TransportInterface $transport,
RouterInterface $router,
TranslatorInterface $translator,
RequestStack $requestStack,
array $config,
)
|
#
|
public
|
initLocale(string $locale = null): string
Initialise la locale pour la génération des messages (auto ou forcé).
Initialise la locale pour la génération des messages (auto ou forcé).
Parameters
| $locale |
Spécifie la locale à utiliser (optionnel)
|
Returns
Retourne la valeur de la locale configurée
|
#
|
public
|
restoreLocale(string $locale = null): void
Réinitialise l'environnement avec la locale d'origine (auto ou forcé).
Réinitialise l'environnement avec la locale d'origine (auto ou forcé).
Parameters
| $locale |
Spécifie la locale à restaurer (optionnel)
|
|
#
|
protected
|
initTwig(array $contents): void
Définition de l'environnement Twig (contenus des templates & ajout des extensions utiles).
Définition de l'environnement Twig (contenus des templates & ajout des extensions utiles).
Parameters
| $contents |
Contenus des vues twig pour 'subject', 'bodyText', 'bodyHtml' et 'bodySms'
|
|
#
|
public
|
prepare(string $ref, string|array $to = [], string|array $pjs = [], string $locale = null, boolean $sms = false): Email
Préparation d'un message à envoyer (objet Symfony Email & environnement Twig).
Préparation d'un message à envoyer (objet Symfony Email & environnement Twig).
Parameters
| $ref |
Référence du modèle de notification (cf tic_mail.templates dans services.yaml)
|
| $to |
Adresses mail des destinataires (chaine avec virgule en séparateur acceptée)
|
| $pjs |
Pièces-jointes (chemin ou structure {'name':, 'type':, 'data':}, seul ou en liste)
|
| $locale |
Spécifie la locale à utiliser (optionnel)
|
| $sms |
Indique s'il s'agit d'un envoi par SMS plutôt que par SMTP
|
Returns
$message Instance du message (Symfony Email) initialisée selon le modèle de notification
(ou null si aucun modèle de notification correspondant actif ou exception)
|
#
|
public
|
setSender(Email &$message, string $sender): void
Indique les informations de l'expéditeur sur un message.
(adresse du "From:" et "Return-Path:" préservée si le domaine…
Indique les informations de l'expéditeur sur un message.
(adresse du "From:" et "Return-Path:" préservée si le domaine du $sender n'est pas dans $config['fromdomains'])
Parameters
| $message |
Instance du message (Symfony Email) auquel ajouter les destinataires
|
| $sender |
Adresse de l'expéditeur à utiliser (peut contenir une partie "nom" devant)
|
|
#
|
public
|
addDest(Email &$message, array|string $dest, boolean $bcc = false, boolean $sms = false): void
Ajout de destinataires sur un message.
Ajout de destinataires sur un message.
Parameters
| $message |
Instance du message (Symfony Email) auquel ajouter les destinataires
|
| $dest |
Liste d'adresses email (si chaine, virgule en séparateur)
|
| $bcc |
Ajout des destinataires en copie cachée (Bcc, sinon To)
|
| $sms |
Destinataires pour SMS (numéros de téléphone avec nom de domaine spécial)
|
|
#
|
public
|
attach(Email &$message, array|string $pj): void
Ajout d'un fichier en pièce-jointe d'un message.
Ajout d'un fichier en pièce-jointe d'un message.
Parameters
| $message |
Instance du message (Symfony Email) à compléter
|
| $pj |
Pièce-jointe (structure {'name':, 'type':, 'data':} ou simple chemin)
|
|
#
|
public
|
embedBase64HtmlImages(Email &$message, string $html): string
Détection des images intégrées en base64 dans du contenu HTML pour extraction et conversion en attachements).
Détection des images intégrées en base64 dans du contenu HTML pour extraction et conversion en attachements).
Parameters
| $message |
Instance du message (Symfony Email) à compléter
|
| $html |
Contenu HTML à analyser pour traiter les images à extraire et attacher
|
Returns
Contenu HTML avec les tag modifiés (data base 64 => cid interne)
|
#
|
public
|
compose(Email &$message, array $data = [], string $ref = null): boolean
Composition du contenu textuel d'un message (rendu des vues Twig).
Composition du contenu textuel d'un message (rendu des vues Twig).
Parameters
| $message |
Instance du message (Symfony Email) à compléter
|
| $data |
Liste clé/valeur pour les substitutions des templates
|
| $ref |
Référence du modèle de notification (pour info dans les logs ; false pour désactiver les logs)
|
Returns
Vrai en cas de succès, faux si une exception a été attrapée
|
#
|
public
|
composeSMS(Email &$message, array $data = [], string $ref = null): boolean
Composition du contenu SMS d'un message (rendu des vues Twig).
Composition du contenu SMS d'un message (rendu des vues Twig).
Parameters
| $message |
Instance du message (Symfony Email) à compléter
|
| $data |
Liste clé/valeur pour les substitutions des templates
|
| $ref |
Référence du modèle de notification (pour info dans les logs ; false pour désactiver les logs)
|
Returns
Vrai en cas de succès, faux si une exception a été attrapée
|
#
|
public
|
send(Email &$message, mixed $ref = null, boolean $sms = false): integer
Envoi un message préparé.
Envoi un message préparé.
Parameters
| $message |
Instance du message (Symfony Email) à envoyer
|
| $ref |
Référence du modèle de notification (pour info dans les logs)
Null (défaut) pour la récupérer automatiquement d'après l'entête X-TIC-Template
False pour désactiver les logs en cas de succès (mais toujours sur Exception)
|
| $sms |
Indique s'il s'agit d'un envoi par SMS plutôt que par SMTP
|
Returns
Nombre de destinataires ou -1 si exception du TransportMailer
|
#
|
public
|
notify(
string $ref,
string|array $to = [],
array $data = [],
string|array $pjs = [],
boolean $return = false,
String $sender = null,
): mixed
Préparation, composition puis envoi d'un message PLAIN et/ou HTML (méthode "combo").
Préparation, composition puis envoi d'un message PLAIN et/ou HTML (méthode "combo").
Parameters
| $ref |
Référence du modèle de notification (cf tic_mail.templates dans services.yaml)
|
| $to |
Adresses mail des destinataires (chaine avec virgule en séparateur acceptée)
|
| $data |
Liste clé/valeur pour les substitutions des templates (peut contenir 'locale')
|
| $pjs |
Pièces-jointes (chemin ou structure {'name':, 'type':, 'data':}, seul ou en liste)
|
| $return |
Si vrai retournera l'objet Symfony Email au lieu de tenter de l'envoyer
|
| $sender |
Adresse d'expéditeur (From, Reply-to ou Return-path selon $config['fromdomains'])
|
Returns
Nombre de destinaires du message envoyé (peut être 0) ou objet Email généré
Null sur échec aux étapes "prepare" ou "compose"
False sur échec à l'envoi par le Transport Mailer
|
#
|
public
|
notifySMS(string $ref, string|array $to = [], array $data = [], boolean $return = false): mixed
Préparation, composition puis envoi d'un message SMS (méthode "combo").
Préparation, composition puis envoi d'un message SMS (méthode "combo").
Parameters
| $ref |
Référence du modèle de notification (cf tic_mail.templates dans services.yaml)
|
| $to |
Adresses mail des destinataires (chaine avec virgule en séparateur acceptée)
|
| $data |
Liste clé/valeur pour les substitutions des templates (peut contenir 'locale')
|
| $return |
Si vrai retournera l'objet Symfony Email au lieu de tenter de l'envoyer
|
Returns
Nombre de destinaires du message envoyé (peut être 0) ou objet Email généré
Null sur échec aux étapes "prepare" ou "compose"
False sur échec à l'envoi par le Transport Mailer
|
#
|
public
|
batch(string $ref, string|array $to, array $data = [], string|array $pjs = []): integer
Préparation, composition puis envoi de messages pour chaque destinataire (méthode "combo").
Préparation, composition puis envoi de messages pour chaque destinataire (méthode "combo").
Parameters
| $ref |
Référence du modèle de notification (cf tic_mail.templates dans services.yaml)
|
| $to |
Adresses mail des destinataires (chaine avec virgule en séparateur acceptée)
|
| $data |
Liste clé/valeur pour les substitutions des templates
|
| $pjs |
Pièces-jointes (chemin ou structure {'name':, 'type':, 'data':}, seul ou en liste)
|
Returns
Nombre de messages envoyés (succès sur destinataire)
Null sur échec aux étapes "prepare" ou "compose"
|
#
|
public
|
logger(string $ref, Email $message = null, integer $rc = null, string $error = null, boolean $sms = false): integer
Enregistrement dans le journal des envois (envoyé avec succès ou échec d'une étape).
Enregistrement dans le journal des envois (envoyé avec succès ou échec d'une étape).
Parameters
| $ref |
Référence du modèle de notification (par défaut récupéré depuis les entêtes)
|
| $message |
Instance du message traité (Symfony Email)
|
| $rc |
Nombre de destinataires si succès, code d'erreur négatif sur exception
|
| $error |
Message de l'exception en cas d'erreur
|
| $sms |
Indique s'il s'agit d'un envoi par SMS plutôt que par SMTP
|
Returns
Identifiant de l'objet Maillog généré
|
#
|
public
|
getLastError(): string
Retourne le message de la dernière erreur rencontrée (exception interceptée).
Retourne le message de la dernière erreur rencontrée (exception interceptée).
|
#
|
public
|
getLastEvent(bool $retrieve_entity = null): integer|Maillog
Retourne l'entrée du journal correspondant au dernier envoi (uniquement son id par défaut).
Retourne l'entrée du journal correspondant au dernier envoi (uniquement son id par défaut).
Returns
Clé primaire du Maillog, référence du Maillog ou objet Maillog
|
#
|
public
|
logLastEvent(object &$entity): MailerService
Ajout dans une entité donnée de l'entrée du journal du dernier envoi (via méthode addMaillog ou addNotification).
Ajout dans une entité donnée de l'entrée du journal du dernier envoi (via méthode addMaillog ou addNotification).
|
#
|
public
|
getLocales(): array
Retourne la liste des langues définies (gestion des messages multilingues).
Note: les locales possibles sont utilisées…
Retourne la liste des langues définies (gestion des messages multilingues).
Note: les locales possibles sont utilisées dans l'admin, mais pas à l'envoi.
Returns
Liste des locales possibles
|
#
|