Class JMailHelper

Description

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 /mail/mail.php (line 325)


	
			
Method Summary
 mixed cleanAddress (string $address)
 string cleanBody (string &$body)
 string cleanSubject (string $subject)
 void isEmailAddress (mixed $email)
Methods
cleanAddress (line 364)

This method verifies that an e-mail address does not have any extra headers injected into it. Tests one e-mail address.

  • return: E-Mail address string or boolean false if injected headers are present
  • since: 1.1
  • static:
mixed cleanAddress (string $address)
  • string $address: E-Mail address
cleanBody (line 335)

This method cleans any injected headers from the E-Mail body

  • return: Cleaned E-Mail body string
  • since: 1.1
  • static:
string cleanBody (string &$body)
  • string $body: E-Mail body string
cleanSubject (line 351)

This method cleans any injected headers from the subject string.

  • return: Cleaned E-Mail subject string
  • since: 1.1
  • static:
string cleanSubject (string $subject)
  • string $subject: E-Mail subject string
isEmailAddress (line 373)
void isEmailAddress (mixed $email)

Documentation generated on Sat, 4 Feb 2006 14:24:17 +0100 by phpDocumentor 1.3.0RC4