Support Joomla!

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Class JMailHelper

Description
Description | Methods (details)

E-Mail helper class, provides static methods to perform various tasks relevant to the Joomla e-mail routines.

TODO: Test these methods as the regex work is first run and not tested thoroughly

  • since: 1.5

Located in /joomla/mail/helper.php (line 29) 

Class JMailHelper   (Subpackage Mail)
Method Summary
Description | Methods (details)
Static method static string|false cleanAddress (string $address)
Static method static string cleanBody (string $body)
Static method static string cleanLine (string $value)
Static method static string cleanSubject (string $subject)
Static method static string cleanText (string $value)
Static method static boolean isEmailAddress (string $email)
Methods
Description | Methods (details)
cleanAddress (line 86)

Verifies that an e-mail address does not have any extra headers injected into it.

  • return: E-Mail address string or boolean false if injected headers are present.
  • since: 1.5
string|false cleanAddress (string $address)
  • string $address: E-Mail address.
cleanBody (line 61)

Cleans any injected headers from the E-Mail body.

  • return: Cleaned E-Mail body string.
  • since: 1.5
string cleanBody (string $body)
  • string $body: E-Mail body string.
cleanLine (line 38)

Cleans single line inputs.

  • return: Cleaned string.
string cleanLine (string $value)
  • string $value: String to be cleaned.
cleanSubject (line 74)

Cleans any injected headers from the subject string.

  • return: Cleaned E-Mail subject string.
  • since: 1.5
string cleanSubject (string $subject)
  • string $subject: E-Mail subject string.
cleanText (line 49)

Cleans multi-line inputs.

  • return: Cleaned multi-line string.
string cleanText (string $value)
  • string $value: Multi-line string to be cleaned.
isEmailAddress (line 102)

Verifies that the string is in a proper e-mail address format.

  • return: True if string has the correct format; false otherwise.
  • since: 1.5
boolean isEmailAddress (string $email)
  • string $email: String to be verified.
Documentation generated on Mon, 22 Sep 2008 12:10:00 +0100 by phpDocumentor 1.3.1