-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathActionMailbox.html
256 lines (124 loc) · 10.2 KB
/
ActionMailbox.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
---
title: ActionMailbox
layout: default
---
<div class="main">
<div class="banner">
<span>Ruby on Rails 8.0.0</span><br />
<div class="type">Module</div>
<h1>
ActionMailbox
</h1>
<ul class="files">
<li><a href="../files/actionmailbox/app/controllers/action_mailbox/base_controller_rb.html">actionmailbox/app/controllers/action_mailbox/base_controller.rb</a></li>
<li><a href="../files/actionmailbox/app/controllers/action_mailbox/ingresses/mailgun/inbound_emails_controller_rb.html">actionmailbox/app/controllers/action_mailbox/ingresses/mailgun/inbound_emails_controller.rb</a></li>
<li><a href="../files/actionmailbox/app/controllers/action_mailbox/ingresses/mandrill/inbound_emails_controller_rb.html">actionmailbox/app/controllers/action_mailbox/ingresses/mandrill/inbound_emails_controller.rb</a></li>
<li><a href="../files/actionmailbox/app/controllers/action_mailbox/ingresses/postmark/inbound_emails_controller_rb.html">actionmailbox/app/controllers/action_mailbox/ingresses/postmark/inbound_emails_controller.rb</a></li>
<li><a href="../files/actionmailbox/app/controllers/action_mailbox/ingresses/relay/inbound_emails_controller_rb.html">actionmailbox/app/controllers/action_mailbox/ingresses/relay/inbound_emails_controller.rb</a></li>
<li><a href="../files/actionmailbox/app/controllers/action_mailbox/ingresses/sendgrid/inbound_emails_controller_rb.html">actionmailbox/app/controllers/action_mailbox/ingresses/sendgrid/inbound_emails_controller.rb</a></li>
<li><a href="../files/actionmailbox/app/jobs/action_mailbox/incineration_job_rb.html">actionmailbox/app/jobs/action_mailbox/incineration_job.rb</a></li>
<li><a href="../files/actionmailbox/app/jobs/action_mailbox/routing_job_rb.html">actionmailbox/app/jobs/action_mailbox/routing_job.rb</a></li>
<li><a href="../files/actionmailbox/app/models/action_mailbox/inbound_email_rb.html">actionmailbox/app/models/action_mailbox/inbound_email.rb</a></li>
<li><a href="../files/actionmailbox/app/models/action_mailbox/inbound_email/incineratable_rb.html">actionmailbox/app/models/action_mailbox/inbound_email/incineratable.rb</a></li>
<li><a href="../files/actionmailbox/app/models/action_mailbox/inbound_email/incineratable/incineration_rb.html">actionmailbox/app/models/action_mailbox/inbound_email/incineratable/incineration.rb</a></li>
<li><a href="../files/actionmailbox/app/models/action_mailbox/inbound_email/message_id_rb.html">actionmailbox/app/models/action_mailbox/inbound_email/message_id.rb</a></li>
<li><a href="../files/actionmailbox/app/models/action_mailbox/inbound_email/routable_rb.html">actionmailbox/app/models/action_mailbox/inbound_email/routable.rb</a></li>
<li><a href="../files/actionmailbox/app/models/action_mailbox/record_rb.html">actionmailbox/app/models/action_mailbox/record.rb</a></li>
<li><a href="../files/actionmailbox/lib/action_mailbox_rb.html">actionmailbox/lib/action_mailbox.rb</a></li>
<li><a href="../files/actionmailbox/lib/action_mailbox/base_rb.html">actionmailbox/lib/action_mailbox/base.rb</a></li>
<li><a href="../files/actionmailbox/lib/action_mailbox/callbacks_rb.html">actionmailbox/lib/action_mailbox/callbacks.rb</a></li>
<li><a href="../files/actionmailbox/lib/action_mailbox/deprecator_rb.html">actionmailbox/lib/action_mailbox/deprecator.rb</a></li>
<li><a href="../files/actionmailbox/lib/action_mailbox/engine_rb.html">actionmailbox/lib/action_mailbox/engine.rb</a></li>
<li><a href="../files/actionmailbox/lib/action_mailbox/gem_version_rb.html">actionmailbox/lib/action_mailbox/gem_version.rb</a></li>
<li><a href="../files/actionmailbox/lib/action_mailbox/relayer_rb.html">actionmailbox/lib/action_mailbox/relayer.rb</a></li>
<li><a href="../files/actionmailbox/lib/action_mailbox/router_rb.html">actionmailbox/lib/action_mailbox/router.rb</a></li>
<li><a href="../files/actionmailbox/lib/action_mailbox/router/route_rb.html">actionmailbox/lib/action_mailbox/router/route.rb</a></li>
<li><a href="../files/actionmailbox/lib/action_mailbox/routing_rb.html">actionmailbox/lib/action_mailbox/routing.rb</a></li>
<li><a href="../files/actionmailbox/lib/action_mailbox/test_case_rb.html">actionmailbox/lib/action_mailbox/test_case.rb</a></li>
<li><a href="../files/actionmailbox/lib/action_mailbox/test_helper_rb.html">actionmailbox/lib/action_mailbox/test_helper.rb</a></li>
<li><a href="../files/actionmailbox/lib/action_mailbox/version_rb.html">actionmailbox/lib/action_mailbox/version.rb</a></li>
<li><a href="../files/railties/lib/rails/commands/app/update_command_rb.html">railties/lib/rails/commands/app/update_command.rb</a></li>
</ul>
</div>
<div id="bodyContent">
<div id="content">
<div class="description">
<h1 id="module-ActionMailbox-label-Action+Mailbox">Action Mailbox</h1>
<p>Action Mailbox routes incoming emails to controller-like mailboxes for processing in Rails. It ships with ingresses for Mailgun, Mandrill, Postmark, and SendGrid. You can also handle inbound mails directly via the built-in Exim, Postfix, and Qmail ingresses.</p>
<p>The inbound emails are turned into <code>InboundEmail</code> records using Active Record and feature lifecycle tracking, storage of the original email on cloud storage via Active Storage, and responsible data handling with on-by-default incineration.</p>
<p>These inbound emails are routed asynchronously using Active Job to one or several dedicated mailboxes, which are capable of interacting directly with the rest of your domain model.</p>
<p>You can read more about Action Mailbox in the <a href="https://guides.rubyonrails.org/action_mailbox_basics.html">Action Mailbox Basics</a> guide.</p>
<h2 id="module-ActionMailbox-label-License">License</h2>
<p>Action Mailbox is released under the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
</div>
<h2 id="namespace">Namespace</h2>
<h3 id="module">Module</h3>
<ul>
<li><a href="ActionMailbox/Callbacks.html">ActionMailbox::Callbacks</a></li>
<li><a href="ActionMailbox/Ingresses.html">ActionMailbox::Ingresses</a></li>
<li><a href="ActionMailbox/Routing.html">ActionMailbox::Routing</a></li>
<li><a href="ActionMailbox/TestHelper.html">ActionMailbox::TestHelper</a></li>
<li><a href="ActionMailbox/VERSION.html">ActionMailbox::VERSION</a></li>
</ul>
<h3 id="class">Class</h3>
<ul>
<li><a href="ActionMailbox/Base.html">ActionMailbox::Base</a></li>
<li><a href="ActionMailbox/BaseController.html">ActionMailbox::BaseController</a></li>
<li><a href="ActionMailbox/Engine.html">ActionMailbox::Engine</a></li>
<li><a href="ActionMailbox/InboundEmail.html">ActionMailbox::InboundEmail</a></li>
<li><a href="ActionMailbox/IncinerationJob.html">ActionMailbox::IncinerationJob</a></li>
<li><a href="ActionMailbox/Relayer.html">ActionMailbox::Relayer</a></li>
<li><a href="ActionMailbox/Router.html">ActionMailbox::Router</a></li>
<li><a href="ActionMailbox/RoutingJob.html">ActionMailbox::RoutingJob</a></li>
<li><a href="ActionMailbox/TestCase.html">ActionMailbox::TestCase</a></li>
</ul>
<h2 id="methods">Methods</h2>
<ul>
<li>
<a href="#method-c-gem_version">gem_version</a>
</li>
<li>
<a href="#method-c-version">version</a>
</li>
</ul>
<!-- Methods -->
<h2 id="class-public-methods">Class Public methods</h2>
<div class="method">
<h3 id="method-c-gem_version">
gem_version()
</h3>
<div class="description">
<p>Returns the currently loaded version of Action Mailbox as a <code>Gem::Version</code>.</p>
</div>
<details class="method__source">
<summary>
<span class="label">📝 Source code</span>
</summary>
<pre><code class="ruby"># File actionmailbox/lib/action_mailbox/gem_version.rb, line 5
def self.gem_version
Gem::Version.new VERSION::STRING
end</code></pre>
<a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/actionmailbox/lib/action_mailbox/gem_version.rb#L5" target="_blank" class="github_url">🔎 See on GitHub</a>
</details>
</div>
<div class="method">
<h3 id="method-c-version">
version()
</h3>
<div class="description">
<p>Returns the currently loaded version of Action Mailbox as a <code>Gem::Version</code>.</p>
</div>
<details class="method__source">
<summary>
<span class="label">📝 Source code</span>
</summary>
<pre><code class="ruby"># File actionmailbox/lib/action_mailbox/version.rb, line 7
def self.version
gem_version
end</code></pre>
<a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/actionmailbox/lib/action_mailbox/version.rb#L7" target="_blank" class="github_url">🔎 See on GitHub</a>
</details>
</div>
</div>
</div>
</div>