From 6edccec1b97af46d2133ce701d7c307d213da9c6 Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Wed, 12 Dec 2018 16:34:05 -0800 Subject: Basic docs for most classes --- app/jobs/action_mailbox/incineration_job.rb | 5 +++++ app/jobs/action_mailbox/routing_job.rb | 2 ++ 2 files changed, 7 insertions(+) (limited to 'app/jobs') diff --git a/app/jobs/action_mailbox/incineration_job.rb b/app/jobs/action_mailbox/incineration_job.rb index 4fc0cb0782..3c6c9aae4f 100644 --- a/app/jobs/action_mailbox/incineration_job.rb +++ b/app/jobs/action_mailbox/incineration_job.rb @@ -1,3 +1,8 @@ +# You can configure when this `IncinerationJob` will be run as a time-after-processing using the +# `config.action_mailbox.incinerate_after` or `ActionMailbox.incinerate_after` setting. +# +# Since this incineration is set for the future, it'll automatically ignore any `InboundEmail`s +# that have already been deleted and discard itself if so. class ActionMailbox::IncinerationJob < ActiveJob::Base queue_as { ActionMailbox.queues[:incineration] } diff --git a/app/jobs/action_mailbox/routing_job.rb b/app/jobs/action_mailbox/routing_job.rb index 786187528a..c345227617 100644 --- a/app/jobs/action_mailbox/routing_job.rb +++ b/app/jobs/action_mailbox/routing_job.rb @@ -1,3 +1,5 @@ +# Routing a new InboundEmail is an asynchronous operation, which allows the ingress controllers to quickly +# accept new incoming emails without being burdened to hang while they're actually being processed. class ActionMailbox::RoutingJob < ActiveJob::Base queue_as { ActionMailbox.queues[:routing] } -- cgit v1.2.3