smarty-php/smarty
1
0
Fork 0
mirror of https://github.com/smarty-php/smarty.git synced 2025-11-03 22:01:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

Finished improving designers docs

Browse Source
This commit is contained in:
Simon Wisselink
2023-02-06 14:42:31 +01:00
parent 4c6afd6b37
commit cf84802072
55 changed files with 1867 additions and 1837 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
docs/designers/language-custom-functions/language-function-mailto.md
View File

@@ -1,56 +1,61 @@
{mailto} {#language.function.mailto}
========
# {mailto}
`{mailto}` automates the creation of a `mailto:` anchor links and
optionally encodes them. Encoding emails makes it more difficult for web
spiders to lift email addresses off of a site.
## Attributes
| Attribute Name | Required | Description |
|----------------|----------|-----------------------------------------------------------------------------------------------|
| address | Yes | The e-mail address |
| text | No | The text to display, default is the e-mail address |
| encode | No | How to encode the e-mail. Can be one of `none`, `hex`, `javascript` or `javascript_charcode`. |
| cc | No | Email addresses to carbon copy, separate entries by a comma. |
| bcc | No | Email addresses to blind carbon copy, separate entries by a comma |
| subject | No | Email subject |
| newsgroups | No | Newsgroups to post to, separate entries by a comma. |
| followupto | No | Addresses to follow up to, separate entries by a comma. |
| extra | No | Any extra information you want passed to the link, such as style sheet classes |
> **Note**
>
> Javascript is probably the most thorough form of encoding, although
> you can use hex encoding too.
Attribute Name Type Required Default Description
---------------- -------- ---------- --------- -----------------------------------------------------------------------------------------------
address string Yes *n/a* The e-mail address
text string No *n/a* The text to display, default is the e-mail address
encode string No *none* How to encode the e-mail. Can be one of `none`, `hex`, `javascript` or `javascript_charcode`.
cc string No *n/a* Email addresses to carbon copy, separate entries by a comma.
bcc string No *n/a* Email addresses to blind carbon copy, separate entries by a comma
subject string No *n/a* Email subject
newsgroups string No *n/a* Newsgroups to post to, separate entries by a comma.
followupto string No *n/a* Addresses to follow up to, separate entries by a comma.
extra string No *n/a* Any extra information you want passed to the link, such as style sheet classes
## Examples
{mailto address="me@example.com"}
<a href="mailto:me@example.com" >me@example.com</a>
```smarty
{mailto address="me@example.com"}
<a href="mailto:me@example.com" >me@example.com</a>
{mailto address="me@example.com" text="send me some mail"}
<a href="mailto:me@example.com" >send me some mail</a>
{mailto address="me@example.com" text="send me some mail"}
<a href="mailto:me@example.com" >send me some mail</a>
{mailto address="me@example.com" encode="javascript"}
{mailto address="me@example.com" encode="javascript"}
<script>
eval(unescape('%64%6f% ... snipped ...%61%3e%27%29%3b'))
</script>
eval(unescape('%64%6f% ... snipped ...%61%3e%27%29%3b'))
</script>
{mailto address="me@example.com" encode="hex"}
<a href="mailto:%6d%65.. snipped..3%6f%6d">&#x6d;&..snipped...#x6f;&#x6d;</a>
{mailto address="me@example.com" encode="hex"}
<a href="mailto:%6d%65.. snipped..3%6f%6d">&#x6d;&..snipped...#x6f;&#x6d;</a>
{mailto address="me@example.com" subject="Hello to you!"}
<a href="mailto:me@example.com?subject=Hello%20to%20you%21" >me@example.com</a>
{mailto address="me@example.com" subject="Hello to you!"}
<a href="mailto:me@example.com?subject=Hello%20to%20you%21" >me@example.com</a>
{mailto address="me@example.com" cc="you@example.com,they@example.com"}
<a href="mailto:me@example.com?cc=you@example.com,they@example.com" >me@example.com</a>
{mailto address="me@example.com" cc="you@example.com,they@example.com"}
<a href="mailto:me@example.com?cc=you@example.com,they@example.com" >me@example.com</a>
{mailto address="me@example.com" extra='class="email"'}
<a href="mailto:me@example.com" class="email">me@example.com</a>
{mailto address="me@example.com" extra='class="email"'}
<a href="mailto:me@example.com" class="email">me@example.com</a>
{mailto address="me@example.com" encode="javascript_charcode"}
{mailto address="me@example.com" encode="javascript_charcode"}
<script>
{document.write(String.fromCharCode(60,97, ... snipped ....60,47,97,62))}
</script>
{document.write(String.fromCharCode(60,97, ... snipped ....60,47,97,62))}
</script>
```
See also [`escape`](#language.modifier.escape),
[`{textformat}`](#language.function.textformat) and [obfuscating email
addresses](#tips.obfuscating.email).
See also [`escape`](../language-modifiers/language-modifier-escape.md),
[`{textformat}`](../language-custom-functions/language-function-textformat.md) and [obfuscating email
addresses](../../appendixes/tips.md#obfuscating-e-mail-addresses).