exp:notificationrun

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

Run the notification filter: send the notifications of the pending events and the due digests (dry run unless --apply)

Usage

./console exp:notificationrun [options]
php bin/php/notificationrun.php [options]
./console exp:notification:run [options]
./console exp:notify:run [options]

Aliases

exp:notification:run, exp:notify:run

Help

The output of ./console help exp:notificationrun (the script run with --help), without the standard options:

Usage: bin/php/notificationrun.php [OPTION]...
Run the notifications
One pass of the notification cronjob part: a time event is made, every pending event goes through
every handler (subtree, collaboration, general digest), messages are sent or kept for a digest,
events nothing waits for are removed. The run is locked (a second one is refused while one runs),
recorded (exp:notification:status shows it) and audited.

Without --apply the command lists what would be sent (subject, number of recipients, masked
addresses) and changes nothing: the pass runs in a transaction that is rolled back and no mail is
handed to the transport. --apply sends. --dry-run is still accepted and means the same as no flag;
--apply together with --dry-run is a usage error (exit 2).
--mail-file-dir=<dir> forces the file transport for this process: the mail is written to <dir>
instead of being sent, whatever site.ini says. Use it for every trial.
--at=<time> sets the time of the time event (a date or timestamp), to try digest windows.

./console exp:notification:run
./console exp:notification:run --apply --mail-file-dir=var/tmp/notification-mail
./console exp:notification:run --apply


Options:
  --apply                Send the messages, mark and remove the events (the default lists what would be sent)
  --dry-run              The default, kept for scripts that pass it: list what would be sent and change nothing
  --at=VALUE             The time of the time event: a date (2026-10-05 08:00) or a timestamp, default now
  --event=VALUE          Only these events (ids, comma separated); no time event is made then
  --no-time-event        Make no time event: only the pending events are handled (no digest is due because of this run)
  --mail-file-dir=VALUE  Write the mail to files in this directory instead of sending it (this process only)
  --addresses            Show whole recipient addresses in the dry run (they are masked by default)
  --json                 One JSON object instead of the text
  --job=VALUE            The id of a background job whose progress file is written (the status page uses this)
  --source=VALUE         console (default) or web; what the record of the run says

Options

Standard options

Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.

Source

bin/php/notificationrun.php, kernel/private/classes/commands/notificationrun.php

See also

Generated example: exp:notificationrun

Added to the reference for Exponential 6.0.15.