Source for file Ethna_MailSender.php

Documentation is available at Ethna_MailSender.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Ethna_MailSender.php
  5.  *
  6.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  7.  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
  8.  *  @package    Ethna
  9.  *  @version    $Id: Ethna_MailSender.php 483 2007-10-30 14:56:00Z cocoitiban $
  10.  */
  11.  
  12. /** メールテンプレートタイプ: 直接送信 */
  13. define('MAILSENDER_TYPE_DIRECT', 0);
  14.  
  15.  
  16. // {{{ Ethna_MailSender
  17. /**
  18.  *  メール送信クラス
  19.  *
  20.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  21.  *  @access     public
  22.  *  @package    Ethna
  23.  */
  24. class Ethna_MailSender
  25. {
  26.     /**#@+
  27.      *  @access private
  28.      */
  29.  
  30.     /** @var    array   メールテンプレート定義 */
  31.     var $def = array(
  32.     );
  33.  
  34.     /** @var    string  メールテンプレートディレクトリ */
  35.     var $mail_dir = 'mail';
  36.  
  37.     /** @var    int     送信メールタイプ */
  38.     var $type;
  39.  
  40.     /** @var    string  送信オプション */
  41.     var $option = '';
  42.  
  43.     /** @var    object  Ethna_Backend   backendオブジェクト */
  44.     var $backend;
  45.  
  46.     /** @var    object  Ethna_Config    設定オブジェクト */
  47.     var $config;
  48.  
  49.     /**#@-*/
  50.  
  51.     /**
  52.      *  Ethna_MailSenderクラスのコンストラクタ
  53.      *
  54.      *  @access public
  55.      *  @param  object  Ethna_Backend   &$backend       backendオブジェクト
  56.      */
  57.     function Ethna_MailSender(&$backend)
  58.     {
  59.         $this->backend =& $backend;
  60.         $this->config =& $this->backend->getConfig();
  61.     }
  62.  
  63.     /**
  64.      *  メールオプションを設定する
  65.      *
  66.      *  @access public
  67.      *  @param  string  $option メール送信オプション
  68.      */
  69.     function setOption($option)
  70.     {
  71.         $this->option = $option;
  72.     }
  73.  
  74.     /**
  75.      *  メールを送信する
  76.      *
  77.      *  $attach の指定方法:
  78.      *  - 既存のファイルを添付するとき
  79.      *  <code>
  80.      *  array('filename' => '/tmp/hoge.xls', 'content-type' => 'application/vnd.ms-excel')
  81.      *  </code>
  82.      *  - 文字列に名前を付けて添付するとき
  83.      *  <code>
  84.      *  array('name' => 'foo.txt', 'content' => 'this is foo.')
  85.      *  </code>
  86.      *  'content-type' 省略時は 'application/octet-stream' となる。
  87.      *  複数添付するときは上の配列を添字0から始まるふつうの配列に入れる。
  88.      *
  89.      *  @access public
  90.      *  @param  string  $to         メール送信先アドレス (nullのときは送信せずに内容を return する)
  91.      *  @param  string  $template   メールテンプレート名 or タイプ
  92.      *  @param  array   $macro      テンプレートマクロ or $templateがMAILSENDER_TYPE_DIRECTのときはメール送信内容)
  93.      *  @param  array   $attach     添付ファイル
  94.      */
  95.     function send($to, $template, $macro, $attach = null)
  96.     {
  97.         // メール内容を作成
  98.         if ($template === MAILSENDER_TYPE_DIRECT) {
  99.             $mail = $macro;
  100.         } else {
  101.             $renderer =& $this->getTemplateEngine();
  102.  
  103.             // 基本情報設定
  104.             $renderer->setProp("env_datetime", strftime('%Y年%m月%d日 %H時%M分%S秒'));
  105.             $renderer->setProp("env_useragent", $_SERVER["HTTP_USER_AGENT"]);
  106.             $renderer->setProp("env_remoteaddr", $_SERVER["REMOTE_ADDR"]);
  107.  
  108.             // デフォルトマクロ設定
  109.             $macro = $this->_setDefaultMacro($macro);
  110.  
  111.             // ユーザ定義情報設定
  112.             if (is_array($macro)) {
  113.                 foreach ($macro as $key => $value) {
  114.                     $renderer->setProp($key, $value);
  115.                 }
  116.             }
  117.             if (isset($this->def[$template])) {
  118.                 $template = $this->def[$template];
  119.             }
  120.             $mail = $renderer->perform(sprintf('%s/%s', $this->mail_dir, $template), true);
  121.         }
  122.         if ($to === null) {
  123.             return $mail;
  124.         }
  125.  
  126.         // メール内容をヘッダと本文に分離
  127.         $mail = str_replace("\r\n", "\n", $mail);
  128.         list($header, $body) = $this->_parse($mail);
  129.  
  130.         // 添付ファイル (multipart)
  131.         if ($attach !== null) {
  132.             $attach = isset($attach[0]) ? $attach : array($attach);
  133.             $boundary = Ethna_Util::getRandom(); 
  134.             $body = "This is a multi-part message in MIME format.\n\n" .
  135.                 "--$boundary\n" .
  136.                 "Content-Type: text/plain; charset=iso-2022-jp\n" .
  137.                 "Content-Transfer-Encoding: 7bit\n\n" .
  138.                 "$body\n";
  139.             foreach ($attach as $part) {
  140.                 if (isset($part['content']) === false
  141.                     && isset($part['filename']) && is_readable($part['filename'])) {
  142.                     $part['content'] = file_get_contents($part['filename']);
  143.                     $part['filename'] = basename($part['filename']);
  144.                 }
  145.                 if (isset($part['content']) === false) {
  146.                     continue;
  147.                 }
  148.                 if (isset($part['content-type']) === false) {
  149.                     $part['content-type'] = 'application/octet-stream';
  150.                 }
  151.                 if (isset($part['name']) === false) {
  152.                     $part['name'] = $part['filename'];
  153.                 }
  154.                 if (isset($part['filename']) === false) {
  155.                     $part['filename'] = $part['name'];
  156.                 }
  157.                 $part['name'] = preg_replace('/([^\x00-\x7f]+)/e',
  158.                     "Ethna_Util::encode_MIME('$1')", $part['name']); // XXX: rfc2231
  159.                 $part['filename'] = preg_replace('/([^\x00-\x7f]+)/e',
  160.                     "Ethna_Util::encode_MIME('$1')", $part['filename']);
  161.  
  162.                 $body .=
  163.                     "--$boundary\n" .
  164.                     "Content-Type: " . $part['content-type'] . ";\n" .
  165.                         "\tname=\"" . $part['name'] . "\"\n" .
  166.                     "Content-Transfer-Encoding: base64\n" . 
  167.                     "Content-Disposition: attachment;\n" .
  168.                         "\tfilename=\"" . $part['filename'] . "\"\n\n";
  169.                 $body .= chunk_split(base64_encode($part['content']));
  170.             }
  171.             $body .= "--$boundary--";
  172.         }
  173.  
  174.         // ヘッダ
  175.         if (isset($header['mime-version']) === false) {
  176.             $header['mime-version'] = array('Mime-Version', '1.0');
  177.         }
  178.         if (isset($header['subject']) === false) {
  179.             $header['subject'] = array('Subject', 'no subject in original');
  180.         }
  181.         if (isset($header['content-type']) === false) {
  182.             $header['content-type'] = array(
  183.                 'Content-Type',
  184.                 $attach === null ? 'text/plain; charset=iso-2022-jp'
  185.                                  : "multipart/mixed; \n\tboundary=\"$boundary\"",
  186.             );
  187.         }
  188.  
  189.         $header_line = "";
  190.         foreach ($header as $key => $value) {
  191.             if ($key == 'subject') {
  192.                 // should be added by mail()
  193.                 continue;
  194.             }
  195.             if ($header_line != "") {
  196.                 $header_line .= "\n";
  197.             }
  198.             $header_line .= $value[0] . ": " . $value[1];
  199.         }
  200.  
  201.         // 改行コードを CRLF に
  202.         if (strtoupper(substr(PHP_OS, 0, 3)) == 'WIN') {
  203.             $body = str_replace("\n", "\r\n", $body);
  204.         }
  205.         $header_line = str_replace("\n", "\r\n", $header_line);
  206.  
  207.         // 送信
  208.         foreach (to_array($to) as $rcpt) {
  209.             if (is_string($this->option)) {
  210.                 mail($rcpt, $header['subject'][1], $body, $header_line, $this->option);
  211.             } else {
  212.                 mail($rcpt, $header['subject'][1], $body, $header_line);
  213.             }
  214.         }
  215.     }
  216.  
  217.     /**
  218.      *  アプリケーション固有のマクロを設定する
  219.      *
  220.      *  @access protected
  221.      *  @param  array   $macro  ユーザ定義マクロ
  222.      *  @return array   アプリケーション固有処理済みマクロ
  223.      */
  224.     function _setDefaultMacro($macro)
  225.     {
  226.         return $macro;
  227.     }
  228.  
  229.     /**
  230.      *  テンプレートメールのヘッダ情報を取得する
  231.      *
  232.      *  @access private
  233.      *  @param  string  $mail   メールテンプレート
  234.      *  @return array   ヘッダ, 本文
  235.      */
  236.     function _parse($mail)
  237.     {
  238.         list($header_line, $body) = preg_split('/\r?\n\r?\n/', $mail, 2);
  239.         $header_line .= "\n";
  240.  
  241.         $header_lines = explode("\n", $header_line);
  242.         $header = array();
  243.         foreach ($header_lines as $h) {
  244.             if (strstr($h, ':') == false) {
  245.                 continue;
  246.             }
  247.             list($key, $value) = preg_split('/\s*:\s*/', $h, 2);
  248.             $i = strtolower($key);
  249.             $header[$i] = array();
  250.             $header[$i][] = $key;
  251.             $header[$i][] = preg_replace('/([^\x00-\x7f]+)/e', "Ethna_Util::encode_MIME('$1')", $value);
  252.         }
  253.  
  254.         $body = mb_convert_encoding($body, "ISO-2022-JP");
  255.  
  256.         return array($header, $body);
  257.     }
  258.  
  259.     /**
  260.      *  メールフォーマット用レンダラオブジェクト取得する
  261.      *
  262.      *  @access public
  263.      *  @return object  Ethna_Renderer  レンダラオブジェクト
  264.      */
  265.     function &getRenderer()
  266.     {
  267.         $_ret_object =& $this->getTemplateEngine();
  268.         return $_ret_object;
  269.     }
  270.  
  271.     /**
  272.      *  メールフォーマット用レンダラオブジェクト取得する
  273.      *
  274.      *  @access public
  275.      *  @return object  Ethna_Renderer  レンダラオブジェクト
  276.      */
  277.     function &getTemplateEngine()
  278.     {
  279.         $c =& $this->backend->getController();
  280.         $renderer =& $c->getRenderer();
  281.         return $renderer;
  282.     }
  283. }
  284. // }}}
  285. ?>

Documentation generated on Thu, 08 May 2008 00:14:58 +0900 by phpDocumentor 1.4.2