Return to v2.1 docs

mailTo()


View Helpers Link Functions string controller


Creates a mailto link tag to the specified email address, which is also used as the name of the link unless name is specified.

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 Use this argument to decide whether the output of the function should be encoded in order to prevent Cross Site Scripting (XSS) attacks. Set it to true to encode all relevant output for the specific HTML element in question (e.g. tag content, attribute values, and URLs). For HTML elements that have both tag content and attribute values you can set this argument to attributes to only encode attribute values and not tag content.
#mailTo(emailAddress="[email protected]", name="Contact our Webmaster")#
<!--- Outputs: <a href="mailto:[email protected]">Contact our Webmaster</a> --->

Related Functions

Link Functions