[prev in list] [next in list] [prev in thread] [next in thread] 

List:       pear-doc
Subject:    [PEAR-DOC] cvs: peardoc /en/package/mail/mail-mime headers.xml
From:       "Christian Weiske" <cweiske () php ! net>
Date:       2008-03-03 22:25:35
Message-ID: cvscweiske1204583135 () cvsserver
[Download RAW message or body]

cweiske		Mon Mar  3 22:25:35 2008 UTC

  Modified files:              
    /peardoc/en/package/mail/mail-mime	headers.xml 
  Log:
  fix bug #12988: User note that is a documentation problem
  
  
http://cvs.php.net/viewvc.cgi/peardoc/en/package/mail/mail-mime/headers.xml?r1=1.2&r2=1.3&diff_format=u
                
Index: peardoc/en/package/mail/mail-mime/headers.xml
diff -u peardoc/en/package/mail/mail-mime/headers.xml:1.2 \
                peardoc/en/package/mail/mail-mime/headers.xml:1.3
--- peardoc/en/package/mail/mail-mime/headers.xml:1.2	Thu Apr 14 14:06:21 2005
+++ peardoc/en/package/mail/mail-mime/headers.xml	Mon Mar  3 22:25:35 2008
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <refentry id="package.mail.mail-mime.headers">
    <refnamediv>
     <refname>Mail_Mime::headers()</refname>
@@ -8,12 +8,13 @@
     <funcsynopsis>
      <funcsynopsisinfo>
       require_once 'Mail/mime.php';
-     </funcsynopsisinfo>      
+     </funcsynopsisinfo>
     <funcprototype>
      <funcdef>array <function>&amp;headers</function></funcdef>
      <paramdef>array <parameter><optional>$headerEx = \
&null;</optional></parameter></paramdef> +     <paramdef>boolean \
<parameter><optional>$overwrite = &false;</optional></parameter></paramdef>  \
                </funcprototype>
-    </funcsynopsis>    
+    </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 id="package.mail.mail-mime.headers.desc">
     &title.desc;
@@ -24,7 +25,7 @@
       linkend="package.mail.mail-mime.get"><function>get</function>
      </link> has to be called before calling <function>headers</function>.
     </para>
-   </refsect1>   
+   </refsect1>
    <refsect1 id="package.mail.mail-mime.headers.parameter">
     &title.param;
     <para>
@@ -32,35 +33,42 @@
       <listitem>
        <para>
         <parameter>array $headerEx</parameter> - Additional headers, the
-        format of the argument is <parameter>$array["header-name"]</parameter> = 
+        format of the argument is <parameter>$array["header-name"]</parameter> =
           <quote>header-value</quote>
        </para>
       </listitem>
+
+      <listitem>
+       <para>
+        <parameter>boolean $overwrite</parameter> - Overwrite already
+        existing headers. When &false;, the values already set are kept.
+       </para>
+      </listitem>
      </itemizedlist>
     </para>
-   </refsect1>   
+   </refsect1>
    <refsect1 id="package.mail.mail-mime.headers.return">
     &title.returns;
     <para>
-     <parameter>array</parameter> - 
-     an associative array with the mime headers 
+     <parameter>array</parameter> -
+     an associative array with the mime headers
      and the additional headers. The return value can directly passed to
-     the second parameter of 
+     the second parameter of
      <link
          linkend="package.mail.mail.send"><function>Mail::send</function></link>.
     </para>
-   </refsect1>      
+   </refsect1>
    <refsect1 id="package.mail.mail-mime.headers.note">
     &title.note;
     &note.notstatic;
     <warning>
      <para>
       <function>Mail_Mime::headers</function> has to be called
-      <emphasis>after</emphasis> 
+      <emphasis>after</emphasis>
       <link linkend="package.mail.mail-mime.get"><function>Mail_Mime::get</function></link>.
  </para>
    </warning>
-   </refsect1>      
+   </refsect1>
    <refsect1 id="package.mail.mail-mime.headers.see">
     &title.see;
     <para>
@@ -68,7 +76,7 @@
       <function>Mail_Mime::get</function>
      </link>
     </para>
-   </refsect1>            
+   </refsect1>
   </refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
@@ -88,4 +96,4 @@
 vim600: syn=xml fen fdm=syntax fdl=2 si
 vim: et tw=78 syn=sgml
 vi: ts=1 sw=1
--->  
+-->



-- 
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php


[prev in list] [next in list] [prev in thread] [next in thread]