Skip to the content
Documentation

exp:notificationevents

No ratings yet

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

Summary

List the notification events, or remove the old ones (dry run unless --apply)

Usage

./console exp:notificationevents [options]
php bin/php/notificationevents.php [options]
./console exp:notification:events [options]
./console exp:notify:events [options]

Aliases

exp:notification:events, exp:notify:events

Help

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

Usage: bin/php/notificationevents.php [OPTION]...
Notification events
  list                      the newest events: id, status, type, age, messages waiting
  cleanup                   remove the handled events nothing waits for, and with --older-than the
                            events (and their messages) older than that

An event has no date of its own; its age is read from what it is about (the published version, the
collaboration item, the time of a time event). Events whose age cannot be told, because the content
is gone, are listed as unknown and removed only with --include-unknown.
cleanup without --apply removes nothing: it counts what it would remove. --dry-run is still
accepted and means the same as no flag; --apply together with --dry-run is a usage error (exit 2).

./console exp:notification:events list --status=pending --limit=20
./console exp:notification:events cleanup --older-than=30d
./console exp:notification:events cleanup --older-than=30d --apply


Options:
  --status=VALUE      list, cleanup --older-than: pending or handled (default both)
  --limit=VALUE       list: how many (default 50)
  --older-than=VALUE  cleanup: 90s, 15m, 12h, 30d, 2w or a date (2026-09-01)
  --include-unknown   cleanup: also remove events whose age cannot be told
  --apply             cleanup: remove the events (the default counts them and removes nothing)
  --dry-run           cleanup: the default, kept for scripts that pass it: count, remove nothing
  --json              list: JSON

Options

Option Value Description
--status required list, cleanup --older-than: pending or handled (default both)
--limit required list: how many (default 50)
--older-than required cleanup: 90s, 15m, 12h, 30d, 2w or a date (2026-09-01)
--include-unknown - cleanup: also remove events whose age cannot be told
--apply - cleanup: remove the events (the default counts them and removes nothing)
--dry-run - cleanup: the default, kept for scripts that pass it: count, remove nothing
--json - list: JSON

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/notificationevents.php, kernel/private/classes/commands/notificationevents.php

See also

Generated example: exp:notificationevents

Added to the reference for Exponential 6.0.15.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.