aboutsummaryrefslogtreecommitdiffstats
path: root/lib/action_mailbox/router
diff options
context:
space:
mode:
Diffstat (limited to 'lib/action_mailbox/router')
-rw-r--r--lib/action_mailbox/router/route.rb3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/action_mailbox/router/route.rb b/lib/action_mailbox/router/route.rb
index 5254043a67..6472b9a31d 100644
--- a/lib/action_mailbox/router/route.rb
+++ b/lib/action_mailbox/router/route.rb
@@ -1,3 +1,6 @@
+# Encapsulates a route, which can then be matched against an inbound_email and provide a lookup of the matching
+# mailbox class. See examples for the different route addresses and how to use them in the `ActionMailbox::Base`
+# documentation.
class ActionMailbox::Router::Route
attr_reader :address, :mailbox_name