Sfoglia il codice sorgente

[DOCUMENTATION] English:

- manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@17503 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 16 anni fa
parent
commit
090df364d1

+ 26 - 11
documentation/manual/en/module_specs/Zend_Mail-AddingRecipients.xml

@@ -2,30 +2,45 @@
 <!-- Reviewed: no -->
 <!-- Reviewed: no -->
 <sect1 id="zend.mail.adding-recipients">
 <sect1 id="zend.mail.adding-recipients">
     <title>Adding Recipients</title>
     <title>Adding Recipients</title>
+
     <para>
     <para>
         Recipients can be added in three ways:
         Recipients can be added in three ways:
-        <itemizedlist>
+    </para>
+
+    <itemizedlist>
         <listitem>
         <listitem>
-        <para><methodname>addTo()</methodname>: Adds a recipient to the mail with a "To" header</para>
+            <para>
+                <methodname>addTo()</methodname>: Adds a recipient to the mail with a "To" header
+            </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
-        <para><methodname>addCc()</methodname>: Adds a recipient to the mail with a "Cc" header</para>
+            <para>
+                <methodname>addCc()</methodname>: Adds a recipient to the mail with a "Cc" header
+            </para>
         </listitem>
         </listitem>
+
         <listitem>
         <listitem>
-        <para><methodname>addBcc()</methodname>: Adds a recipient to the mail not visible in the header.</para>
+            <para>
+                <methodname>addBcc()</methodname>: Adds a recipient to the mail not visible in the
+                header
+            </para>
         </listitem>
         </listitem>
-        </itemizedlist>
-    </para>
+    </itemizedlist>
+
     <para>
     <para>
-        <methodname>getRecipients()</methodname> serves list of the recipients. <methodname>clearRecipients()</methodname>
-        clears the list.
+        <methodname>getRecipients()</methodname> serves list of the recipients.
+        <methodname>clearRecipients()</methodname> clears the list.
     </para>
     </para>
+
     <note>
     <note>
         <title>Additional parameter</title>
         <title>Additional parameter</title>
+
         <para>
         <para>
-            <methodname>addTo()</methodname> and <methodname>addCc()</methodname> accept a second optional parameter that is used as a
-            human-readable name of the recipient for the header. Double quotation is changed to
-            single quotation and angle brackets to square brackets in the parameter.
+            <methodname>addTo()</methodname> and <methodname>addCc()</methodname> accept a second
+            optional parameter that is used as a human-readable name of the recipient for the
+            header. Double quotation is changed to single quotation and angle brackets to square
+            brackets in the parameter.
         </para>
         </para>
     </note>
     </note>
 </sect1>
 </sect1>

+ 10 - 6
documentation/manual/en/module_specs/Zend_Mail-AdditionalHeaders.xml

@@ -2,11 +2,13 @@
 <!-- Reviewed: no -->
 <!-- Reviewed: no -->
 <sect1 id="zend.mail.additional-headers">
 <sect1 id="zend.mail.additional-headers">
     <title>Additional Headers</title>
     <title>Additional Headers</title>
+
     <para>
     <para>
-        Arbitrary mail headers can be set by using the <methodname>addHeader()</methodname> method. It requires two
-        parameters containing the name and the value of the header field. A third optional parameter determines
-        if the header should have only one or multiple values:
+        Arbitrary mail headers can be set by using the <methodname>addHeader()</methodname> method.
+        It requires two parameters containing the name and the value of the header field. A third
+        optional parameter determines if the header should have only one or multiple values:
     </para>
     </para>
+
     <example id="zend.mail.additional-headers.example-1">
     <example id="zend.mail.additional-headers.example-1">
         <title>Adding E-Mail Message Headers</title>
         <title>Adding E-Mail Message Headers</title>
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[
@@ -17,9 +19,11 @@ $mail->addHeader('X-greetingsTo', 'Dad', true);
 ]]></programlisting>
 ]]></programlisting>
     </example>
     </example>
 
 
-    <para>To set the Reply-To: header there exists the function <methodname>setReplyTo($email, $name=null)</methodname>,
-        because it requires additional special escaping of the different parts (email and name).</para>
-
+    <para>
+        To set the Reply-To: header there exists the function
+        <methodname>setReplyTo($email, $name=null)</methodname>, because it requires additional
+        special escaping of the different parts (email and name).
+    </para>
 </sect1>
 </sect1>
 <!--
 <!--
 vim:se ts=4 sw=4 et:
 vim:se ts=4 sw=4 et:

+ 19 - 8
documentation/manual/en/module_specs/Zend_Mail-Attachments.xml

