Documentation du code de SPIP et de ses plugins

SPIP

envoyer_mail.php

Gestion des emails et de leur envoi

Table of Contents

Functions

nettoyer_titre_email()  : string
Nettoyer le titre d'un email
nettoyer_caracteres_mail()  : string
Utiliser le bon encodage de caractères selon le charset
inc_envoyer_mail_dist()  : bool
Envoi d'un mail
mail_normaliser_headers()  : array<string|int, mixed>
Formater correctement l'entête d'un email

Functions

nettoyer_caracteres_mail()

Utiliser le bon encodage de caractères selon le charset

nettoyer_caracteres_mail(string $t) : string

Caractères pris en compte : apostrophe, double guillemet, le tiret cadratin, le tiret demi-cadratin

Parameters
$t : string
Tags
uses
filtrer_entites()
Return values
string

inc_envoyer_mail_dist()

Envoi d'un mail

inc_envoyer_mail_dist(string $destinataire, string $sujet, string|array<string|int, mixed> $corps[, string $from = '' ][, string $headers = '' ]) : bool
Parameters
$destinataire : string
$sujet : string
$corps : string|array<string|int, mixed>
  • au format string, c'est un corps d'email au format texte, comme supporte nativement par le core
  • au format array, c'est un corps etendu qui peut contenir
    • string texte : le corps d'email au format texte
    • string from : email de l'envoyeur (prioritaire sur argument $from de premier niveau, deprecie)
    • array headers : tableau d'en-tetes personalises, une entree par ligne d'en-tete --- Support partiel par une fonction mail_embarquer_pieces_jointes a fournir, --- --- chargee de convertir en texte encodee les pieces jointes ---
    • array pieces_jointes : listes de pieces a embarquer dans l'email, chacune au format array :
      • string chemin : chemin file system pour trouver le fichier a embarquer
      • string nom : nom du document tel qu'apparaissant dans l'email
      • string encodage : encodage a utiliser, parmi 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
      • string mime : mime type du document --- Non implemente ici ---
    • string html : le corps d'email au format html
    • string nom_envoyeur : un nom d'envoyeur pour completer l'email from
    • string cc : destinataires en copie conforme
    • string bcc : destinataires en copie conforme cachee
    • string adresse_erreur : addresse de retour en cas d'erreur d'envoi
$from : string = ''

(deprecie, utiliser l'entree from de $corps)

$headers : string = ''

(deprecie, utiliser l'entree headers de $corps)

Return values
bool

mail_normaliser_headers()

Formater correctement l'entête d'un email

mail_normaliser_headers(string $headers, string $from, string $to, string $texte[, string $parts = '' ]) : array<string|int, mixed>
Parameters
$headers : string
$from : string
$to : string
$texte : string
$parts : string = ''
Return values
array<string|int, mixed>

        
On this page

Search results