Skip to main content

email-alert-api: Rake tasks

These rake tasks come from the desc descriptions in email-alert-api’s lib/tasks folder. To change what’s shown here, change the description in the code.

alert_listeners:verify_or_create

Verify or create medical/travel alert listener

k exec deploy/email-alert-api -- rake alert_listeners:verify_or_create

View source (lib/tasks/alert_listeners.rake)

bulk_email:for_lists

Send a bulk email to many subscriber lists. Any email addresses in config/bulk_email/email_addresses.txt will be skipped.

k exec deploy/email-alert-api -- rake bulk_email:for_lists

View source (lib/tasks/bulk_email.rake)

bulk_email:for_lists_and_explicitly_including_addresses

Send a bulk email to many subscriber lists but only if the subscriber’s email addresses are in config/bulk_email/email_addresses.txt.

k exec deploy/email-alert-api -- rake bulk_email:for_lists_and_explicitly_including_addresses

View source (lib/tasks/bulk_email.rake)

data_migration:move_all_subscribers

Move all subscribers from one subscriber list to another

k exec deploy/email-alert-api -- rake data_migration:move_all_subscribers[from_slug,to_slug]

View source (lib/tasks/data_migration.rake)

data_migration:rename_alert_subscription_lists

Rename an alert type and all combinations of subscriptions to it

k exec deploy/email-alert-api -- rake data_migration:rename_alert_subscription_lists[from_slug,to_slug]

View source (lib/tasks/data_migration.rake)

data_migration:update_subscriber_list_slug

Update subscriber list slug

k exec deploy/email-alert-api -- rake data_migration:update_subscriber_list_slug[slug,new_slug]

View source (lib/tasks/data_migration.rake)

data_migration:update_subscriber_list_tag

Update one of the tags in a subscriber list

k exec deploy/email-alert-api -- rake data_migration:update_subscriber_list_tag[key,old_criterion,new_criterion]

View source (lib/tasks/data_migration.rake)

report:matched_content_changes

Outputs a CSV of content changes by subscriber list

k exec deploy/email-alert-api -- rake report:matched_content_changes

View source (lib/tasks/report.rake)

report:csv_subscriber_lists

Outputs a CSV of information for each subscriber list within a year for a past date, format: ‘yyyy-mm-dd’

k exec deploy/email-alert-api -- rake report:csv_subscriber_lists[date]

View source (lib/tasks/report.rake)

report:find_subscriber_list_by_title

Find subscriber lists by title match

k exec deploy/email-alert-api -- rake report:find_subscriber_list_by_title[title]

View source (lib/tasks/report.rake)

report:potentially_dead_lists

Outputs a CSV of subscriber lists that appear to be inactive (tech debt)

k exec deploy/email-alert-api -- rake report:potentially_dead_lists

View source (lib/tasks/report.rake)

report:subscriber_list_subscriber_count

Output a simple count of subscribers by the subscriber_list URL

k exec deploy/email-alert-api -- rake report:subscriber_list_subscriber_count[url,active_on_date]

View source (lib/tasks/report.rake)

report:subscriber_list_by_slug_subscriber_count

Output a simple count of active subscribers by subscriber_list slug

k exec deploy/email-alert-api -- rake report:subscriber_list_by_slug_subscriber_count[slug]

View source (lib/tasks/report.rake)

report:subscriber_count_list

Output a subscribers count list for past dates by the subscriber_list URL

k exec deploy/email-alert-api -- rake report:subscriber_count_list[url,start_date,end_date]

View source (lib/tasks/report.rake)

report:single_page_notifications_top_subscriber_lists

Output a report of top single page notification subscriber lists

k exec deploy/email-alert-api -- rake report:single_page_notifications_top_subscriber_lists[limit]

View source (lib/tasks/report.rake)

report:historical_content_change_statistics

Output how many people were notified for recent content changes to the page at the given path

k exec deploy/email-alert-api -- rake report:historical_content_change_statistics[govuk_path]

View source (lib/tasks/report.rake)

report:future_content_change_statistics

Output how many people would be notified if a major change were published at the given path

k exec deploy/email-alert-api -- rake report:future_content_change_statistics[govuk_path,draft]

View source (lib/tasks/report.rake)

report:finder_statistics

Output how many people are subscribed to lists created from a finder at the given path

k exec deploy/email-alert-api -- rake report:finder_statistics[govuk_path]

View source (lib/tasks/report.rake)

subscriber_list_audit:start

Create audit workers

k exec deploy/email-alert-api -- rake subscriber_list_audit:start[batch_size]

View source (lib/tasks/subscriber_list_audit.rake)

subscriber_list_audit:queue_size

Check audit worker queue size

k exec deploy/email-alert-api -- rake subscriber_list_audit:queue_size

View source (lib/tasks/subscriber_list_audit.rake)

subscriber_list_audit:report

Show Subscriber Lists unaudited since a given date (defaults to now)

k exec deploy/email-alert-api -- rake subscriber_list_audit:report[since_date]

View source (lib/tasks/subscriber_list_audit.rake)

support:view_subscriptions

View all subscriptions for a subscriber

k exec deploy/email-alert-api -- rake support:view_subscriptions[email_address]

View source (lib/tasks/support.rake)

support:view_emails

View most recent email emails for a subscriber

k exec deploy/email-alert-api -- rake support:view_emails[email_address,limit]

View source (lib/tasks/support.rake)

support:change_email_address

Change the email address of a subscriber

k exec deploy/email-alert-api -- rake support:change_email_address[old_email_address,new_email_address]

View source (lib/tasks/support.rake)

support:unsubscribe_single_subscription

Unsubscribe a subscriber from a single subscription

k exec deploy/email-alert-api -- rake support:unsubscribe_single_subscription[email_address,subscriber_list_slug]

View source (lib/tasks/support.rake)

support:unsubscribe_all_subscribers_from_subscription

Unsubscribe all active subscribers from a single subscription list

k exec deploy/email-alert-api -- rake support:unsubscribe_all_subscribers_from_subscription[subscriber_list_slug]

View source (lib/tasks/support.rake)

support:unsubscribe_all_subscriptions

Unsubscribe a subscriber from all subscriptions

k exec deploy/email-alert-api -- rake support:unsubscribe_all_subscriptions[email_address]

View source (lib/tasks/support.rake)

support:get_notifications_from_notify_by_email_id

Query the Notify API for email(s) by email ID

k exec deploy/email-alert-api -- rake support:get_notifications_from_notify_by_email_id[id]

View source (lib/tasks/support.rake)

support:send_test_email

Send a test email to an email address

k exec deploy/email-alert-api -- rake support:send_test_email[email_address]

View source (lib/tasks/support.rake)

support:resend_failed_emails:by_id

Re-send failed emails by email ids

k exec deploy/email-alert-api -- rake support:resend_failed_emails:by_id

View source (lib/tasks/support.rake)

support:resend_failed_emails:by_date

Re-send failed emails by date range

k exec deploy/email-alert-api -- rake support:resend_failed_emails:by_date[from,to]

View source (lib/tasks/support.rake)

support:emails:stats_for_content_id

Show delivery statistics for a content_id

k exec deploy/email-alert-api -- rake support:emails:stats_for_content_id[content_id,start_date,end_date]

View source (lib/tasks/support.rake)