@@ -2,14 +2,19 @@
 <!-- Reviewed: no -->
 <!-- Reviewed: no -->
 <sect1 id="zend.mail.attachments">
 <sect1 id="zend.mail.attachments">
     <title>Attachments</title>
     <title>Attachments</title>
+
     <para>
     <para>
-        Files can be attached to an e-mail using the <methodname>createAttachment()</methodname> method. The default behavior
-        of <classname>Zend_Mail</classname> is to assume the attachment is a binary object (application/octet-stream),
-        that it should be transferred with base64 encoding, and that it is handled as an attachment. These assumptions can be
-        overridden by passing more parameters to <methodname>createAttachment()</methodname>:
+        Files can be attached to an e-mail using the <methodname>createAttachment()</methodname>
+        method. The default behavior of <classname>Zend_Mail</classname> is to assume the
+        attachment is a binary object (<property>application/octet-stream</property>), that it
+        should be transferred with base64 encoding, and that it is handled as an attachment. These
+        assumptions can be overridden by passing more parameters to
+        <methodname>createAttachment()</methodname>:
     </para>
     </para>
+
     <example id="zend.mail.attachments.example-1">
     <example id="zend.mail.attachments.example-1">
         <title>E-Mail Messages with Attachments</title>
         <title>E-Mail Messages with Attachments</title>
+
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[
 $mail = new Zend_Mail();
 $mail = new Zend_Mail();
 // build message...
 // build message...
@@ -20,11 +25,14 @@ $mail->createAttachment($myImage,
                         Zend_Mime::ENCODING_8BIT);
                         Zend_Mime::ENCODING_8BIT);
 ]]></programlisting>
 ]]></programlisting>
     </example>
     </example>
+
     <para>
     <para>
-        If you want more control over the <acronym>MIME</acronym> part generated for this attachment you can use the return value
-        of <methodname>createAttachment()</methodname> to modify its attributes. The <methodname>createAttachment()</methodname> method
-        returns a <classname>Zend_Mime_Part</classname> object:
+        If you want more control over the <acronym>MIME</acronym> part generated for this
+        attachment you can use the return value of <methodname>createAttachment()</methodname> to
+        modify its attributes. The <methodname>createAttachment()</methodname> method returns a
+        <classname>Zend_Mime_Part</classname> object:
     </para>
     </para>
+
     <programlisting language="php"><![CDATA[
     <programlisting language="php"><![CDATA[
 $mail = new Zend_Mail();
 $mail = new Zend_Mail();
 
 
@@ -36,9 +44,12 @@ $at->filename    = 'test.gif';
 
 
 $mail->send();
 $mail->send();
 ]]></programlisting>
 ]]></programlisting>
+
     <para>
     <para>
-        An alternative is to create an instance of <classname>Zend_Mime_Part</classname> and add it with <methodname>addAttachment()</methodname>:
+        An alternative is to create an instance of <classname>Zend_Mime_Part</classname> and add it
+        with <methodname>addAttachment()</methodname>:
     </para>
     </para>
+
     <programlisting language="php"><![CDATA[
     <programlisting language="php"><![CDATA[
 $mail = new Zend_Mail();
 $mail = new Zend_Mail();
 
 

+ 6 - 3
documentation/manual/en/module_specs/Zend_Mail-Boundary.xml

@@ -2,11 +2,14 @@
 <!-- Reviewed: no -->
 <!-- Reviewed: no -->
 <sect1 id="zend.mail.boundary">
 <sect1 id="zend.mail.boundary">
     <title>Controlling the MIME Boundary</title>
     <title>Controlling the MIME Boundary</title>
+
     <para>
     <para>
-        In a multipart message, a <acronym>MIME</acronym> boundary for separating the different parts of the message is normally
-        generated at random. In some cases, however, you might want to specify the <acronym>MIME</acronym> boundary that is used.
-        This can be done using the <methodname>setMimeBoundary()</methodname> method, as in the following example:
+        In a multipart message, a <acronym>MIME</acronym> boundary for separating the different
+        parts of the message is normally generated at random. In some cases, however, you might
+        want to specify the <acronym>MIME</acronym> boundary that is used. This can be done using
+        the <methodname>setMimeBoundary()</methodname> method, as in the following example:
     </para>
     </para>
+
     <example id="zend.mail.boundary.example-1">
     <example id="zend.mail.boundary.example-1">
         <title>Changing the MIME Boundary</title>
         <title>Changing the MIME Boundary</title>
         <programlisting language="php"><![CDATA[
         <programlisting language="php"><![CDATA[