MailWrapper
Wrapper class for MailHelper
deprecated
since |
3.4 |
---|---|
deprecated |
4.0 Will be removed without replacement |
Methods
cleanAddress
Helper wrapper method for cleanAddress
cleanAddress(string $address) : mixed
see | \Joomla\CMS\Mail\MailHelper::cleanAddress() |
---|---|
since |
3.4 |
Arguments
- $address
string
email address.
Response
mixed
email address string or boolean false if injected headers are present
cleanBody
Helper wrapper method for cleanBody
cleanBody(string $body) : string
see | \Joomla\CMS\Mail\MailHelper::cleanBody() |
---|---|
since |
3.4 |
Arguments
- $body
string
email body string.
Response
string
Cleaned email body string.
cleanLine
Helper wrapper method for cleanLine
cleanLine(string $value) : string
see | \Joomla\CMS\Mail\MailHelper::cleanLine() |
---|---|
since |
3.4 |
Arguments
- $value
string
String to be cleaned.
Response
string
Cleaned string.
cleanSubject
Helper wrapper method for cleanSubject
cleanSubject(string $subject) : string
see | \Joomla\CMS\Mail\MailHelper::cleanSubject() |
---|---|
since |
3.4 |
Arguments
- $subject
string
email subject string.
Response
string
Cleaned email subject string.
cleanText
Helper wrapper method for cleanText
cleanText(string $value) : string
see | \Joomla\CMS\Mail\MailHelper::cleanText() |
---|---|
since |
3.4 |
Arguments
- $value
string
Multi-line string to be cleaned.
Response
string
Cleaned multi-line string.
isEmailAddress
Helper wrapper method for isEmailAddress
isEmailAddress(string $email) : boolean
see | \Joomla\CMS\Mail\MailHelper::isEmailAddress() |
---|---|
since |
3.4 |
Arguments
string
String to be verified.
Response
boolean
True if string has the correct format; false otherwise.