1RT-EMAIL-DASHBOARDS(1)User Contributed Perl DocumentationRT-EMAIL-DASHBOARDS(1)
2
3
4

NAME

6       rt-email-dashboards - Send email dashboards
7

SYNOPSIS

9           rt-email-dashboards [options]
10

DESCRIPTION

12       This tool will send users email based on how they have subscribed to
13       dashboards. A dashboard is a set of saved searches, the subscription
14       controls how often that dashboard is sent and how it's displayed.
15
16       Each subscription has an hour, and possibly day of week or day of
17       month. These are taken to be in the user's timezone if available, UTC
18       otherwise.
19

SETUP

21       You'll need to have cron run this script every hour. Here's an example
22       crontab entry to do this.
23
24           0 * * * * /usr/sbin/rt-email-dashboards
25
26       This will run the script every hour on the hour. This may need some
27       further tweaking to be run as the correct user.
28

OPTIONS

30       This tool supports a few options. Most are for debugging.
31
32       -h
33       --help  Display this documentation
34
35       --dryrun
36               Figure out which dashboards would be sent, but don't actually
37               generate or email any of them
38
39       --dashboards DASHBOARD_IDS
40               Only check specified dashboards(comma-separated IDs).
41
42       --time SECONDS
43               Instead of using the current time to figure out which
44               dashboards should be sent, use SECONDS (usually since midnight
45               Jan 1st, 1970, so 1192216018 would be Oct 12 19:06:58 GMT
46               2007).
47
48       --epoch SECONDS
49               Back-compat for --time SECONDS.
50
51       --all   Ignore subscription frequency when considering each dashboard
52               (should only be used with --dryrun for testing and debugging)
53
54       --user User NAME or ID
55               Only check the specified user's subscriptions
56
57       --recipient User NAME or EMAIL or ID
58               Only send emails to the specified user. Can be specified
59               multiple times to send multiple emails, e.g.
60
61                   --recipient alice@example.com --recipient bob@example.com
62
63               This is mostly useful for testing, especially dashboard issues
64               seen only by a specific user. For typical dashboard emails, set
65               recipients via the subscription settings in the web UI.
66
67       --log LEVEL
68               Adjust LogToSTDERR config option
69
70
71
72perl v5.36.1                      2023-10-21            RT-EMAIL-DASHBOARDS(1)