diff options
author | George Claghorn <george@basecamp.com> | 2019-01-01 16:52:54 -0500 |
---|---|---|
committer | George Claghorn <george@basecamp.com> | 2019-01-01 16:52:54 -0500 |
commit | 0d40c62213cf0be58a470637bd364e92c5666402 (patch) | |
tree | f72e9c9fa96d3132b69661df845a6fd7ba9ff804 /guides | |
parent | d9630c4815c60f87e91361f578e53e8d987ad0ae (diff) | |
download | rails-0d40c62213cf0be58a470637bd364e92c5666402.tar.gz rails-0d40c62213cf0be58a470637bd364e92c5666402.tar.bz2 rails-0d40c62213cf0be58a470637bd364e92c5666402.zip |
Document Action Mailbox configuration options [ci skip]
Diffstat (limited to 'guides')
-rw-r--r-- | guides/source/configuring.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/guides/source/configuring.md b/guides/source/configuring.md index 7193278581..ed3c406693 100644 --- a/guides/source/configuring.md +++ b/guides/source/configuring.md @@ -619,6 +619,29 @@ Defaults to `'signed cookie'`. development mode, but for large test suites, disabling this option in the test environment can improve performance. This defaults to `true`. + +### Configuring Action Mailbox + +`config.action_mailbox` provides the following configuration options: + +* `config.action_mailbox.logger` contains the logger used by Action Mailbox. It accepts a logger conforming to the interface of Log4r or the default Ruby Logger class. The default is `Rails.logger`. + + ```ruby + config.action_mailbox.logger = ActiveSupport::Logger.new(STDOUT) + ``` + +* `config.action_mailbox.incinerate_after` accepts an `ActiveSupport::Duration` indicating how long after processing `ActionMailbox::InboundEmail` records should be destroyed. It defaults to `30.days`. + + ```ruby + # Incinerate inbound emails 14 days after processing. + config.action_mailbox.incinerate_after = 14.days + ``` + +* `config.action_mailbox.queues.incineration` accepts a symbol indicating the Active Job queue to use for incineration jobs. It defaults to `:action_mailbox_incineration`. + +* `config.action_mailbox.queues.routing` accepts a symbol indicating the Active Job queue to use for routing jobs. It defaults to `:action_mailbox_routing`. + + ### Configuring Action Mailer There are a number of settings available on `config.action_mailer`: |