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)
static	convertRelativeToAbsoluteUrls ($content)

Fonctions membres privées statiques
static	checkContent ($content)

Description détaillée

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

Depuis

1.7.0

Documentation des fonctions membres

checkContent()

static checkContent (   $content )

staticprivate

Check the content after regular expression function call.

Paramètres

string

$content

Content to be checked.

Renvoie

void

Exceptions

Références $content, $message, et null.

cleanAddress()

static cleanAddress (   $address )

static

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

Paramètres

string

$address

email address.

Renvoie

mixed email address string or boolean false if injected headers are present.

Depuis

1.7.0

cleanBody()

static cleanBody (   $body )

static

Cleans any injected headers from the email body.

Paramètres

string

$body

email body string.

Renvoie

string Cleaned email body string.

Depuis

1.7.0

cleanLine()

static cleanLine (   $value )

static

Cleans single line inputs.

Paramètres

string

$value

String to be cleaned.

Renvoie

string Cleaned string.

Depuis

1.7.0

Références $value, et PunycodeHelper\emailToPunycode().

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

cleanSubject()

static cleanSubject (   $subject )

static

Cleans any injected headers from the subject string.

Paramètres

string

$subject

email subject string.

Renvoie

string Cleaned email subject string.

Depuis

1.7.0

Références $subject.

cleanText()

static cleanText (   $value )

static

Cleans multi-line inputs.

Paramètres

string

$value

Multi-line string to be cleaned.

Renvoie

string Cleaned multi-line string.

Depuis

1.7.0

Références $value.

Référencé par Mail\setBody().

convertRelativeToAbsoluteUrls()

static convertRelativeToAbsoluteUrls (   $content )

static

Convert relative (links, images sources) to absolute urls so that content is accessible in email

Paramètres

string

$content

The content need to convert

Renvoie

string The converted content which the relative urls are converted to absolute urls

Depuis

4.1.0

Références $attributes, $content, Route\link(), Uri\root(), et Route\TLS_IGNORE.

isEmailAddress()

static isEmailAddress (   $email )

static

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

Paramètres

string

$email

String to be verified.

Renvoie

boolean True if string has the correct format; false otherwise.

Depuis

1.7.0

Références PunycodeHelper\toPunycode().

Référencé par User\check(), Factory\createMailer(), et HtmlView\display().

---

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

• MailHelper.php