HTMLPurifier_URIScheme_mailto Class Reference

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

Inheritance diagram for HTMLPurifier_URIScheme_mailto:

Collaboration diagram for HTMLPurifier_URIScheme_mailto:

Public Member Functions
	doValidate (&$uri, $config, $context)
	Validates the components of a URI for a specific scheme.
Public Member Functions inherited from HTMLPurifier_URIScheme
	validate (&$uri, $config, $context)
	Public interface for validating components of a URI.

Data Fields
	$browsable = false
	$may_omit_host = true
Data Fields inherited from HTMLPurifier_URIScheme
	$default_port = null
	Scheme's default port (integer).
	$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.
	$hierarchical = false
	Whether or not the URI always uses <hier_part>, resolves edge cases with making relative URIs absolute.
	$may_omit_host = false
	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

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

$uri	Reference to a HTMLPurifier_URI object
$config	HTMLPurifier_Config object
$context	HTMLPurifier_Context object

Returns

Bool success or failure

Reimplemented from HTMLPurifier_URIScheme.

Definition at line 17 of file mailto.php.

                                                         {
        $uri->userinfo = null;
        $uri->host     = null;
        $uri->port     = null;
        // we need to validate path against RFC 2368's addr-spec
        return true;
    }

Field Documentation

HTMLPurifier_URIScheme_mailto::$browsable = false

Definition at line 14 of file mailto.php.

HTMLPurifier_URIScheme_mailto::$may_omit_host = true

Definition at line 15 of file mailto.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/URIScheme/mailto.php