PHPMailer::createBody(): string

Description

Compatibility

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

Return value

string

The assembled message body

Performance profile

How much work a call to PHPMailer::createBody() 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

Heavy

Reads or writes the filesystem via file_put_contents().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

51–261

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

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 it touches

• filesystemfilesystem accessfile_put_contents()called directly

What one call costs · 132 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 15

• stripos()
• \PHPMailer\PHPMailer\PHPMailer::setBoundaries()
• \PHPMailer\PHPMailer\PHPMailer::setWordWrap()
• \PHPMailer\PHPMailer\PHPMailer::has8bitChars()
• static::hasLineLongerThanMax()
• \PHPMailer\PHPMailer\PHPMailer::getMailMIME()
• \PHPMailer\PHPMailer\PHPMailer::getBoundary()
• \PHPMailer\PHPMailer\PHPMailer::encodeString()
• \PHPMailer\PHPMailer\PHPMailer::attachAll()
• \PHPMailer\PHPMailer\PHPMailer::textLine()
• \PHPMailer\PHPMailer\PHPMailer::headerLine()
• \PHPMailer\PHPMailer\PHPMailer::endBoundary()

Source code

View on Trac ↗View on GitHub ↗

2985    public function createBody()2986    {2987        $body = '';2988        //Create unique IDs and preset boundaries2989        $this->setBoundaries();2990 2991        $this->setWordWrap();2992 2993        $bodyEncoding = $this->Encoding;2994        $bodyCharSet = $this->CharSet;2995        //Can we do a 7-bit downgrade?2996        if ($this->UseSMTPUTF8) {2997            $bodyEncoding = static::ENCODING_8BIT;2998        } elseif (static::ENCODING_8BIT === $bodyEncoding && !$this->has8bitChars($this->Body)) {2999            $bodyEncoding = static::ENCODING_7BIT;3000            //All ISO 8859, Windows codepage and UTF-8 charsets are ascii compatible up to 7-bit3001            $bodyCharSet = static::CHARSET_ASCII;3002        }3003        //If lines are too long, and we're not already using an encoding that will shorten them,3004        //change to quoted-printable transfer encoding for the body part only3005        if (static::ENCODING_BASE64 !== $this->Encoding && static::hasLineLongerThanMax($this->Body)) {3006            $bodyEncoding = static::ENCODING_QUOTED_PRINTABLE;3007        }3008 3009        $altBodyEncoding = $this->Encoding;3010        $altBodyCharSet = $this->CharSet;3011        //Can we do a 7-bit downgrade?3012        if (static::ENCODING_8BIT === $altBodyEncoding && !$this->has8bitChars($this->AltBody)) {3013            $altBodyEncoding = static::ENCODING_7BIT;3014            //All ISO 8859, Windows codepage and UTF-8 charsets are ascii compatible up to 7-bit3015            $altBodyCharSet = static::CHARSET_ASCII;3016        }3017        //If lines are too long, and we're not already using an encoding that will shorten them,3018        //change to quoted-printable transfer encoding for the alt body part only3019        if (static::ENCODING_BASE64 !== $altBodyEncoding && static::hasLineLongerThanMax($this->AltBody)) {3020            $altBodyEncoding = static::ENCODING_QUOTED_PRINTABLE;3021        }3022 3023        if ($this->sign_key_file) {3024            $this->Encoding = $bodyEncoding;3025            $body .= $this->getMailMIME() . static::$LE;3026        }3027 3028        //Use this as a preamble in all multipart message types3029        $mimepre = '';3030        switch ($this->message_type) {3031            case 'inline':3032                $body .= $mimepre;3033                $body .= $this->getBoundary($this->boundary[1], $bodyCharSet, '', $bodyEncoding);3034                $body .= $this->encodeString($this->Body, $bodyEncoding);3035                $body .= static::$LE;3036                $body .= $this->attachAll('inline', $this->boundary[1]);3037                break;3038            case 'attach':3039                $body .= $mimepre;3040                $body .= $this->getBoundary($this->boundary[1], $bodyCharSet, '', $bodyEncoding);3041                $body .= $this->encodeString($this->Body, $bodyEncoding);3042                $body .= static::$LE;3043                $body .= $this->attachAll('attachment', $this->boundary[1]);3044                break;3045            case 'inline_attach':3046                $body .= $mimepre;3047                $body .= $this->textLine('--' . $this->boundary[1]);3048                $body .= $this->headerLine('Content-Type', static::CONTENT_TYPE_MULTIPART_RELATED . ';');3049                $body .= $this->textLine(' boundary="' . $this->boundary[2] . '";');3050                $body .= $this->textLine(' type="' . static::CONTENT_TYPE_TEXT_HTML . '"');3051                $body .= static::$LE;3052                $body .= $this->getBoundary($this->boundary[2], $bodyCharSet, '', $bodyEncoding);3053                $body .= $this->encodeString($this->Body, $bodyEncoding);3054                $body .= static::$LE;3055                $body .= $this->attachAll('inline', $this->boundary[2]);3056                $body .= static::$LE;3057                $body .= $this->attachAll('attachment', $this->boundary[1]);3058                break;3059            case 'alt':3060                $body .= $mimepre;3061                $body .= $this->getBoundary(3062                    $this->boundary[1],3063                    $altBodyCharSet,3064                    static::CONTENT_TYPE_PLAINTEXT,

Changelog

Unchanged from 6.7.10 through 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

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

About this page

Parsed data

Generated from the wordpress-develop 6.9.10 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.