Merge pull request #44688 from lewispb/action-mailbox-notification-docs

Document Action Mailbox instrumentation
rails · Mar 15, 2022 · 4d7a956 · 4d7a956
2 parents aed8fea + b04fa78
commit 4d7a956
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/guides/source/active_support_instrumentation.md b/guides/source/active_support_instrumentation.md
@@ -686,6 +686,26 @@ INFO. The only ActiveStorage service that provides this hook so far is GCS.
 | ------------ | ------------------------------ |
 | `:analyzer`  | Name of analyzer e.g., ffprobe |
 
+### Action Mailbox
+
+#### process.action_mailbox
+
+| Key              | Value                                                             |
+| -----------------| ----------------------------------------------------------------- |
+| `:mailbox`       | Instance of the Mailbox class inheriting from ActionMailbox::Base |
+| `:inbound_email` | Hash with data about the inbound email being processed            |
+
+```ruby
+{
+  mailbox: #<RepliesMailbox:0x00007f9f7a8388>,
+  inbound_email: {
+    id: 1,
+    message_id: "0CB459E0-0336-41DA-BC88-E6E28C697DDB@37signals.com",
+    status: "processing"
+  }
+}
+```
+
 ### Railties
 
 #### load_config_initializer.railties