Mail

MMO\core\server · 1 symbol · generated 30 Sep 2026

class

Mail

Build and send a MIME email via PHP's mail() (which shells out to sendmail), with support for HTML/plain alternative bodies, attachments, inline (data-URI) images, and DKIM signing. Adapted from PHPMailer.

class MMO\core\server\Mail use MMO\core\classes\tWithHeaders

Namespace: MMO\core\server
Uses traits: tWithHeaders

$mail = new Mail('to@example.com', 'Subject', '<p>Hello</p>', 'from@example.com'); $mail->bodyAlt = 'Hello (plain text)'; $mail->addAttachment('/path/to/file.pdf'); $mail->send();

Index

	MAX_LINE_LENGTH
	attachments
	body
	bodyAlt
	dkimDomain	DKIM signing domain name.
	DKIMHeaders static
	dkimIdentity	DKIM Identity: Usually the email address used as the source of the email.
	dkimPassphrase	DKIM passphrase if your key is encrypted.
	dkimPrivateFile	DKIM private key file path.
	dkimSelector	DKIM selector.
	headers
	ikeys
	recipients
	subject
	uniqueid	identifiant for boundaries
	addAttachment($path, $name, $type, $disposition, $id)	Add an attachment from a file.
	addBCC($address, $name)
	addCC($address, $name)
	addConfirmReading($address, $name)
	addHeader($name, $value)	Append a value to a header, keeping any value(s) already set (as opposed to `setHeader`, which replaces).
	addInlineAttachment($cid, $path, $name, $type)	Add an inline attachment from a file.
	addRecipient($kind, $address, $name)
	addReplyTo($address, $name)
	addTo($address, $name)	Add one To recipient (on top of any already set -- `setTo` to replace them all).
	clearAttachments()	Remove every attachment (regular and inline).
	debugName()
	DKIMEncodeBody($body)	Generate a DKIM canonicalization body.
	DKIMEncodeHeaders($headers, $subject, $body)
	DKIMEncodeRelaxedHeader($header)	Generate a DKIM canonicalization header.
	DKIMEncodeText($txt)	Quoted-Printable-encode a DKIM header.
	DKIMSign($header)
	encodeHeader($text, $secure)	Encode text to be placed in the header.
	getBCC()
	getCC()
	getCharset()
	getConfirmReading()
	getContentExtension()
	getContentType($single)
	getFrom()
	getHeader($name)	Retrieves a message header value by the given case-insensitive name.
	getHeaderLine($name)	Retrieves a comma-separated string of the values for a single header.
	getHeaders($boundaries)	Build the full header set for `send`: the manually-set headers (`tWithHeaders`) plus one line per recipient kind (except 'To', which `send` passes to `mail()` separately)…
	getOrigin()	Get origin of the request by looking at 'Origin', then 'Referer', then 'Sender' in the request's headers.
	getPriority()
	getReplyTo()
	getTo()
	getUserAgent()
	hasAttachment()
	hasBCC($address)
	hasCC($address)
	hasConfirmReading($address)
	hasHeader($name)	Checks if a header exists by the given case-insensitive name.
	hasInlineAttachment()
	hasRecipient($kind, $address)
	hasReplyTo($address)
	hasTo($address)
	isHTML()
	isIe()
	isIphone()
	isJSON()
	isMac()
	isMobile()
	isMultipart()
	isWindows()
	replaceInlineImage($text)	Replace all images passed as datauri (`<img src="data:....>`) to inline attachment
	secureHeader($text)	Strip CR/LF from $text -- prevents header injection when embedding untrusted content (e.g.
	send()	Build the full MIME message (headers, multipart body, DKIM signature if `$dkimIdentity` is set) and send it via PHP's `mail()`.
	setBCC($addresses)
	setBody($body)	Set the body and replace all uri images into inline attachment
	setCacheControl($cache, $pragma)	Set the Cache-Control header (and, optionally, the legacy Pragma header alongside it).
	setCC($addresses)
	setConfirmReading($addresses)
	setContentType($type, $charset)	Set the Content-Type header, appending a charset parameter (unless $charset is null/empty).
	setExpires($time)	Set the Expires header from a unix timestamp, formatted as an RFC 7231 HTTP-date.
	setFrom($address, $name)	Replaces the From address (there is only ever one).
	setHeader($name, $value)	Set header, replacing any previous value(s) for the same (case-insensitively matched) header name.
	setPriority($value)	Email priority.
	setRecipients($kind, $addresses)	Set recipients of a kind
	setReplyTo($addresses)
	setTo($addresses)	Replace every To recipient.
	unsetHeader($name)	Remove a header entirely.
	__construct($to, $subject, $body, $from, $contentType, $charset)

Constants1

MAX_LINE_LENGTH

const MAX_LINE_LENGTH = 75

Properties14

attachments

protected array $attachments = []

Type: array

body

string $body = ''

Type: string

bodyAlt

?string $bodyAlt = null

Type: null | string

dkimDomain

DKIM signing domain name.

string $dkimDomain = ''

Type: string

DKIMHeaders

static

static array $DKIMHeaders = […10 items]

Type: array

dkimIdentity

DKIM Identity: Usually the email address used as the source of the email.

?string $dkimIdentity = null

Type: null | string

dkimPassphrase

DKIM passphrase if your key is encrypted.

?string $dkimPassphrase = null

Type: null | string

dkimPrivateFile

DKIM private key file path.

?string $dkimPrivateFile = null

Type: null | string

dkimSelector

DKIM selector.

string $dkimSelector = 'mail'

Type: string

headers

protected $headers = []

ikeys

protected $ikeys = []

recipients

protected array $recipients = []

Type: array

subject

string $subject = ''

Type: string

uniqueid

identifiant for boundaries

protected string $uniqueid

Type: string

Methods67

addAttachment($path, $name, $type, $disposition, $id)

Mail.php:470

Add an attachment from a file.

function addAttachment( string $path, ?string $name = null, ?string $type = null, string $disposition = 'attachment', ?string $id = null ): void

$path	string	Path to the attachment
$name = null	null \| string	Overrides the attachment filename
$type = null	null \| string	File MIME type (by default mapped from the `$path` filename's extension)
$disposition = 'attachment'	string	Disposition to use: `inline` or `attachment`
$id = null	null \| string	the identifaint to use for inline attachment
returns	void

addBCC($address, $name)

Mail.php:384

function addBCC(string $address, ?string $name = null)

$address	string
$name = null	null \| string
returns

addCC($address, $name)

Mail.php:363

function addCC(string $address, ?string $name = null)

$address	string
$name = null	null \| string
returns

addConfirmReading($address, $name)

Mail.php:424

function addConfirmReading(string $address, ?string $name = null)

$address	string
$name = null	null \| string
returns

addHeader($name, $value)

tWithHeaders.php:166

Append a value to a header, keeping any value(s) already set (as opposed to setHeader, which replaces).

function addHeader(string $name, array|string $value): self

$name	string
$value	array \| string	a plain string is appended as a single new value (NOT split on ',', unlike setHeader)
returns	self

$msg->addHeader('X-Tags', 'a'); $msg->addHeader('X-Tags', 'b'); $msg->getHeader('X-Tags'); // ['a', 'b']

addInlineAttachment($cid, $path, $name, $type)

Mail.php:491

Add an inline attachment from a file.

function addInlineAttachment(string $cid, string $path, ?string $name = null, ?string $type = null): void

This can include images, sounds, and just about any other document type. These differ from 'regular' attachments in that they are intended to be displayed inline with the message, not just attached for download. This is used in HTML messages that embed the images the HTML refers to using the `$cid` value in `img` tags, for example `<img src="cid:mylogo">`.

$cid	string	Content ID of the attachment; Use this to reference the content when using an embedded image in HTML
$path	string	Path to the attachment
$name = null	null \| string	Overrides the attachment filename
$type = null	null \| string	File MIME type (by default mapped from the `$path` filename's extension)
returns	void

addRecipient($kind, $address, $name)

Mail.php:276

protected function addRecipient(string $kind, string $address, ?string $name = null)

$kind	string	e.g. 'To', 'Cc', 'Bcc', 'Reply-To', 'From'. @param string $address `secureHeader`'d before storing.
$address	string
$name = null	null \| string
returns

addReplyTo($address, $name)

Mail.php:404

function addReplyTo(string $address, ?string $name = null)

$address	string
$name = null	null \| string
returns

addTo($address, $name)

Mail.php:335

Add one To recipient (on top of any already set -- setTo to replace them all).

function addTo(string $address, ?string $name = null)

$address	string
$name = null	null \| string
returns

clearAttachments()

Mail.php:443

Remove every attachment (regular and inline).

function clearAttachments()

returns

debugName()

Mail.php:170

function debugName(): string

returns

string

the class name.

DKIMEncodeBody($body)

Mail.php:525

Generate a DKIM canonicalization body.

protected function DKIMEncodeBody(string $body): string

Uses the 'simple' algorithm from RFC6376 section 3.4.3. Canonicalized bodies should *always* use CRLF, regardless of mailer setting.

See: https://www.rfc-editor.org/rfc/rfc6376#section-3.4.3

$body	string	Message Body
returns	string

DKIMEncodeHeaders($headers, $subject, $body)

Mail.php:570

protected function DKIMEncodeHeaders(array $headers, string $subject, string $body): string

$headers	array
$subject	string
$body	string
returns	string

DKIMEncodeRelaxedHeader($header)

Mail.php:543

Generate a DKIM canonicalization header.

protected function DKIMEncodeRelaxedHeader(string $header): string

Uses the 'relaxed' algorithm from RFC6376 section 3.4.2. Canonicalized headers should *always* use CRLF, regardless of mailer setting.

See: https://www.rfc-editor.org/rfc/rfc6376#section-3.4.2

$header	string
returns	string

DKIMEncodeText($txt)

Mail.php:503

Quoted-Printable-encode a DKIM header.

protected function DKIMEncodeText(string $txt): string

$txt	string
returns	string

DKIMSign($header)

Mail.php:562

protected function DKIMSign(string $header): string

$header	string
returns	string

encodeHeader($text, $secure)

Mail.php:226

Encode text to be placed in the header.

protected function encodeHeader(string $text, bool $secure = true)

In order to encode quickly, and for simplicity, we only use base64 (B) encoding, leaving Q encoding.

$text	string	the text to encode
$secure = true	bool	if true, remove eol from text
returns

getBCC()

returns

null | string

the From address, or null if unset.

getHeader($name)

tWithHeaders.php:254

Retrieves a message header value by the given case-insensitive name.

function getHeader(string $name): array

This method returns an array of all the header values of the given case-insensitive header name. If the header does not appear in the message, this method MUST return an empty array.

$name	string	Case-insensitive header field name.
returns	array	An array of string values as provided for the given header. If the header does not appear in the message, this method MUST return an empty array.

$msg->addHeader('Accept', 'text/html'); $msg->addHeader('Accept', 'application/json'); $msg->getHeader('Accept'); // ['text/html', 'application/json']

getHeaderLine($name)

tWithHeaders.php:281

Retrieves a comma-separated string of the values for a single header.

function getHeaderLine(string $name): string

This method returns all of the header values of the given case-insensitive header name as a string concatenated together using a comma. NOTE: Not all header values may be appropriately represented using comma concatenation. For such headers, use getHeader() instead and supply your own delimiter when concatenating. If the header does not appear in the message, this method MUST return an empty string.

$name	string	Case-insensitive header field name.
returns	string	A string of values as provided for the given header concatenated together using a comma. If the header does not appear in the message, this method MUST return an empty string.

$msg->addHeader('Accept', 'text/html'); $msg->addHeader('Accept', 'application/json'); $msg->getHeaderLine('Accept'); // 'text/html, application/json'

getHeaders($boundaries)

Mail.php:635

Build the full header set for send: the manually-set headers (tWithHeaders) plus one line per recipient kind (except 'To', which send passes to mail() separately) and the right Content-Type for whatever MIME structure the message needs (isMultipart).

function getHeaders(array &$boundaries = []): array

$boundaries = []	array
returns	array	header name => value (or list of values).

getOrigin()

tWithHeaders.php:35

Get origin of the request by looking at 'Origin', then 'Referer', then 'Sender' in the request's headers.

function getOrigin(): string

returns

string

'' if none of those headers are set

$msg->setHeader('Origin', 'https://example.com'); $msg->getOrigin(); // 'https://example.com'

getPriority()

Mail.php:199

function getPriority(): ?int

returns null | int the current priority (setPriority), or null if unset.

getReplyTo()

Mail.php:399

function getReplyTo(): array

returns

array

getTo()

Mail.php:327

function getTo(): array

returns array address => name (name is null when not given -- addTo).

$mail->addTo('a@x.com', 'Alice'); $mail->getTo(); // ['a@x.com' => 'Alice']

getUserAgent()

tWithHeaders.php:70

function getUserAgent(): ?string

returns

null | string

the User-Agent header

hasAttachment()

Mail.php:453

function hasAttachment(): bool

returns bool whether any regular (non-inline) attachment is set (addAttachment).

hasBCC($address)

Mail.php:394

function hasBCC(?string $address = null)

$address = null	null \| string
returns

hasCC($address)

Mail.php:373

function hasCC(?string $address = null)

$address = null	null \| string
returns

hasConfirmReading($address)

Mail.php:434

function hasConfirmReading(?string $address = null)

$address = null	null \| string
returns

hasHeader($name)

tWithHeaders.php:231

Checks if a header exists by the given case-insensitive name.

function hasHeader(string $name): bool

$name	string	Case-insensitive header field name.
returns	bool	Returns true if any header names match the given header name using a case-insensitive string comparison. Returns false if no matching header name is found in the message.

$msg->setHeader('Content-Type', 'text/html'); $msg->hasHeader('content-type'); // true

hasInlineAttachment()

Mail.php:448

function hasInlineAttachment(): bool

returns bool whether any inline attachment is set (addInlineAttachment/setBody's data-URI extraction).

hasRecipient($kind, $address)

Mail.php:303

protected function hasRecipient(string $kind, ?string $address = null): bool

$kind	string
$address = null	null \| string	if given, check for this specific address; if null, check whether ANY address of $kind is set.
returns	bool

hasReplyTo($address)

Mail.php:414

function hasReplyTo(?string $address = null)

$address = null	null \| string
returns

hasTo($address)

Mail.php:353

function hasTo(?string $address = null)

$address = null	null \| string	if given, check for this specific address; if null, check whether any To recipient is set.
returns

isHTML()

tWithHeaders.php:119

function isHTML(): bool

returns bool true if getContentExtension is 'html'

isIe()

tWithHeaders.php:84

function isIe(): bool

returns

bool

true if the User-Agent looks like Internet Explorer

isIphone()

tWithHeaders.php:77

function isIphone(): bool

returns

bool

Mail.php:248

Replace all images passed as datauri (<img src="data:....>) to inline attachment

protected function replaceInlineImage(string $text): string

$text	string
returns	string

secureHeader($text)

Mail.php:215

Strip CR/LF from $text -- prevents header injection when embedding untrusted content (e.g. a recipient name) into a header line.

protected function secureHeader(string $text): string

$text	string
returns	string

send()

Mail.php:685

Build the full MIME message (headers, multipart body, DKIM signature if $dkimIdentity is set) and send it via PHP's mail().

function send()

returns
throws		if no From/To address or body is set, `mail()` itself fails, or (via `DKIMSign`) DKIM signing fails.

setBCC($addresses)

Mail.php:389

function setBCC(array|string $addresses)

$addresses	array \| string
returns

setBody($body)

Mail.php:208

Set the body and replace all uri images into inline attachment

function setBody(string $body): void

$body	string
returns	void

setCacheControl($cache, $pragma)

tWithHeaders.php:305

Set the Cache-Control header (and, optionally, the legacy Pragma header alongside it).

function setCacheControl($cache, $pragma = null): self

$cache		cache method 'public', 'private', 'no-cache', 'no-store'
$pragma = null		if given, also sets the Pragma header (e.g. 'no-cache', for HTTP/1.0 clients)
returns	self

$msg->setCacheControl('no-cache', 'no-cache');

setCC($addresses)

Mail.php:368

function setCC(array|string $addresses)

$addresses	array \| string
returns

setConfirmReading($addresses)

Mail.php:429

function setConfirmReading(array|string $addresses)

$addresses	array \| string
returns

setContentType($type, $charset)

tWithHeaders.php:293

Set the Content-Type header, appending a charset parameter (unless $charset is null/empty).

function setContentType(string $type, ?string $charset = 'utf-8'): self

$type	string	the media type, e.g. 'text/html' or one of the framework's MIME_* constants
$charset = 'utf-8'	null \| string	appended as `;charset=$charset`; pass null/'' to omit it entirely
returns	self

$msg->setContentType('text/html'); $msg->getHeaderLine('Content-Type'); // 'text/html;charset=utf-8'

$msg->setContentType('application/octet-stream', null); // no charset appended

setExpires($time)

tWithHeaders.php:317

Set the Expires header from a unix timestamp, formatted as an RFC 7231 HTTP-date.

function setExpires(?int $time): self

$time	null \| int	a unix timestamp; 0 (or any past time) tells clients/caches the response is already stale
returns	self

$msg->setExpires(0); $msg->getHeaderLine('Expires'); // 'Thu, 01 Jan 1970 00:00:00 GMT'

setFrom($address, $name)

Mail.php:317

Replaces the From address (there is only ever one).

function setFrom(string $address, ?string $name = null)

$address	string
$name = null	null \| string
returns

setHeader($name, $value)

tWithHeaders.php:143

Set header, replacing any previous value(s) for the same (case-insensitively matched) header name.

function setHeader(string $name, array|string $value): self

$name	string
$value	array \| string	if a string, it is split on ',' into the multiple values PSR-7 expects a header to hold (e.g. 'a,b' becomes ['a', 'b']) -- pass an array (even a single-element one, e.g. `[$value]`) if $value may itself legitimately contain a comma that must NOT be split (an HTTP-date value like 'Thu, 01 Jan ...' is the classic example -- see `setExpires`)
returns	self

$msg->setHeader('Content-Type', 'text/html');

$msg->setHeader('Accept', 'text/html,application/json'); // stored as ['text/html', 'application/json']

setPriority($value)

Mail.php:193

Email priority.

function setPriority(?int $value)

When null, the header is not set at all.

$value	null \| int	null (default), 1 = High, 3 = Normal, 5 = low.
returns

setRecipients($kind, $addresses)

Mail.php:287

Set recipients of a kind

protected function setRecipients(string $kind, array|string $addresses)

$kind	string	the kind of recipient (to,cc,bcc,reply-to)
$addresses	array \| string	array<name: address> It also can be a list of addresses (name is consider null)
returns

setReplyTo($addresses)

Mail.php:409

function setReplyTo(array|string $addresses)

$addresses	array \| string
returns

setTo($addresses)

Mail.php:345

Replace every To recipient.

function setTo(array|string $addresses)

$addresses	array \| string	`['name' => 'address', ...]` (or a plain list, name null), or a single `"Name <address>, address2, ..."`-style string (`decodeRecipients`).
returns

unsetHeader($name)

tWithHeaders.php:179

Remove a header entirely.

function unsetHeader(string $name): self

$name	string
returns	self

$msg->unsetHeader('X-Tags'); $msg->hasHeader('X-Tags'); // false

__construct($to, $subject, $body, $from, $contentType, $charset)

Mail.php:153

function __construct( array|string|null $to = null, string $subject = '', string $body = '', ?string $from = null, string $contentType = 'text/html', string $charset = 'utf-8' )

$to = null	array \| string \| null	`setTo`.
$subject = ''	string
$body = ''	string	`setBody` -- also inline-extracts any `<img src="data:...">` into an attachment.
$from = null	null \| string	`setFrom`; defaults to the `sendmail_from` ini setting if not given.
$contentType = 'text/html'	string
$charset = 'utf-8'	string