svn: /pear/peardoc/trunk/en/package/mail/ mail-mime/addattachment.xml mail-mime/example.xml mail-mime/get.xml mail-mime/headers.xml mail-mime/mail-mime.xml mail-mime.xml mail-mimepart/addsubpart.xml mail-mimepart/encode.xml mail-mimepart/encodetofile.xml mail-mimepart/mail-mimepart.xml

Modified: pear/peardoc/trunk/en/package/mail/mail-mime/addattachment.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mime/addattachment.xml	2011-04-08 12:09:59 UTC (rev 310064)
+++ pear/peardoc/trunk/en/package/mail/mail-mime/addattachment.xml	2011-04-08 13:03:33 UTC (rev 310065)
@@ -11,20 +11,45 @@
      </funcsynopsisinfo>
     <funcprototype>
      <funcdef>boolean <function>addAttachment</function></funcdef>
-     <paramdef choice="req">string <parameter>$file</parameter></paramdef>
-     <paramdef choice="opt">
-      string <parameter>
-       $c_type = 'application/octet-stream'</parameter>
+     <paramdef choice="req">string
+      <parameter>$file</parameter>
      </paramdef>
-     <paramdef choice="opt">string <parameter>
-       $name = ''</parameter>
+     <paramdef choice="opt">string
+      <parameter>$c_type = 'application/octet-stream'</parameter>
      </paramdef>
-     <paramdef choice="opt">boolean <parameter> $isfile</parameter>
-      <initializer>true</initializer>
+     <paramdef choice="opt">string
+      <parameter>$name = ''</parameter>
      </paramdef>
-     <paramdef choice="opt">string <parameter>
-       $encoding = 'base64'</parameter>
+     <paramdef choice="opt">boolean
+      <parameter> $isfile = true</parameter>
      </paramdef>
+     <paramdef choice="opt">string
+      <parameter>$encoding = 'base64'</parameter>
+     </paramdef>
+     <paramdef choice="opt">string
+      <parameter>$disposition = 'attachment'</parameter>
+     </paramdef>
+     <paramdef choice="opt">string
+      <parameter>$charset = ''</parameter>
+     </paramdef>
+     <paramdef choice="opt">string
+      <parameter>$language = ''</parameter>
+     </paramdef>
+     <paramdef choice="opt">string
+      <parameter>$location = ''</parameter>
+     </paramdef>
+     <paramdef choice="opt">string
+      <parameter>$n_encoding = null</parameter>
+     </paramdef>
+     <paramdef choice="opt">string
+      <parameter>$f_encoding = null</parameter>
+     </paramdef>
+     <paramdef choice="opt">string
+      <parameter>$description = ''</parameter>
+     </paramdef>
+     <paramdef choice="opt">string
+      <parameter>$h_charset = null</parameter>
+     </paramdef>
     </funcprototype>
     </funcsynopsis>
    </refsynopsisdiv>
@@ -68,7 +93,52 @@
         (eg. scripts/html etc.) this could be given as
         <quote>quoted-printable</quote>.
        </para>
+      <listitem>
+       <para>
+        <parameter>string $disposition</parameter> - The content-disposition of this file
+         Defaults to attachment. Possible values: attachment, inline.
+       </para>
       </listitem>
+      <listitem>
+       <para>
+        <parameter>string $charset</parameter> - The character set of attachment's content.
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        <parameter>string $language</parameter> - The language of the attachment
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        <parameter>string $location</parameter> - The RFC 2557.4 location of the attachment
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        <parameter>string $n_encoding</parameter> - Encoding of the attachment's name in Content-Type
+         By default filenames are encoded using RFC2231 method
+         Here you can set RFC2047 encoding (quoted-printable or base64) instead.
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        <parameter>string $f_encoding</parameter> - Encoding of the attachment's filename
+         in Content-Disposition header.
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        <parameter>string $description</parameter> - Content-Description header.
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        <parameter>string $h_charset</parameter> - The character set of the headers e.g. filename
+         If not specified, $charset will be used
+       </para>
+      </listitem>
+      </listitem>
      </itemizedlist>
     </para>
    </refsection>
@@ -129,4 +199,4 @@
     &title.note;
     &note.notstatic;
    </refsection>
-  </refentry>
\ No newline at end of file
+  </refentry>

Modified: pear/peardoc/trunk/en/package/mail/mail-mime/example.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mime/example.xml	2011-04-08 12:09:59 UTC (rev 310064)
+++ pear/peardoc/trunk/en/package/mail/mail-mime/example.xml	2011-04-08 13:03:33 UTC (rev 310065)
@@ -22,7 +22,7 @@
               'Subject' => 'Test mime message'
               );

-$mime = new Mail_mime($crlf);
+$mime = new Mail_mime(array('eol' => $crlf));

 $mime->setTXTBody($text);
 $mime->setHTMLBody($html);
@@ -42,6 +42,5 @@
 ?>
     ]]>
    </programlisting>
-
-   </refsection>
+   </refsection>
   </refentry>

Modified: pear/peardoc/trunk/en/package/mail/mail-mime/get.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mime/get.xml	2011-04-08 12:09:59 UTC (rev 310064)
+++ pear/peardoc/trunk/en/package/mail/mail-mime/get.xml	2011-04-08 13:03:33 UTC (rev 310065)
@@ -14,6 +14,12 @@
       <paramdef choice="opt">array <parameter>$param</parameter>
        <initializer>null</initializer>
       </paramdef>
+      <paramdef choice="opt">resource <parameter>$filename</parameter>
+       <initializer>null</initializer>
+      </paramdef>
+      <paramdef choice="opt">boolean <parameter>$skip_head</parameter>
+       <initializer>false</initializer>
+      </paramdef>
      </funcprototype>
     </funcsynopsis>
    </refsynopsisdiv>
@@ -38,6 +44,17 @@
         See <link linkend="package.mail.mail-mime.mail-mime">constructor</link> parameters list.
        </para>
       </listitem>
+      <listitem>
+       <para>
+        <parameter>resource $filename</parameter> - Optional output file where to save the message
+        instead of returning it.
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        <parameter>boolean $skip_head</parameter> - True if you want to return/save only the message without headers.
+       </para>
+      </listitem>
      </itemizedlist>
     </para>
    </refsection>

Modified: pear/peardoc/trunk/en/package/mail/mail-mime/headers.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mime/headers.xml	2011-04-08 12:09:59 UTC (rev 310064)
+++ pear/peardoc/trunk/en/package/mail/mail-mime/headers.xml	2011-04-08 13:03:33 UTC (rev 310065)
@@ -11,12 +11,15 @@
    </funcsynopsisinfo>
    <funcprototype>
     <funcdef>array <function>&amp;headers</function></funcdef>
-    <paramdef choice="opt">array <parameter>$headerEx</parameter>
+    <paramdef choice="opt">array <parameter>$xtra_headers</parameter>
      <initializer>null</initializer>
     </paramdef>
     <paramdef choice="opt">boolean <parameter>$overwrite</parameter>
      <initializer>false</initializer>
     </paramdef>
+    <paramdef choice="opt">boolean <parameter>$skip_content</parameter>
+     <initializer>false</initializer>
+    </paramdef>
    </funcprototype>
   </funcsynopsis>
  </refsynopsisdiv>
@@ -37,22 +40,26 @@
    <itemizedlist>
     <listitem>
      <para>
-      &type.array; <parameter>$headerEx</parameter>
+      &type.array; <parameter>$xtra_headers</parameter>
       - Additional headers,
       the format of the argument is <parameter>$array["header-name"]</parameter> =
       <quote>header-value</quote>
      </para>
     </listitem>
-
     <listitem>
      <para>
       &type.bool; <parameter>$overwrite</parameter>
       - Overwrite already existing headers.
-
       When &false;,
       the values already set are kept.
      </para>
     </listitem>
+    <listitem>
+     <para>
+      &type.bool; <parameter>$skip_content</parameter>
+      Don't return content headers: Content-Type, Content-Disposition and Content-Transfer-Encoding.
+     </para>
+    </listitem>
    </itemizedlist>
   </para>
  </refsection>

Modified: pear/peardoc/trunk/en/package/mail/mail-mime/mail-mime.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mime/mail-mime.xml	2011-04-08 12:09:59 UTC (rev 310064)
+++ pear/peardoc/trunk/en/package/mail/mail-mime/mail-mime.xml	2011-04-08 13:03:33 UTC (rev 310065)
@@ -8,7 +8,7 @@
     <funcsynopsis>
      <funcsynopsisinfo>
       require_once 'Mail/mime.php';
-     </funcsynopsisinfo>
+     </funcsynopsisinfo>
      <funcprototype>
       <funcdef>Mail_mime <function>Mail_mime</function></funcdef>
       <paramdef choice="opt">
@@ -22,7 +22,7 @@
     <para>
      Creates a new instance of <classname>Mail_Mime</classname>
     </para>
-   </refsection>
+   </refsection>
    <refsection xml:id="package.mail.mail-mime.mail-mime.parameter">
     &title.param;
        <para>
@@ -92,15 +92,15 @@
      <link linkend="package.mail.mail"><classname>Mail</classname></link>
      then you have to set <parameter>eol</parameter> to
      <parameter>&quot;\n&quot;</parameter>.
-    </para>
+    </para>
     <para>
      For backward compatybility setting end of line string as constructor's
      first parameter is supported.
-    </para>
+    </para>
     <para>
      If you're working with big attachments, enabling 'delay_file_io' will
      provent from loading attachments into memory. Until you're not using
      getMessage* functions don't worry about PHP's memory limit.
     </para>
-   </refsection>
+   </refsection>
 </refentry>

Modified: pear/peardoc/trunk/en/package/mail/mail-mime.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mime.xml	2011-04-08 12:09:59 UTC (rev 310064)
+++ pear/peardoc/trunk/en/package/mail/mail-mime.xml	2011-04-08 13:03:33 UTC (rev 310065)
@@ -25,6 +25,7 @@
    &package.mail.mail-mimepart.mail-mimepart;
    &package.mail.mail-mimepart.addsubpart;
    &package.mail.mail-mimepart.encode;
+   &package.mail.mail-mimepart.encodetofile;
    &package.mail.mail-mime.example;
  </chapter>
 </book>

Modified: pear/peardoc/trunk/en/package/mail/mail-mimepart/addsubpart.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mimepart/addsubpart.xml	2011-04-08 12:09:59 UTC (rev 310064)
+++ pear/peardoc/trunk/en/package/mail/mail-mimepart/addsubpart.xml	2011-04-08 13:03:33 UTC (rev 310065)
@@ -8,11 +8,11 @@
     <funcsynopsis>
      <funcsynopsisinfo>
       require_once 'Mail/mimePart.php';
-     </funcsynopsisinfo>
+     </funcsynopsisinfo>
     <funcprototype>
      <funcdef>resource <function>&amp;addSubPart</function></funcdef>
      <paramdef choice="req">string <parameter>$body</parameter></paramdef>
-     <paramdef choice="req">array <parameter>$params</parameter></paramdef>
+     <paramdef choice="req">array <parameter>$params</parameter></paramdef>
     </funcprototype>
     </funcsynopsis>
    </refsynopsisdiv>
@@ -22,7 +22,7 @@
      Adds a sub part to the current MIME part and returns
      a reference to it
     </para>
-   </refsection>
+   </refsection>
    <refsection xml:id="package.mail.mail-mimepart.addsubpart.parameter">
     &title.param;
     <para>
@@ -40,25 +40,24 @@
         <link linkend="package.mail.mail-mimepart.mail-mimepart.parameter">
           constructor</link> for the possible values.
        </para>
-      </listitem>
+      </listitem>
      </itemizedlist>
     </para>
-   </refsection>
+   </refsection>
    <refsection xml:id="package.mail.mail-mimepart.addsubpart.return">
     &title.returns;
     <para>
      <parameter>resource</parameter> -
      a reference to the added part
     </para>
-   </refsection>
+   </refsection>
    <refsection xml:id="package.mail.mail-mimepart.addsubpart.note">
     &title.note;
     &note.notstatic;
-   </refsection>
+   </refsection>
    <refsection xml:id="package.mail.mail-mimepart.addsubpart.example">
     &title.example;
     <example><info><title>Add two attachments to a mail</title></info>
-
       <programlisting role="php">
        <![CDATA[
 <?php
@@ -96,7 +95,7 @@
 ...
 ?>
     ]]>
-     </programlisting>
+     </programlisting>
     </example>
-   </refsection>
+   </refsection>
   </refentry>

Modified: pear/peardoc/trunk/en/package/mail/mail-mimepart/encode.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mimepart/encode.xml	2011-04-08 12:09:59 UTC (rev 310064)
+++ pear/peardoc/trunk/en/package/mail/mail-mimepart/encode.xml	2011-04-08 13:03:33 UTC (rev 310065)
@@ -8,10 +8,12 @@
     <funcsynopsis>
      <funcsynopsisinfo>
       require_once 'Mail/mimePart.php';
-     </funcsynopsisinfo>
+     </funcsynopsisinfo>
      <funcprototype>
       <funcdef>array <function>encode</function></funcdef>
-      <paramdef choice="req"/>
+      <paramdef choice="opt">string
+       <parameter>$boundary = null</parameter>
+      </paramdef>
      </funcprototype>
     </funcsynopsis>
    </refsynopsisdiv>
@@ -20,14 +22,27 @@
     <para>
      Encodes and returns the email
     </para>
-   </refsection>
+   </refsection>
+   <refsection xml:id="package.mail.mail-mimepart.encode.parameter">
+   &title.param;
+    <para>
+     <itemizedlist>
+      <listitem>
+       <para>
+        <parameter>string $boundary</parameter> -
+        Optional pre-defined boundary string
+       </para>
+      </listitem>
+     </itemizedlist>
+    </para>
+   </refsection>
    <refsection xml:id="package.mail.mail-mimepart.encode.return">
     &title.returns;
     <para>
      <parameter>array</parameter> -
      an associative array containing two elements,
      body and headers. The headers element is itself
-     an indexed array.
+     an indexed array.
     </para>
     <para>
      The key names are
@@ -39,12 +54,12 @@
       <member>
        <parameter>'body'</parameter> -
        a string with the mail body
-      </member>
+      </member>
      </simplelist>
     </para>
-   </refsection>
+   </refsection>
    <refsection xml:id="package.mail.mail-mimepart.encode.note">
     &title.note;
     &note.notstatic;
-   </refsection>
+   </refsection>
   </refentry>

Added: pear/peardoc/trunk/en/package/mail/mail-mimepart/encodetofile.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mimepart/encodetofile.xml	                        (rev 0)
+++ pear/peardoc/trunk/en/package/mail/mail-mimepart/encodetofile.xml	2011-04-08 13:03:33 UTC (rev 310065)
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.mail.mail-mimepart.encodetofile">
+   <refnamediv>
+    <refname>Mail_mimePart::encodeToFile()</refname>
+    <refpurpose>encode a mail</refpurpose>
+   </refnamediv>
+   <refsynopsisdiv>
+    <funcsynopsis>
+     <funcsynopsisinfo>
+      require_once 'Mail/mimePart.php';
+     </funcsynopsisinfo>
+     <funcprototype>
+      <funcdef>array <function>encodeToFile</function></funcdef>
+       <paramdef choice="req">string
+        <parameter>$filename</parameter>
+       </paramdef>
+       <paramdef choice="opt">string
+        <parameter>$boundary = null</parameter>
+       </paramdef>
+       <paramdef choice="opt">boolean
+        <parameter>$skip_head = false</parameter>
+       </paramdef>
+     </funcprototype>
+    </funcsynopsis>
+   </refsynopsisdiv>
+   <refsection xml:id="package.mail.mail-mimepart.encodetofile.desc">
+    &title.desc;
+    <para>
+     Encodes and saves the email into file. File must exist.
+     Data will be appended to the file
+    </para>
+   </refsection>
+   <refsection xml:id="package.mail.mail-mimepart.encodetofile.parameter">
+    &title.param;
+    <para>
+     <itemizedlist>
+      <listitem>
+       <para>
+        <parameter>string $filename</parameter> -
+        Output file location
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        <parameter>string $boundary</parameter> -
+        Optional pre-defined boundary string
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        <parameter>boolean $skip_head</parameter> -
+        True if you don't want to save headers
+       </para>
+      </listitem>
+     </itemizedlist>
+    </para>
+   </refsection>
+   <refsection xml:id="package.mail.mail-mimepart.encodetofile.return">
+    &title.returns;
+    <para>
+     <parameter>array</parameter> -
+     An associative array containing message headers or PEAR error object
+    </para>
+   </refsection>
+   <refsection xml:id="package.mail.mail-mimepart.encodetofile.note">
+    &title.note;
+    &note.notstatic;
+   </refsection>
+  </refentry>

