Package home | Report new bug | New search | Development Roadmap Status: Open | Feedback | All | Closed Since Version 1.10.12

Doc Bug #20518 The documentation for addHTMLImage() is wrong
Submitted: 2015-03-19 22:30 UTC
From: khorben Assigned:
Status: Open Package: Mail_Mime (version 1.8.9)
PHP Version: 5.4.38 OS: NetBSD
Roadmaps: (Not assigned)    
Subscription  


 [2015-03-19 22:30 UTC] khorben (Pierre Pronchery)
Description: ------------ The documentation for the addHTMLImage() method of the Mail_Mime class (see https://pear.php.net/manual/en/package.mail.mail-mime.addhtmlimage.php) wrongly says: "When referencing the embedded image with an <img> tag, set the "src" attribute to be "cid:whatever", where "whatever" is the Content-ID". It should say something along those lines instead: "When referencing embedded images in the HTML body, set the $name parameter (or $file if not set) and the path to the image to the same value. The HTML content will be automatically updated with the corresponding "cid:" URL (as found in "src", "background" and "href" attributes)." Likewise, the documentation for the "$name" parameter is wrong. This parameter is always used if set - and then must match the destination filename in the HTML body. I would change it to: "string $name - The filename of the image. It is required if $file contains the image data. If set, it must match the filename used in the HTML content."

Comments