HTMLPurifier 4.4.0
HTMLPurifier_URIScheme_mailto Class Reference

Validates mailto (for E-mail) according to RFC 2368. More...

Inheritance diagram for HTMLPurifier_URIScheme_mailto:
HTMLPurifier_URIScheme HTMLPurifier_URIScheme

List of all members.

Public Member Functions

 doValidate (&$uri, $config, $context)
 Validates the components of a URI for a specific scheme.
 doValidate (&$uri, $config, $context)
 Validates the components of a URI for a specific scheme.

Public Attributes

 $browsable = false
 Whether or not URIs of this schem are locatable by a browser http and ftp are accessible, while mailto and news are not.
 $may_omit_host = true
 Whether or not the URI may omit a hostname when the scheme is explicitly specified, ala file:///path/to/file.

Detailed Description

Validates mailto (for E-mail) according to RFC 2368.

Todo:

Validate the email address

Filter allowed query parameters

Todo:

Validate the email address

Filter allowed query parameters

Definition at line 12 of file mailto.php.


Member Function Documentation

HTMLPurifier_URIScheme_mailto::doValidate ( &$  uri,
config,
context 
)

Validates the components of a URI for a specific scheme.

Parameters:
$uriReference to a HTMLPurifier_URI object
$configHTMLPurifier_Config object
$contextHTMLPurifier_Context object
Returns:
Bool success or failure

Reimplemented from HTMLPurifier_URIScheme.

Definition at line 17 of file mailto.php.

HTMLPurifier_URIScheme_mailto::doValidate ( &$  uri,
config,
context 
)

Validates the components of a URI for a specific scheme.

Parameters:
$uriReference to a HTMLPurifier_URI object
$configHTMLPurifier_Config object
$contextHTMLPurifier_Context object
Returns:
Bool success or failure

Reimplemented from HTMLPurifier_URIScheme.

Definition at line 17347 of file HTMLPurifier.standalone.php.


Member Data Documentation

HTMLPurifier_URIScheme_mailto::$browsable = false

Whether or not URIs of this schem are locatable by a browser http and ftp are accessible, while mailto and news are not.

Reimplemented from HTMLPurifier_URIScheme.

Definition at line 14 of file mailto.php.

HTMLPurifier_URIScheme_mailto::$may_omit_host = true

Whether or not the URI may omit a hostname when the scheme is explicitly specified, ala file:///path/to/file.

As of writing, 'file' is the only scheme that browsers support his properly.

Reimplemented from HTMLPurifier_URIScheme.

Definition at line 15 of file mailto.php.


The documentation for this class was generated from the following files: