svn: /pear/peardoc/trunk/en/package/mail/mail-mime/ addhtmlimage.xml

alec                                     Sun, 30 Oct 2011 06:54:49 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=318570

Log:
- Fixed bug #18922: $content_id parameter not documented for Mail_Mime::addHTMLImage() function

Bug: http://pear.php.net/bugs/18922 (unknown)
     
Changed paths:
    U   pear/peardoc/trunk/en/package/mail/mail-mime/addhtmlimage.xml

Modified: pear/peardoc/trunk/en/package/mail/mail-mime/addhtmlimage.xml
===================================================================
--- pear/peardoc/trunk/en/package/mail/mail-mime/addhtmlimage.xml 2011-10-30 06:28:24 UTC (rev 318569)
+++ pear/peardoc/trunk/en/package/mail/mail-mime/addhtmlimage.xml 2011-10-30 06:54:49 UTC (rev 318570)
@@ -26,6 +26,10 @@
       boolean <parameter>$isfile</parameter>
       <initializer>true</initializer>
      </paramdef>
+     <paramdef choice="opt">
+      string <parameter>$content_id</parameter>
+      <initializer>&null;</initializer>
+     </paramdef>
     </funcprototype>
     </funcsynopsis>
    </refsynopsisdiv>
@@ -64,6 +68,15 @@
         is a filename or not.
        </para>
       </listitem>
+      <listitem>
+       <para>
+        <parameter>string $content_id</parameter> - The Content-ID value to use
+        for the embedded image. A &null; value will generate a suitably unique Content-ID.
+        When referencing the embedded image with an <img> tag, set
+        the &guot;src&guot; attribute to be &guot;cid:whatever&guot;, where
+        &guot;whatever&guot; is the Content-ID.
+       </para>
+      </listitem>
      </itemizedlist>
     </para>
    </refsection>


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