'pass', 'dkim' => 'pass', 'dmarc' => 'pass']` — read from the * topmost `Authentication-Results` header or given by the receiver. Absent keys * mean unknown, not failed. */ final class InboundMessage { /** * @param list

$to * @param list

$cc * @param list

$replyTo * @param list $envelopeTo * @param list $references * @param list $headers * @param list $attachments * @param array $auth */ public function __construct( /** The full RFC 5322 bytes, when the receiver had them. */ public readonly ?string $raw = null, public readonly ?string $messageId = null, /** The first id in In-Reply-To only. */ public readonly ?string $inReplyTo = null, public readonly array $references = [], public readonly Address $from = new Address(''), public readonly array $to = [], public readonly array $cc = [], public readonly array $replyTo = [], public readonly array $envelopeTo = [], public readonly ?string $envelopeFrom = null, public readonly string $subject = '', /** Unix time from the Date header, or null when it could not be read. */ public readonly ?int $date = null, public readonly ?string $text = null, public readonly ?string $html = null, /** The provider's own quote-stripped text. Advisory only. */ public readonly ?string $providerStrippedText = null, public readonly array $headers = [], public readonly array $attachments = [], public readonly array $auth = [], public readonly ?float $spamScore = null, /** The receiver key it came through: 'cloudflare', 'imap', 'postmark', … */ public readonly string $receiver = '', /** The provider's own id for the message, where it gives one. */ public readonly ?string $providerId = null, /** The top-level media type, lower-cased: 'multipart/report' for a delivery report. */ public readonly string $contentType = 'text/plain', ) { } /** * Parse raw MIME into a message, then lay the receiver's own knowledge over * it: `['envelopeTo' => [...], 'envelopeFrom' => '', 'providerId' => '…', * 'auth' => [...], 'spamScore' => 1.2, 'providerStrippedText' => '…']`, or * any other property by name. Never throws. * * @param array $overrides */ public static function fromMime(string $raw, string $receiver, array $overrides = []): self { $message = (new MimeParser())->parse($raw); return $message->with(['receiver' => $receiver] + $overrides); } /** * A copy with some properties replaced. Unknown names are ignored, and a * value of the wrong type is ignored rather than thrown on. * * @param array $changes */ public function with(array $changes): self { $values = get_object_vars($this); foreach ($changes as $name => $value) { if (!\array_key_exists($name, $values)) { continue; } $values[$name] = $value; } try { return new self(...$values); } catch (\TypeError) { $safe = get_object_vars($this); foreach ($changes as $name => $value) { if (!\array_key_exists($name, $safe)) { continue; } $try = $safe; $try[$name] = $value; try { new self(...$try); $safe = $try; } catch (\TypeError) { } } return new self(...$safe); } } /** The first value of a header, case insensitively, unfolded, or null. */ public function header(string $name): ?string { $name = strtolower(trim($name)); foreach ($this->headers as [$key, $value]) { if (strtolower($key) === $name) { return $value; } } return null; } /** * Every value of a header, in order. * * @return list */ public function headerAll(string $name): array { $name = strtolower(trim($name)); $out = []; foreach ($this->headers as [$key, $value]) { if (strtolower($key) === $name) { $out[] = $value; } } return $out; } /** Whether this is a delivery or disposition report (a bounce, a DSN, a read receipt). */ public function isReport(): bool { return $this->contentType === 'multipart/report'; } /** * Every recipient, envelope first, then To, then Cc, lower-cased and * without repeats. Where a plus-address token is looked for. * * @return list */ public function recipients(): array { $all = $this->envelopeTo; foreach ([$this->to, $this->cc] as $list) { foreach ($list as $address) { $all[] = $address->email; } } $out = []; foreach ($all as $email) { $email = strtolower(trim($email)); if ($email !== '' && !\in_array($email, $out, true)) { $out[] = $email; } } return $out; } }