6 * @subpackage PluginsFunction
10 * Smarty {mailto} function plugin
14 * Purpose: automate mailto address link creation, and optionally encode them.<br>
17 * - address - (required) - e-mail address
18 * - text - (optional) - text to display, default is address
19 * - encode - (optional) - can be one of:
20 * * none : no encoding (default)
21 * * javascript : encode with javascript
22 * * javascript_charcode : encode with javascript charcode
23 * * hex : encode with hexidecimal (no javascript)
24 * - cc - (optional) - address(es) to carbon copy
25 * - bcc - (optional) - address(es) to blind carbon copy
26 * - subject - (optional) - e-mail subject
27 * - newsgroups - (optional) - newsgroup(s) to post to
28 * - followupto - (optional) - address(es) to follow up to
29 * - extra - (optional) - extra tags for the href link
33 * {mailto address="me@domain.com"}
34 * {mailto address="me@domain.com" encode="javascript"}
35 * {mailto address="me@domain.com" encode="hex"}
36 * {mailto address="me@domain.com" subject="Hello to you!"}
37 * {mailto address="me@domain.com" cc="you@domain.com,they@domain.com"}
38 * {mailto address="me@domain.com" extra='class="mailto"'}
41 * @link http://www.smarty.net/manual/en/language.function.mailto.php {mailto}
42 * (Smarty online manual)
44 * @author Monte Ohrt <monte at ohrt dot com>
45 * @author credits to Jason Sweat (added cc, bcc and subject functionality)
47 * @param array $params parameters
51 function smarty_function_mailto($params)
53 static $_allowed_encoding = array('javascript' => true, 'javascript_charcode' => true, 'hex' => true, 'none' => true);
56 if (empty($params['address'])) {
57 trigger_error("mailto: missing 'address' parameter", E_USER_WARNING);
61 $address = $params['address'];
65 // netscape and mozilla do not decode %40 (@) in BCC field (bug?)
66 // so, don't encode it.
67 $search = array('%40', '%2C');
68 $replace = array('@', ',');
69 $mail_parms = array();
70 foreach ($params as $var => $value) {
76 $mail_parms[] = $var . '=' . str_replace($search, $replace, rawurlencode($value));
82 $mail_parms[] = $var . '=' . rawurlencode($value);
94 $address .= '?' . join('&', $mail_parms);
97 $encode = (empty($params['encode'])) ? 'none' : $params['encode'];
98 if (!isset($_allowed_encoding[$encode])) {
99 trigger_error("mailto: 'encode' parameter must be none, javascript, javascript_charcode or hex", E_USER_WARNING);
103 // FIXME: (rodneyrehm) document.write() excues me what? 1998 has passed!
104 if ($encode == 'javascript') {
105 $string = 'document.write(\'<a href="mailto:' . $address . '" ' . $extra . '>' . $text . '</a>\');';
108 for ($x = 0, $_length = strlen($string); $x < $_length; $x ++) {
109 $js_encode .= '%' . bin2hex($string[$x]);
112 return '<script type="text/javascript">eval(unescape(\'' . $js_encode . '\'))</script>';
113 } elseif ($encode == 'javascript_charcode') {
114 $string = '<a href="mailto:' . $address . '" ' . $extra . '>' . $text . '</a>';
116 for ($x = 0, $y = strlen($string); $x < $y; $x ++) {
117 $ord[] = ord($string[$x]);
120 $_ret = "<script type=\"text/javascript\" language=\"javascript\">\n"
121 . "{document.write(String.fromCharCode("
128 } elseif ($encode == 'hex') {
129 preg_match('!^(.*)(\?.*)$!', $address, $match);
130 if (!empty($match[2])) {
131 trigger_error("mailto: hex encoding does not work with extra attributes. Try javascript.", E_USER_WARNING);
135 $address_encode = '';
136 for ($x = 0, $_length = strlen($address); $x < $_length; $x ++) {
137 if (preg_match('!\w!' . Smarty::$_UTF8_MODIFIER, $address[$x])) {
138 $address_encode .= '%' . bin2hex($address[$x]);
140 $address_encode .= $address[$x];
144 for ($x = 0, $_length = strlen($text); $x < $_length; $x ++) {
145 $text_encode .= '&#x' . bin2hex($text[$x]) . ';';
148 $mailto = "mailto:";
150 return '<a href="' . $mailto . $address_encode . '" ' . $extra . '>' . $text_encode . '</a>';
153 return '<a href="mailto:' . $address . '" ' . $extra . '>' . $text . '</a>';