Discussion:
[22890] standard/incubator: documentation added for Zend_Mail file transport
lcf
2010-08-23 20:39:46 UTC
Permalink
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[framework-svn][22890] standard/incubator: documentation added for Zend_Mail file transport</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg > ul, #logmsg > ol { margin-left: 0; margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd>22890</dd>
<dt>Author</dt> <dd>lcf</dd>
<dt>Date</dt> <dd>2010-08-23 13:39:46 -0700 (Mon, 23 Aug 2010)</dd>
</dl>

<h3>Log Message</h3>
<pre>documentation added for Zend_Mail file transport</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#standardincubatorlibraryZendMailTransportFilephp">standard/incubator/library/Zend/Mail/Transport/File.php</a></li>
<li><a href="#standardincubatortestsZendMailFileTestphp">standard/incubator/tests/Zend/Mail/FileTest.php</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li><a href="#standardincubatordocumentationmanualenmodule_specsZend_MailUsingFileTransportxml">standard/incubator/documentation/manual/en/module_specs/Zend_Mail-UsingFileTransport.xml</a></li>
<li>standard/incubator/tests/Zend/Mail/_files/</li>
<li>standard/incubator/tests/Zend/Mail/_files/test.file/</li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="standardincubatordocumentationmanualenmodule_specsZend_MailUsingFileTransportxml"></a>
<div class="addfile"><h4>Added: standard/incubator/documentation/manual/en/module_specs/Zend_Mail-UsingFileTransport.xml (0 => 22890)</h4>
<pre class="diff"><span>
<span class="info">--- standard/incubator/documentation/manual/en/module_specs/Zend_Mail-UsingFileTransport.xml (rev 0)
+++ standard/incubator/documentation/manual/en/module_specs/Zend_Mail-UsingFileTransport.xml 2010-08-23 20:39:46 UTC (rev 22890) </span><span class="lines">@@ -0,0 +1,42 @@ </span><ins>+&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
+&lt;!-- Reviewed: no --&gt;
+&lt;sect1 id=&quot;zend.mail.file-transport&quot;&gt;
+ &lt;title&gt;Using File Transport&lt;/title&gt;
+
+ &lt;para&gt;
+ &lt;classname&gt;Zend_Mail_Transport_File&lt;/classname&gt; is useful in a
+ development environment or for testing purposes. Instead of sending any real
+ emails it simply dumps the email's body and headers to a file in the filesystem.
+ Like the other transports it may be configured using
+ &lt;classname&gt;Zend_Application_Resource_Mail&lt;/classname&gt; or passed to the
+ &lt;methodname&gt;send()&lt;/methodname&gt; method of a &lt;classname&gt;Zend_Mail&lt;/classname&gt; instance.
+ &lt;/para&gt;
+
+ &lt;para&gt;
+ The transport has two optional parameters that can be passed to the constructor or
+ via &lt;methodname&gt;setOptions()&lt;/methodname&gt; method. The &lt;property&gt;path&lt;/property&gt;
+ option specifies the base path where new files are saved. If nothing is set transport
+ tries to get the default system directory for temporary files calling
+ &lt;methodname&gt;sys_get_temp_dir&lt;/methodname&gt;. The second parameter,
+ &lt;property&gt;callback&lt;/property&gt;, defines what function is used to generate a
+ filename. As an example, assume we need to use recipient's email plus some
+ hash as the filename:
+ &lt;/para&gt;
+
+ &lt;programlisting language=&quot;php&quot;&gt;&lt;![CDATA[
+function recipientFilename($transport)
+{
+ return $transport-&gt;recipients . '_' . mt_rand() . '.tmp';
+}
+
+$mail = new Zend_Mail();
+$mail-&gt;addTo('somebody-***@public.gmane.org', 'Some Recipient');
+// build message...
+$tr = new Zend_Mail_Transport_File(array('callback' =&gt; 'recipientFilename'));
+$mail-&gt;send($tr);
+]]&gt;&lt;/programlisting&gt;
+
+ &lt;para&gt;
+ The resulting file will be something like &lt;filename&gt;somebody-***@public.gmane.org_1493362665.tmp&lt;/filename&gt;
+ &lt;/para&gt;
+&lt;/sect1&gt;
</ins><span class="cx">\ No newline at end of file
</span></span></pre></div>
<a id="standardincubatorlibraryZendMailTransportFilephp"></a>
<div class="modfile"><h4>Modified: standard/incubator/library/Zend/Mail/Transport/File.php (22889 => 22890)</h4>
<pre class="diff"><span>
<span class="info">--- standard/incubator/library/Zend/Mail/Transport/File.php 2010-08-23 20:00:50 UTC (rev 22889)
+++ standard/incubator/library/Zend/Mail/Transport/File.php 2010-08-23 20:39:46 UTC (rev 22890) </span><span class="lines">@@ -47,7 +47,7 @@ </span><span class="cx"> protected $_path; </span><span class="cx"> </span><span class="cx"> /** </span><del>- * A callback function generating a file name </del><ins>+ * Callback function generating a file name </ins><span class="cx"> * </span><span class="cx"> * @var string|array </span><span class="cx"> */ </span><span class="lines">@@ -67,12 +67,12 @@ </span><span class="cx"> $options = array(); </span><span class="cx"> } </span><span class="cx"> </span><del>- // Make sure we have some defaults to work with </del><ins>+ // Making sure we have some defaults to work with </ins><span class="cx"> if (!isset($options['path'])) { </span><span class="cx"> $options['path'] = sys_get_temp_dir(); </span><span class="cx"> } </span><span class="cx"> if (!isset($options['callback'])) { </span><del>- $options['callback'] = array($this,'defaultCallback'); </del><ins>+ $options['callback'] = array($this, 'defaultCallback'); </ins><span class="cx"> } </span><span class="cx"> </span><span class="cx"> $this-&gt;setOptions($options);
</span><span class="lines">@@ -126,11 +126,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Returns the default generating file names
</del><ins>+ * Default callback for generating filenames
</ins><span class="cx"> *
</span><ins>+ * @param Zend_Mail_Transport_File File transport instance
</ins><span class="cx"> * @return string
</span><span class="cx"> */
</span><del>- public function defaultCallback($transport) {
- return 'ZendMail_' . time() . '_' . mt_rand() . '.eml';
</del><ins>+ public function defaultCallback($transport)
+ {
+ return 'ZendMail_' . time() . '_' . mt_rand() . '.tmp';
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">\ No newline at end of file
</span></span></pre></div>
<a id="standardincubatortestsZendMailFileTestphp"></a>
<div class="modfile"><h4>Modified: standard/incubator/tests/Zend/Mail/FileTest.php (22889 => 22890)</h4>
<pre class="diff"><span>
<span class="info">--- standard/incubator/tests/Zend/Mail/FileTest.php 2010-08-23 20:00:50 UTC (rev 22889)
+++ standard/incubator/tests/Zend/Mail/FileTest.php 2010-08-23 20:39:46 UTC (rev 22890)
</span><span class="lines">@@ -21,26 +21,12 @@
</span><span class="cx"> */
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Test helper
</del><ins>+ * @namespace
</ins><span class="cx"> */
</span><del>-require_once dirname(dirname(__FILE__)) . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'TestHelper.php';
</del><ins>+namespace ZendTest\Mail;
+use Zend\Mail;
</ins><span class="cx">
</span><span class="cx"> /**
</span><del>- * Zend_Mail
- */
-require_once 'Zend/Mail.php';
-
-/**
- * Zend_Mail_Transport_File
- */
-require_once 'Zend/Mail/Transport/File.php';
-
-/**
- * PHPUnit test case
- */
-require_once 'PHPUnit/Framework/TestCase.php';
-
-/**
</del><span class="cx"> * @category Zend
</span><span class="cx"> * @package Zend_Mail
</span><span class="cx"> * @subpackage UnitTests
</span><span class="lines">@@ -48,7 +34,7 @@
</span><span class="cx"> * @license http://framework.zend.com/license/new-bsd New BSD License
</span><span class="cx"> * @group Zend_Mail
</span><span class="cx"> */
</span><del>-class Zend_Mail_FileTest extends PHPUnit_Framework_TestCase
</del><ins>+class FileTest extends \PHPUnit_Framework_TestCase
</ins><span class="cx"> {
</span><span class="cx"> protected $_params;
</span><span class="cx"> protected $_transport;
</span><span class="lines">@@ -92,24 +78,24 @@
</span><span class="lines">@@ Diff output truncated at 4096 characters. @@
</span></span></pre>
</div>
</div>

</body>
</html>

Loading...