Download the PHP package preflow/notify without Composer

preflow/notify

Send email, SMS and other messages through pluggable transports. Application code depends on one class, Notifier, and on small message value objects. Which provider delivers a channel is configuration.

Notifier is injected by constructor like any other service. Sending is synchronous. This is not a message bus or queue (unlike Symfony Messenger): it only delivers outbound messages.

Configuration

Core boots the package when config/notify.php exists:

• Credentials belong in .env.
• Transports are created on first send, so an empty or broken DSN never breaks boot. It fails, with a clear message, when something is sent.
• A channel's from is used when a message doesn't set its own.
• Any transport takes redirect_to (an address, a comma-separated string or a list): every email it sends then goes only there, for stage and test installations. Cc and Bcc are dropped; the subject starts with [→ original recipients] and the body with a line naming To, Cc and Bcc. SMS passes through unchanged. Example: 'redirect_to' => getenv('MAIL_REDIRECT_TO') ?: '' (empty means off).

Drivers

Messages

• Email:
  • to, subject, text, plus optional html, from, replyTo, cc, bcc and attachments (Attachment::fromPath() / Attachment::fromContents()).
  • Addresses are strings: [email protected] or Name <[email protected]>.
  • Line breaks in the subject or addresses are rejected, which prevents header injection.
• Sms: to in E.164 format (+41790000000), text, optional from.
• Your own types: implement Preflow\Notify\Message with a channel key (chat, push, …) and configure a transport that supports it.

A provider with its own SDK

Implement Preflow\Notify\Transport and register it as a driver from a service provider:

Then set 'texts' => ['driver' => 'acme-sms', 'key' => getenv('ACME_KEY') ?: ''] in transports.

Sending after the response

Sending takes an SMTP round trip. On account flows (forgot password, registration, resend confirmation) that makes "an account exists" answer measurably slower than "no account", which leaks which addresses are registered. Queue those mails instead:

sendLater() only queues. Core sends the queue once the response has gone out: Application::run() emits the response, releases the client the way Symfony's Response::send() does (fastcgi_finish_request() on PHP-FPM, else litespeed_finish_request() on LiteSpeed LSAPI, else outside the CLI it flushes all output buffers), then calls flushDeferred(). The flush sits in a finally, so mail queued before an exception or an error page still goes out.

The "after the response" guarantee holds on PHP-FPM and LSAPI. Elsewhere (mod_php, plain CGI) it is best effort: the connection stays open until the script ends. Some timing differences remain regardless of the transport: building the message and any database writes happen before the response. Keep those equally cheap on both branches of an account flow. register_shutdown_function was not used: it runs outside the application's control and cannot be flushed deterministically in the CLI and in tests.

• Order is FIFO; every message is isolated, one failure does not stop the others.
• A deferred failure never throws into the request. It calls $onFailure(\Throwable) when given; otherwise it logs a generic line (no addresses) through a PSR LoggerInterface bound in the container, else error_log().
• flushDeferred() returns the number sent.
• CLI and tests: Application::handle() flushes the queue itself before returning (only run() postpones it until after emitting), so in-process requests and tests never lose mail. A CLI command that does not go through handle()/run() must call $notifier->flushDeferred() itself.
• The cap applies per flushDeferred() call: it sends at most Notifier::FLUSH_LIMIT (100) messages and logs what is left, so an onFailure that keeps re-queuing cannot loop forever. If onFailure throws, a generic line is logged.
• The logger is looked up in the container when a failure happens, so one bound by a provider is used. defer is read as a boolean ("false", 0 and off count as false).
• Without config/notify.php there is no Notifier and nothing happens.
• 'defer' => false in config/notify.php (default true) makes sendLater() send at once, a failure going to $onFailure/the log. Handy to debug; tests rarely need it.

Errors

Every failure is a Preflow\Notify\TransportException. Provider errors are wrapped, and their message is masked: URL user-info (smtp://***@host) and secret-looking query parameters (api_key=***, password=***, token=***). The original exception is chained unmasked as getPrevious(), so don't log the whole chain verbatim.

When a failover delivers through a fallback, SentMessage::$failures lists each transport it fell back from (name → masked reason). Log these. Otherwise a broken SMTP setup goes unnoticed while mail quietly lands in the log transport.

The caller decides what a failure means; for a contact form, store the submission first, then send.

CLI

This sends a fixed test message through the configured transport and prints the result or the error. It exits non-zero when a failover had to fall back, and prints why the preferred transport failed. Use it to check credentials on a live server.