Class JMailHelper

Description

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

  • abstract:
  • since: 11.1

Located in /libraries/joomla/mail/helper.php (line 22)


	
			
Method Summary
static mixed cleanAddress (string $address)
static string cleanBody (string $body)
static string cleanLine (string $value)
static string cleanSubject (string $subject)
static string cleanText (string $value)
static boolean isEmailAddress (string $email)
Methods
static method cleanAddress (line 90)

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

  • return: email address string or boolean false if injected headers are present.
  • since: 11.1
  • access: public
static mixed cleanAddress (string $address)
  • string $address: email address.
static method cleanBody (line 61)

Cleans any injected headers from the email body.

  • return: Cleaned email body string.
  • since: 11.1
  • access: public
static string cleanBody (string $body)
  • string $body: email body string.
static method cleanLine (line 33)

Cleans single line inputs.

  • return: Cleaned string.
  • since: 11.1
  • access: public
static string cleanLine (string $value)
  • string $value: String to be cleaned.
static method cleanSubject (line 76)

Cleans any injected headers from the subject string.

  • return: Cleaned email subject string.
  • since: 11.1
  • access: public
static string cleanSubject (string $subject)
  • string $subject: email subject string.
static method cleanText (line 47)

Cleans multi-line inputs.

  • return: Cleaned multi-line string.
  • since: 11.1
  • access: public
static string cleanText (string $value)
  • string $value: Multi-line string to be cleaned.
static method isEmailAddress (line 108)

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

  • return: True if string has the correct format; false otherwise.
  • since: 11.1
  • access: public
static boolean isEmailAddress (string $email)
  • string $email: String to be verified.

Documentation generated on Mon, 25 Jun 2012 13:55:28 -0500 by phpDocumentor 1.4.4