1. class
  2. Soosyze
  3. \
  4. Components
  5. \
  6. Email
  7. \
  8. Email

Email

class Email (View source)

Créer un email de type text ou HTML.

Properties

protected string $subject Le sujet du email.
protected string $message Le message texte ou html.
protected array $headers Les paramètres d'entête. Pré-remplis par défaut pour un email basique.

Methods

$this
to(string $email, string $name = '')

Ajoute un destinataire.

$this
addCc(string $email, string $name = '')

Ajoute un ou plusieurs déstinataires en copie du email.

$this
addBcc(type $email, string $name = '')

Ajoute un ou plusieurs destinataires en copie cachée du email.

$this
from(string $email, string $name = '')

Ajoute une adresse de provenance.

$this
replayTo(string $email, string $name = '')

Ajoute une adresse de retour.

$this
subject(string $subj)

Ajoute un sujet au email, le texte est encodé au format ASCII.

$this
message(string $msg)

Ajoute un message, le texte est encodé au format ASCII.

$this
isHtml($bool = true)

Déclare que le contenu du email est de l'HTML.

bool
send()

Envoie l'email.

array
getHeaders()

Renvoie le tableau d'en-tête.

string
getHeaderLine($name)

Récupère une chaîne de valeurs séparées par des virgules pour un seul en-tête.

string[]
getHeader($name)

Vérifie si un en-tête existe par le nom (insensible à la casse).

bool
hasHeader($name)

Vérifie si un en-tête existe par le nom (insensible à la casse).

string
parseHeaders()

Parse les données de l'entête pour l'envoi du email.

string
parseMail(string $email, string $name = '')

Formalise les données d'un email est de son destinataire.

$this
withHeader(string $name, string|string[] $value)

Renvoyer une instance avec la valeur fournie en remplaçant l'en-tête spécifié.

$this
withAddedHeader(string $name, string|string[] $value)

Renvoyer une instance avec la valeur fournie en ajoutant l'en-tête spécifié.

Details

at line 55
$this to(string $email, string $name = '')

Ajoute un destinataire.

Parameters

string $email Email du destinataire.
string $name Nom du destinataire.

Return Value

$this

at line 70
$this addCc(string $email, string $name = '')

Ajoute un ou plusieurs déstinataires en copie du email.

Parameters

string $email Email en copie.
string $name Nom du destinataire.

Return Value

$this

at line 85
$this addBcc(type $email, string $name = '')

Ajoute un ou plusieurs destinataires en copie cachée du email.

Parameters

type $email Email en copie cachée.
string $name Nom du destinataire.

Return Value

$this

at line 100
$this from(string $email, string $name = '')

Ajoute une adresse de provenance.

Parameters

string $email Email de provenance.
string $name Nom du destinataire.

Return Value

$this

at line 115
$this replayTo(string $email, string $name = '')

Ajoute une adresse de retour.

Parameters

string $email Email de retour.
string $name Nom du destinataire.

Return Value

$this

at line 129
$this subject(string $subj)

Ajoute un sujet au email, le texte est encodé au format ASCII.

Parameters

string $subj Sujet du email.

Return Value

$this

at line 143
$this message(string $msg)

Ajoute un message, le texte est encodé au format ASCII.

Parameters

string $msg Corp du email.

Return Value

$this

at line 157
$this isHtml($bool = true)

Déclare que le contenu du email est de l'HTML.

Parameters

$bool Si vrais le contenu sera envoyé en mode HTML.

Return Value

$this

at line 171
bool send()

Envoie l'email.

Return Value

bool Si l'email est bien envoyé.

at line 185
array getHeaders()

Renvoie le tableau d'en-tête.

Return Value

array

at line 198
string getHeaderLine($name)

Récupère une chaîne de valeurs séparées par des virgules pour un seul en-tête.

Parameters

$name Nom du champ d'en-tête insensible à la casse.

Return Value

string Si l'en-tête est trouvé alors il est renvoyé toutes les valeurs de l'en-tête concaténés par une virgule, sinon une chaine vide.

at line 213
string[] getHeader($name)

Vérifie si un en-tête existe par le nom (insensible à la casse).

Parameters

$name Nom du champ d'en-tête insensible à la casse.

Return Value

string[] Si l'en-tête est trouvé alors il est renvoyé toutes ses valeurs, sinon un tableau vide.

at line 227
bool hasHeader($name)

Vérifie si un en-tête existe par le nom (insensible à la casse).

Parameters

$name Nom du champ d'en-tête insensible à la casse.

Return Value

bool

at line 237
string parseHeaders()

Parse les données de l'entête pour l'envoi du email.

Return Value

string

at line 257
protected string parseMail(string $email, string $name = '')

Formalise les données d'un email est de son destinataire.

Parameters

string $email Email (from, bcc, cc, replayTo...).
string $name Nom du destinataire.

Return Value

string

at line 272
protected $this withHeader(string $name, string|string[] $value)

Renvoyer une instance avec la valeur fournie en remplaçant l'en-tête spécifié.

Parameters

string $name Nom du champ d'en-tête insensible à la casse.
string|string[] $value Valeur(s) de l'en-tête.

Return Value

$this

at line 289
protected $this withAddedHeader(string $name, string|string[] $value)

Renvoyer une instance avec la valeur fournie en ajoutant l'en-tête spécifié.

Parameters

string $name Nom du champ d'en-tête insensible à la casse.
string|string[] $value Valeur(s) de l'en-tête.

Return Value

$this