1. class
  2. Joomla
  3. CMS
  4. Mail
  5. MailWrapper

MailWrapper

class MailWrapper

Wrapper class for MailHelper

Methods

string
cleanLine( string $value)

Helper wrapper method for cleanLine

string
cleanText( string $value)

Helper wrapper method for cleanText

string
cleanBody( string $body)

Helper wrapper method for cleanBody

string
cleanSubject( string $subject)

Helper wrapper method for cleanSubject

mixed
cleanAddress( string $address)

Helper wrapper method for cleanAddress

boolean
isEmailAddress( string $email)

Helper wrapper method for isEmailAddress

Details

string cleanLine( string $value)

Helper wrapper method for cleanLine

Parameters

string $value String to be cleaned.

Return Value

string Cleaned string.

See also

MailHelper::cleanLine()

string cleanText( string $value)

Helper wrapper method for cleanText

Parameters

string $value Multi-line string to be cleaned.

Return Value

string Cleaned multi-line string.

See also

MailHelper::cleanText()

string cleanBody( string $body)

Helper wrapper method for cleanBody

Parameters

string $body email body string.

Return Value

string Cleaned email body string.

See also

MailHelper::cleanBody()

string cleanSubject( string $subject)

Helper wrapper method for cleanSubject

Parameters

string $subject email subject string.

Return Value

string Cleaned email subject string.

See also

MailHelper::cleanSubject()

mixed cleanAddress( string $address)

Helper wrapper method for cleanAddress

Parameters

string $address email address.

Return Value

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

See also

MailHelper::cleanAddress()

boolean isEmailAddress( string $email)

Helper wrapper method for isEmailAddress

Parameters

string $email String to be verified.

Return Value

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

See also

MailHelper::isEmailAddress()