phpDocumentor Smarty
plugins
[ class tree: Smarty ] [ index: Smarty ] [ all elements ]
Smarty
Packages:
phpDocumentor
Converters
Cpdf
HTML_TreeMenu
Smarty
tests
XML_Beautifier

Source for file function.mailto.php

Documentation is available at function.mailto.php

  1. <?php
  2. /**
  3.  * Smarty plugin
  4.  * @package Smarty
  5.  * @subpackage plugins
  6.  */
  7.  
  8.  
  9. /**
  10.  * Smarty {mailto} function plugin
  11.  *
  12.  * Type:     function<br>
  13.  * Name:     mailto<br>
  14.  * Date:     May 21, 2002
  15.  * Purpose:  automate mailto address link creation, and optionally
  16.  *           encode them.<br>
  17.  * Input:<br>
  18.  *         - address = e-mail address
  19.  *         - text = (optional) text to display, default is address
  20.  *         - encode = (optional) can be one of:
  21.  *                * none : no encoding (default)
  22.  *                * javascript : encode with javascript
  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
  30.  * 
  31.  * Examples:
  32.  * <pre>
  33.  * {mailto address="[email protected]"}
  34.  * {mailto address="[email protected]" encode="javascript"}
  35.  * {mailto address="[email protected]" encode="hex"}
  36.  * {mailto address="[email protected]" subject="Hello to you!"}
  37.  * {mailto address="[email protected]" cc="[email protected],[email protected]"}
  38.  * {mailto address="[email protected]" extra='class="mailto"'}
  39.  * </pre>
  40.  * @link http://smarty.php.net/manual/en/language.function.mailto.php {mailto}
  41.  *           (Smarty online manual)
  42.  * @version  1.2
  43.  * @author     Monte Ohrt <[email protected]>
  44.  * @author credits to Jason Sweat (added cc, bcc and subject functionality)
  45.  * @param array 
  46.  * @param Smarty 
  47.  * @return string 
  48.  */
  49. function smarty_function_mailto($params, &$smarty)
  50. {
  51.     $extra = '';
  52.     extract($params);
  53.  
  54.     if (empty($address)) {
  55.         $smarty->trigger_error("mailto: missing 'address' parameter");
  56.         return;
  57.     }
  58.     
  59.     if (empty($text)) {
  60.         $text = $address;
  61.     }
  62.     
  63.     // netscape and mozilla do not decode %40 (@) in BCC field (bug?)
  64.     // so, don't encode it.
  65.     
  66.     $mail_parms = array();
  67.     if (!empty($cc)) {
  68.         $mail_parms[] = 'cc='.str_replace('%40','@',rawurlencode($cc));
  69.     }
  70.     
  71.     if (!empty($bcc)) {
  72.         $mail_parms[] = 'bcc='.str_replace('%40','@',rawurlencode($bcc));
  73.     }
  74.     
  75.     if (!empty($subject)) {
  76.         $mail_parms[] = 'subject='.rawurlencode($subject);
  77.     }
  78.  
  79.     if (!empty($newsgroups)) {
  80.         $mail_parms[] = 'newsgroups='.rawurlencode($newsgroups);
  81.     }
  82.  
  83.     if (!empty($followupto)) {
  84.         $mail_parms[] = 'followupto='.str_replace('%40','@',rawurlencode($followupto));
  85.     }
  86.     
  87.     $mail_parm_vals = '';
  88.     for ($i=0; $i<count($mail_parms); $i++) {
  89.         $mail_parm_vals .= (0==$i) ? '?' : '&';
  90.         $mail_parm_vals .= $mail_parms[$i];
  91.     }
  92.     $address .= $mail_parm_vals;
  93.     
  94.     if (empty($encode)) {
  95.         $encode = 'none';
  96.     } elseif (!in_array($encode,array('javascript','hex','none')) ) {
  97.         $smarty->trigger_error("mailto: 'encode' parameter must be none, javascript or hex");
  98.         return;        
  99.     }
  100.     
  101.     if ($encode == 'javascript' ) {
  102.         $string = 'document.write(\'<a href="mailto:'.$address.'" '.$extra.'>'.$text.'</a>\');';
  103.         
  104.         for ($x=0; $x < strlen($string); $x++) {
  105.             $js_encode .= '%' . bin2hex($string[$x]);
  106.         }
  107.     
  108.         return '<script type="text/javascript" language="javascript">eval(unescape(\''.$js_encode.'\'))</script>';
  109.         
  110.     } elseif ($encode == 'hex') {
  111.  
  112.         preg_match('!^(.*)(\?.*)$!',$address,$match);
  113.         if(!empty($match[2])) {
  114.             $smarty->trigger_error("mailto: hex encoding does not work with extra attributes. Try javascript.");
  115.             return;                        
  116.         }  
  117.         for ($x=0; $x < strlen($address); $x++) {
  118.             if(preg_match('!\w!',$address[$x])) {
  119.                 $address_encode .= '%' . bin2hex($address[$x]);
  120.             } else {
  121.                 $address_encode .= $address[$x];                
  122.             }
  123.         }
  124.         for ($x=0; $x < strlen($text); $x++) {
  125.             $text_encode .= '&#x' . bin2hex($text[$x]).';';
  126.         }
  127.         
  128.         return '<a href="mailto:'.$address_encode.'" '.$extra.'>'.$text_encode.'</a>';
  129.         
  130.     } else {
  131.         // no encoding        
  132.         return '<a href="mailto:'.$address.'" '.$extra.'>'.$text.'</a>';
  133.  
  134.     }
  135.     
  136. }
  137.  
  138. /* vim: set expandtab: */
  139.  
  140. ?>
Documentation generated on Tue, 24 Oct 2006 09:22:42 -0500 by phpDocumentor 1.3.1