Skip to content

Commit

Permalink
Merge pull request #49743 from yoshixi/improve-action-mailbox-inciner…
Browse files Browse the repository at this point in the history
…ation-doc-1

Improve docs for the action-mail box incineration
  • Loading branch information
vipulnsward committed Nov 23, 2023
2 parents e7ea111 + 2655cad commit 408faa2
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions guides/source/action_mailbox_basics.md
Expand Up @@ -324,9 +324,11 @@ end

## Incineration of InboundEmails

By default, an InboundEmail that has been successfully processed will be
incinerated after 30 days. This ensures you're not holding on to people's data
willy-nilly after they may have canceled their accounts or deleted their
By default, an [`InboundEmail`][] that has been processed will be
incinerated after 30 days. The InboundEmail is considered as processed
when its status changes to delivered, failed or bounced.
This ensures you're not holding on to people's data willy-nilly
after they may have canceled their accounts or deleted their
content. The intention is that after you've processed an email, you should have
extracted all the data you needed and turned it into domain models and content
on your side of the application. The InboundEmail simply stays in the system
Expand All @@ -338,6 +340,7 @@ by default set to `30.days`, but you can change it in your production.rb
configuration. (Note that this far-future incineration scheduling relies on
your job queue being able to hold jobs for that long.)

[`InboundEmail`]: https://edgeapi.rubyonrails.org/classes/ActionMailbox/InboundEmail.html
[`config.action_mailbox.incinerate_after`]: configuring.html#config-action-mailbox-incinerate-after

## Working with Action Mailbox in Development
Expand Down

0 comments on commit 408faa2

Please sign in to comment.