Skip to content

Commit 408faa2

Browse files
authored
Merge pull request rails#49743 from yoshixi/improve-action-mailbox-incineration-doc-1
Improve docs for the action-mail box incineration
2 parents e7ea111 + 2655cad commit 408faa2

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

guides/source/action_mailbox_basics.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -324,9 +324,11 @@ end
324324

325325
## Incineration of InboundEmails
326326

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

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

343346
## Working with Action Mailbox in Development

0 commit comments

Comments
 (0)