cvs: peardoc /en/package/mail/mail factory.xml intro.xml send.xml
[email protected] ("Ken Guest")
| Newsgroups | php.pear.doc |
|---|---|
| Message-ID | <cvskguest1199470766@cvsserver> |
kguest Fri Jan 4 18:19:26 2008 UTC
Modified files:
/peardoc/en/package/mail/mail factory.xml intro.xml send.xml
Log:
some minor corrections regarding grammar and readability
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail/factory.xml?r1=1.8&r2=1.9&diff_format=u
Index: peardoc/en/package/mail/mail/factory.xml
diff -u peardoc/en/package/mail/mail/factory.xml:1.8 peardoc/en/package/mail/mail/factory.xml:1.9
--- peardoc/en/package/mail/mail/factory.xml:1.8 Sun Jul 16 11:58:33 2006
+++ peardoc/en/package/mail/mail/factory.xml Fri Jan 4 18:19:26 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
<refentry id="package.mail.mail.factory">
<refnamediv>
@@ -73,14 +73,14 @@
<para>
<parameter>$params["sendmail_path"]</parameter> -
The location of the sendmail program on the
- filesystem. Default is <parameter>/usr/bin/sendmail</parameter>
+ filesystem. Default is <parameter>/usr/bin/sendmail</parameter>.
</para>
</listitem>
<listitem>
<para>
<parameter>$params["sendmail_args"]</parameter> -
Additional parameters to pass to the sendmail. Default is
- <parameter>-i</parameter>
+ <parameter>-i</parameter>.
</para>
</listitem>
</itemizedlist>
@@ -93,20 +93,20 @@
<listitem>
<para>
<parameter>$params["host"]</parameter> - The server to connect.
- Default is <parameter>localhost</parameter>
+ Default is <parameter>localhost</parameter>.
</para>
</listitem>
<listitem>
<para>
<parameter>$params["port"]</parameter> - The port to connect.
- Default is <parameter>25</parameter>
+ Default is <parameter>25</parameter>.
</para>
</listitem>
<listitem>
<para>
<parameter>$params["auth"]</parameter> - Whether or not to use
SMTP authentication.
- Default is &false;
+ Default is &false;.
</para>
</listitem>
<listitem>
@@ -131,19 +131,19 @@
<listitem>
<para>
<parameter>$params["timeout"]</parameter> - The SMTP connection
- timeout. Default is &null; (no timeout)
+ timeout. Default is &null; (no timeout).
</para>
</listitem>
<listitem>
<para>
<parameter>$params["verp"]</parameter> - Whether to use VERP
- or not. Default is &false;
+ or not. Default is &false;.
</para>
</listitem>
<listitem>
<para>
<parameter>$params["debug"]</parameter> - Whether to enable SMTP
- debug mode or not. Default is &false;
+ debug mode or not. Default is &false;.
</para>
</listitem>
<listitem>
@@ -167,7 +167,7 @@
&title.returns;
<para>
<parameter>object</parameter> - a specific &class.mail; instance
- or a &class.pear-error; object, if fails
+ or a &class.pear-error; object on failure.
</para>
</refsect1>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail/intro.xml?r1=1.2&r2=1.3&diff_format=u
Index: peardoc/en/package/mail/mail/intro.xml
diff -u peardoc/en/package/mail/mail/intro.xml:1.2 peardoc/en/package/mail/mail/intro.xml:1.3
--- peardoc/en/package/mail/mail/intro.xml:1.2 Thu Nov 24 16:38:39 2005
+++ peardoc/en/package/mail/mail/intro.xml Fri Jan 4 18:19:26 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="package.mail.mail.intro">
<refnamediv>
<refname>Introduction</refname>
@@ -15,14 +15,14 @@
<para>
Create a new instance of a specific <classname>Mail</classname>-Backend
with the <link linkend="package.mail.mail.factory">
- <function>factory</function></link>-method.
+ <function>factory</function></link> method.
</para>
</listitem>
<listitem>
<simpara>Step 2</simpara>
<para>
- Send the mail using <link linkend="package.mail.mail.send">
- <function>send</function></link>.
+ Send the mail using <link linkend="package.mail.mail.send"> the
+ <function>send</function></link> method.
</para>
</listitem>
</itemizedlist>
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail/send.xml?r1=1.15&r2=1.16&diff_format=u
Index: peardoc/en/package/mail/mail/send.xml
diff -u peardoc/en/package/mail/mail/send.xml:1.15 peardoc/en/package/mail/mail/send.xml:1.16
--- peardoc/en/package/mail/mail/send.xml:1.15 Sun Jul 8 03:36:08 2007
+++ peardoc/en/package/mail/mail/send.xml Fri Jan 4 18:19:26 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.15 $ -->
+<!-- $Revision: 1.16 $ -->
<refentry id="package.mail.mail.send">
<refnamediv>
<refname>Mail::send()</refname>
@@ -20,7 +20,7 @@
<refsect1 id="package.mail.mail.send.desc">
&title.desc;
<para>
- Sends a mail. The <function>send</function>-function is
+ Sends a mail. The <function>send</function> method is
provided by the object returned from
<link linkend="package.mail.mail.factory"><function>factory</function>
</link>
@@ -59,7 +59,7 @@
&title.returns;
<para>
<parameter>boolean</parameter> - &true; or
- a &class.pear-error; object, if fails
+ a &class.pear-error; object on failure.
</para>
</refsect1>
<refsect1 id="package.mail.mail.send.throws">
@@ -103,12 +103,12 @@
</entry>
<entry>
The from entry in the <parameter>$headers</parameter> array
- contains one ore more characters which could be non-RFC compliant
+ contains one ore more characters which could be non-RFC compliant.
</entry>
<entry>
Check the given from address for characters like: spaces or
<literal>;</literal> or <literal>&</literal> or
- <literal>`</literal> (backtick)
+ <literal>`</literal> (backtick).
</entry>
</row>
<row>
@@ -142,7 +142,7 @@
Sendmail returns a error, which must be handled by use.
</entry>
<entry>
- See the documention of your mailer programm.
+ See the documention of your mailer program.
</entry>
</row>
<row>
@@ -152,7 +152,7 @@
<quote>Failed to create a Net_SMTP object</quote>
</entry>
<entry>
- Failure in class creation
+ Failure in class creation.
</entry>
<entry>
Reinstall/update the <classname>Net_SMTP</classname> package.
@@ -166,7 +166,7 @@
<parameter>host:port</parameter></quote>
</entry>
<entry>
- Connect to SMTP server failed
+ Connect to SMTP server failed.
</entry>
<entry>
Check <parameter>$param['port']</parameter> and
@@ -182,7 +182,7 @@
<quote><parameter>method</parameter> authentication failure</quote>
</entry>
<entry>
- Authentication failed
+ Authentication failed.
</entry>
<entry>
Check <parameter>$param['auth']</parameter>,
@@ -218,7 +218,7 @@
<quote>Failed to set sender: <parameter>from</parameter></quote>
</entry>
<entry>
- Setting the sender address failed
+ Setting the sender address failed.
</entry>
<entry>
Check the RFC-compliances of the sender address and the server
@@ -233,7 +233,7 @@
</quote>
</entry>
<entry>
- Sending of recipient address failed
+ Sending of recipient address failed.
</entry>
<entry>
Check the RFC-compliances of the recipient address and the server