JMailHelper
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
| package |
Joomla.Platform |
|---|---|
| subpackage |
|
| since |
11.1 |
Methods
cleanAddress
Verifies that an email address does not have any extra headers injected into it.
cleanAddress(string $address) : mixed
| since |
11.1 |
|---|
Arguments
- $address
stringemail address.
Response
mixedemail address string or boolean false if injected headers are present.
cleanBody
Cleans any injected headers from the email body.
cleanBody(string $body) : string
| since |
11.1 |
|---|
Arguments
- $body
stringemail body string.
Response
stringCleaned email body string.
cleanLine
Cleans single line inputs.
cleanLine(string $value) : string
| since |
11.1 |
|---|
Arguments
- $value
stringString to be cleaned.
Response
stringCleaned string.
cleanSubject
Cleans any injected headers from the subject string.
cleanSubject(string $subject) : string
| since |
11.1 |
|---|
Arguments
- $subject
stringemail subject string.
Response
stringCleaned email subject string.
cleanText
Cleans multi-line inputs.
cleanText(string $value) : string
| since |
11.1 |
|---|
Arguments
- $value
stringMulti-line string to be cleaned.
Response
stringCleaned multi-line string.
isEmailAddress
Verifies that the string is in a proper email address format.
isEmailAddress(string $email) : boolean
| since |
11.1 |
|---|
Arguments
stringString to be verified.
Response
booleanTrue if string has the correct format; false otherwise.