Modified: pear/peardoc/trunk/en/package/mail/mail-mimepart/mail-mimepart.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mimepart/mail-mimepart.xml	2011-04-08 12:09:59 UTC (rev 310064)
+++ pear/peardoc/trunk/en/package/mail/mail-mimepart/mail-mimepart.xml	2011-04-08 13:03:33 UTC (rev 310065)
@@ -8,7 +8,7 @@
     <funcsynopsis>
      <funcsynopsisinfo>
       require_once 'Mail/mimePart.php';
-     </funcsynopsisinfo>
+     </funcsynopsisinfo>
      <funcprototype>
       <funcdef>Mail_mimePart <function>Mail_mimePart</function></funcdef>
       <paramdef choice="opt">string
@@ -16,7 +16,7 @@
       </paramdef>
       <paramdef choice="opt">array
        <parameter>$params = array()</parameter>
-      </paramdef>
+      </paramdef>
      </funcprototype>
     </funcsynopsis>
    </refsynopsisdiv>
@@ -25,7 +25,7 @@
     <para>
      Create a new <classname>Mail_mimePart</classname> object.
     </para>
-   </refsection>
+   </refsection>
    <refsection xml:id="package.mail.mail-mimepart.mail-mimepart.parameter">
     &title.param;
     <para>
@@ -61,41 +61,75 @@
            <parameter>$params["cid"]</parameter> -
            content ID to apply
           </para>
-         </listitem>
+         </listitem>
          <listitem>
           <para>
            <parameter>$params["disposition"]</parameter> -
            Content disposition <parameter>inline</parameter>
            or <parameter>attachment</parameter>
           </para>
-         </listitem>
+         </listitem>
          <listitem>
           <para>
-           <parameter>$params["dfilename"]</parameter> -
+           <parameter>$params["filename"]</parameter> -
            Optional filename parameter for content disposition
           </para>
-         </listitem>
+         </listitem>
          <listitem>
           <para>
            <parameter>$params["description"]</parameter> -
            Content description
           </para>
-         </listitem>
+         </listitem>
          <listitem>
           <para>
            <parameter>$params["charset"]</parameter> -
            Character set to use
           </para>
-         </listitem>
+         </listitem>
+         <listitem>
+          <para>
+           <parameter>$params["name_encoding"]</parameter> -
+           Encoding of the attachment name (Content-Type)
+           By default filenames are encoded using RFC2231
+           Here you can set RFC2047 encoding (quoted-printable
+           or base64) instead
+          </para>
+         </listitem>
+         <listitem>
+          <para>
+           <parameter>$params["filename_encoding"]</parameter> -
+           Encoding of the attachment filename (Content-Disposition)
+          </para>
+         </listitem>
+         <listitem>
+          <para>
+           <parameter>$params["headers_charset"]</parameter> -
+           Charset of the headers e.g. filename, description
+           If not set, "charset" will be used
+          </para>
+         </listitem>
+         <listitem>
+          <para>
+           <parameter>$params["eol"]</parameter> -
+           End of line sequence. Default: "\r\n"
+          </para>
+         </listitem>
+         <listitem>
+          <para>
+           <parameter>$params["body_file"]</parameter> -
+           Location of file with part's body (instead of $body)
+          </para>
+         </listitem>
         </itemizedlist>
         Default is an empty array.
        </para>
-      </listitem>
+      </listitem>
      </itemizedlist>
     </para>
-   </refsection>
+   </refsection>
    <refsection xml:id="package.mail.mail-mimepart.mail-mimepart.note">
     &title.note;
     &note.canstatic;
-   </refsection>
+   </refsection>
   </refentry>