Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

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

Located in /joomla/utilities/mail.php (line 328) 

Class JMailHelper   (Subpackage Utilities)
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 385)

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 360)

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 337)

Cleans single line inputs.

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

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 348)

Cleans multi-line inputs.

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

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, 05 Mar 2007 21:10:10 +0000 by phpDocumentor 1.3.1