Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe MailHelper

Fonctions membres publiques statiques

static cleanLine ($value)
 
static cleanText ($value)
 
static cleanBody ($body)
 
static cleanSubject ($subject)
 
static cleanAddress ($address)
 
static isEmailAddress ($email)
 

Description détaillée

Email helper class, provides static methods to perform various tasks relevant to the Joomla email routines.

TODO: Test these methods as the regex work is first run and not tested thoroughly

Depuis
11.1

Documentation des fonctions membres

◆ cleanAddress()

static cleanAddress (   $address)
static

Verifies that an email address does not have any extra headers injected into it.

Paramètres
string$addressemail address.
Renvoie
mixed email address string or boolean false if injected headers are present.
Depuis
11.1

Référencé par MailWrapper\cleanAddress().

◆ cleanBody()

static cleanBody (   $body)
static

Cleans any injected headers from the email body.

Paramètres
string$bodyemail body string.
Renvoie
string Cleaned email body string.
Depuis
11.1

Référencé par MailWrapper\cleanBody().

◆ cleanLine()

static cleanLine (   $value)
static

Cleans single line inputs.

Paramètres
string$valueString to be cleaned.
Renvoie
string Cleaned string.
Depuis
11.1

Références $value.

Référencé par Mail\add(), MailWrapper\cleanLine(), Factory\createMailer(), Mail\setSender(), et Mail\setSubject().

◆ cleanSubject()

static cleanSubject (   $subject)
static

Cleans any injected headers from the subject string.

Paramètres
string$subjectemail subject string.
Renvoie
string Cleaned email subject string.
Depuis
11.1

Références $subject.

Référencé par MailWrapper\cleanSubject().

◆ cleanText()

static cleanText (   $value)
static

Cleans multi-line inputs.

Paramètres
string$valueMulti-line string to be cleaned.
Renvoie
string Cleaned multi-line string.
Depuis
11.1

Références $value.

Référencé par MailWrapper\cleanText(), et Mail\setBody().

◆ isEmailAddress()

static isEmailAddress (   $email)
static

Verifies that the string is in a proper email address format.

Paramètres
string$emailString to be verified.
Renvoie
boolean True if string has the correct format; false otherwise.
Depuis
11.1

Référencé par Factory\createMailer(), et MailWrapper\isEmailAddress().


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