MailerAdapterInterface
Mailer Adapter interface
Table of Contents
Methods
- mail() : bool
- Mail sending function
Methods
mail()
Mail sending function
public
mail(string $to, string $subject, string $messageBody[, array<string|int, mixed> $additionalHeaders = null ][, array<string|int, mixed> $additionalParameters = null ][, bool $fakeSending = false ]) : bool
Parameters
- $to : string
-
Mail recipient.
- $subject : string
-
Mail subject.
- $messageBody : string
-
Mail body.
- $additionalHeaders : array<string|int, mixed> = null
-
Additional mail headers.
- $additionalParameters : array<string|int, mixed> = null
-
Additional mailer parameters.
- $fakeSending : bool = false
-
Whether to fake sending or not, used in Unit Tests.
Return values
bool —TRUE if the mail was successfully sent, FALSE otherwise.