Library Group: mail

Generated by php build/docs/rvn-docs.php. Do not edit this file by hand.

| Symbol | Kind | Summary | @return |
| --- | --- | --- | --- |
| Raven\Lib\Mail\Address::defaultNoReply() | method | Builds a no-reply sender address from the given site domain. | string No-reply address such as no-reply@example.com. |
| Raven\Lib\Mail\Address::headerDomain() | method | Returns a safe domain token suitable for use in RFC 2822 Message-ID headers. | string Sanitized domain token guaranteed to contain at least one dot. |
| Raven\Lib\Mail\Address::mask() | method | Returns a privacy-masked version of an email address for safe display in UI. | string Masked address, or empty string when the address is invalid. |
| Raven\Lib\Mail\Address::normalize() | method | Normalizes one email address to lowercase-trimmed form, returning null when invalid. | string\|null Normalized lowercase address, or null when validation fails. |
| Raven\Lib\Mail\Address::sanitizeHeader() | method | Sanitizes one header field value: strips control characters and enforces a max length. | string Clean, single-line header value safe for direct inclusion in MIME headers. |
| Raven\Lib\Mail\Message::__construct() | method | Constructs a minimal outgoing message with the three required envelope fields. | (No @return.) |
| Raven\Lib\Mail\Message::bcc() | method | Returns the BCC recipient addresses. | array<int, string> |
| Raven\Lib\Mail\Message::body() | method | Returns the plain-text message body. | string |
| Raven\Lib\Mail\Message::cc() | method | Returns the CC recipient addresses. | array<int, string> |
| Raven\Lib\Mail\Message::customHeaders() | method | Returns the extra raw header lines appended via withHeader(). | array<int, string> |
| Raven\Lib\Mail\Message::replyTo() | method | Returns the Reply-To address, or an empty string when not set. | string |
| Raven\Lib\Mail\Message::subject() | method | Returns the message subject line. | string |
| Raven\Lib\Mail\Message::to() | method | Returns the primary To: recipient addresses. | array<int, string> |
| Raven\Lib\Mail\Message::withBcc() | method | Returns a copy of this message with the BCC addresses set. | self New message instance with BCC addresses populated. |
| Raven\Lib\Mail\Message::withCc() | method | Returns a copy of this message with the CC addresses set. | self New message instance with CC addresses populated. |
| Raven\Lib\Mail\Message::withHeader() | method | Returns a copy of this message with one additional raw header line appended. | self New message instance with the header appended. |
| Raven\Lib\Mail\Message::withReplyTo() | method | Returns a copy of this message with the Reply-To address set. | self New message instance with Reply-To populated. |

Parameter Details

Raven\Lib\Mail\Address::defaultNoReply()

  • File: private/lib/Mail/Address.php
  • Params:
  • string $siteDomain Raw site domain from config.

Raven\Lib\Mail\Address::headerDomain()

  • File: private/lib/Mail/Address.php
  • Params:
  • string $siteDomain Raw site domain from config (e.g. \example.com\).

Raven\Lib\Mail\Address::mask()

  • File: private/lib/Mail/Address.php
  • Params:
  • string $email Email address to mask.

Raven\Lib\Mail\Address::normalize()

  • File: private/lib/Mail/Address.php
  • Params:
  • string $email Raw email address from user input or config.

Raven\Lib\Mail\Address::sanitizeHeader()

  • File: private/lib/Mail/Address.php
  • Params:
  • string $value Raw header field value (e.g. a From display name or subject line).
  • int $maxLength Maximum byte length to retain before stripping.

Raven\Lib\Mail\Message::__construct()

  • File: private/lib/Mail/Message.php
  • Params:
  • array&lt;int, string&gt; $to One or more primary recipient addresses.
  • string $subject Message subject line (unsanitized; Postmaster handles escaping).
  • string $body Plain-text message body.

Raven\Lib\Mail\Message::bcc()

  • File: private/lib/Mail/Message.php
  • Params: (none)

Raven\Lib\Mail\Message::body()

  • File: private/lib/Mail/Message.php
  • Params: (none)

Raven\Lib\Mail\Message::cc()

  • File: private/lib/Mail/Message.php
  • Params: (none)

Raven\Lib\Mail\Message::customHeaders()

  • File: private/lib/Mail/Message.php
  • Params: (none)

Raven\Lib\Mail\Message::replyTo()

  • File: private/lib/Mail/Message.php
  • Params: (none)

Raven\Lib\Mail\Message::subject()

  • File: private/lib/Mail/Message.php
  • Params: (none)

Raven\Lib\Mail\Message::to()

  • File: private/lib/Mail/Message.php
  • Params: (none)

Raven\Lib\Mail\Message::withBcc()

  • File: private/lib/Mail/Message.php
  • Params:
  • array&lt;int, string&gt; $bcc BCC recipient addresses.

Raven\Lib\Mail\Message::withCc()

  • File: private/lib/Mail/Message.php
  • Params:
  • array&lt;int, string&gt; $cc CC recipient addresses.

Raven\Lib\Mail\Message::withHeader()

  • File: private/lib/Mail/Message.php
  • Params:
  • string $header Complete raw header line (e.g. \X-Raven-Auth-Flow: login-2fa-email-code\).

Raven\Lib\Mail\Message::withReplyTo()

  • File: private/lib/Mail/Message.php
  • Params:
  • string $replyTo Explicit Reply-To email address.