PHPMailer::addEmbeddedImage( string $path, string $cid, string $name = '', string $encoding = self::ENCODING_BASE64, string $type = '', string $disposition = 'inline' ): bool

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$pathstring

Path to the attachment

$cidstring

Content ID of the attachment; Use this to reference the content when using an embedded image in HTML

$namestringoptional

Overrides the attachment filenameDefault: ''

$encodingstringoptional

File encoding (see $Encoding) defaults to base64Default: self::ENCODING_BASE64

$typestringoptional

File MIME type (by default mapped from the $path filename's extension)Default: ''

$dispositionstringoptional

Disposition to use: inline (default) or attachment (unlikely you want this – addAttachment() instead)Default: 'inline'

Return value

bool

True on successfully adding an attachment

Performance profile

How much work a call to PHPMailer::addEmbeddedImage() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

20–41

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 74.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 5 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost PHPMailer::addEmbeddedImage() can have, taken from its control-flow graph on PHP 8.5.

Uses · 8

• static::fileIsAccessible()
• \PHPMailer\PHPMailer\Exception::__construct()
• \PHPMailer\PHPMailer\PHPMailer::lang()
• static::filenameToType()
• \PHPMailer\PHPMailer\PHPMailer::validateEncoding()
• static::mb_pathinfo()
• \PHPMailer\PHPMailer\PHPMailer::setError()
• \PHPMailer\PHPMailer\PHPMailer::edebug()

Source code

View on Trac ↗View on GitHub ↗

4064    public function addEmbeddedImage(4065        $path,4066        $cid,4067        $name = '',4068        $encoding = self::ENCODING_BASE64,4069        $type = '',4070        $disposition = 'inline'4071    ) {4072        try {4073            if (!static::fileIsAccessible($path)) {4074                throw new Exception(self::lang('file_access') . $path, self::STOP_CONTINUE);4075            }4076 4077            //If a MIME type is not specified, try to work it out from the file name4078            if ('' === $type) {4079                $type = static::filenameToType($path);4080            }4081 4082            if (!$this->validateEncoding($encoding)) {4083                throw new Exception(self::lang('encoding') . $encoding);4084            }4085 4086            $filename = (string) static::mb_pathinfo($path, PATHINFO_BASENAME);4087            if ('' === $name) {4088                $name = $filename;4089            }4090 4091            //Append to $attachment array4092            $this->attachment[] = [4093                0 => $path,4094                1 => $filename,4095                2 => $name,4096                3 => $encoding,4097                4 => $type,4098                5 => false, //isStringAttachment4099                6 => $disposition,4100                7 => $cid,4101            ];4102        } catch (Exception $exc) {4103            $this->setError($exc->getMessage());4104            $this->edebug($exc->getMessage());4105            if ($this->exceptions) {4106                throw $exc;4107            }4108 4109            return false;4110        }4111 4112        return true;4113    }

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/PHPMailer/PHPMailer.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.