exp:notificationrun
Run the notification filter: send the notifications of the pending events and the due digests (dry run unless --apply).
Script bin/php/notificationrun.php, code in kernel/private/classes/commands/notificationrun.php. Run it from the installation root, as the user the web server runs as:
./console exp:notificationrun --help
./console exp:notification:run --help
./console exp:notify:run --help
php bin/php/notificationrun.php --helpHelp text
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 --applyOptions
| Option | Value | Help |
|---|---|---|
--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 | required | The time of the time event: a date (2026-10-05 08:00) or a timestamp, default now |
--event | required | 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 | required | 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 | required | The id of a background job whose progress file is written (the status page uses this) |
--source | required | console (default) or web; what the record of the run says |
Read from the option definitions in the code (startup(), getOptions(), options() or ezcConsoleOption). Every script also takes the standard options of the script framework (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).
Related
Generated by ./console exp:help:examples from bin/php/notificationrun.php, kernel/private/classes/commands/notificationrun.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.