rt-email-dashboards(8)

πŸ’– rt-email-dashboards(8) πŸ’–

okay bestie, welcome to Request Tracker Reference's most unbothered little cron goblin: rt-email-dashboards. she wakes up, she checks subscriptions, she sends emails, she goes back to sleep. iconic behaviour honestly.


✨ NAME ✨

rt-email-dashboards β€” send email dashboards πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

rt-email-dashboards [options]

🌸 DESCRIPTION 🌸

so here's the tea β˜•: this tool sends users emails based on how they've subscribed to dashboards. and what even is a dashboard? it's a set of saved searches, bestie. the subscription is the thing that decides how often that dashboard gets sent out and how it's displayed. it's giving ✨personalised newsletter energy✨.

each subscription has an hour, and possibly a day of week or day of month. those are taken to be in the user's timezone if that's available β€” and UTC otherwise. no cap.


πŸŽ€ SETUP πŸŽ€

you're gonna need cron running this script every hour. yes, every hour. she's a lil hourly girlie. here's an example crontab entry to make that happen:

0 * * * * /usr/sbin/rt-email-dashboards

that runs the script every hour, on the hour. lowkey might need some further tweaking so it runs as the correct user β€” do not skip that part fr fr.


πŸ’… OPTIONS πŸ’…

this tool supports a few options. most of them are for debugging, so don't get any ideas about them being main character options. they're supporting cast. still slay though.

  • -h
  • --help β€” display this documentation πŸ’–
  • --dryrun β€” figure out which dashboards would be sent, but don't actually generate or email any of them. it's the "add to cart and then close the tab" of dashboards. πŸ›’
  • --dashboards DASHBOARD_IDS β€” only check the specified dashboards (comma-separated IDs).
  • --time SECONDS β€” instead of using the current time to figure out which dashboards should be sent, use SECONDS. (usually that means seconds since midnight Jan 1st, 1970, so 1192216018 would be Oct 12 19:06:58 GMT 2007. yes, she's a legacy timestamp girlie πŸ•°οΈ)
  • --epoch SECONDS β€” backwards-compatible for --time SECONDS. same vibes, older name. we love a nostalgic queen πŸ‘‘
  • --all β€” ignore subscription frequency when considering each dashboard. 🚨 should only be used with --dryrun for testing and debugging. do NOT run this loose in production, bestie, I am begging. 😭
  • --user User NAME or ID β€” only check the specified user's subscriptions.
  • --recipient User NAME or EMAIL or ID β€” only send emails to the specified user. can be specified multiple times to send multiple emails, like:
--recipient alice@example.com --recipient bob@example.com

this is mostly useful for testing, especially for dashboard issues seen only by a specific user. for typical dashboard emails, set recipients via the subscription settings in the web UI. (yes, the web UI. she said what she said. πŸ’…)

  • --log LEVEL β€” adjust the LogToSTDERR config option.
  • --statement-log LEVEL β€” log any SQL queries produced at the specified log level. this works similar to the $StatementLog option in the main RT config file. πŸ”

friendly reminder bestie: --dryrun is your bestie for testing, and --all is a debugging-only situation. don't be out here blasting every dashboard into everyone's inbox at once, that's not the vibe. 🫢

and that's the whole page, bestie!! this was built on perl v5.40.1, dated 2026-06-21, and it lives its life as one of the rt-email-dashboards(8) girlies. go run your cron job and hydrate. πŸ’œβœ¨

πŸ“¦ where this page comes from