View Helpers
mailTo()
Signature
Section titled “Signature”mailTo() — returns string
Available in: controller
Category: Link Functions
Description
Section titled “Description”Creates a mailto link tag to the specified email address, which is also used as the name of the link unless name is specified.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
emailAddress | string | yes | — | The email address to link to. |
name | string | no | — | A string to use as the link text (“Joe” or “Support Department”, for example). |
encode | any | no | true | When set to true, encodes tag content, attribute values, and URLs so that Cross Site Scripting (XSS) attacks can be prevented. Set to attributes to only encode attribute values and not tag content. |
Examples
Section titled “Examples”#mailTo(emailAddress="webmaster@yourdomain.com", name="Contact our Webmaster")# <!--- Outputs: <a href="mailto:webmaster@yourdomain.com">Contact our Webmaster</a> --->