-
-
Notifications
You must be signed in to change notification settings - Fork 41
/
Copy pathMailboxExampleGroup.html
249 lines (249 loc) · 11.8 KB
/
MailboxExampleGroup.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec::Rails::MailboxExampleGroup
— Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/7.0/rspec-rails/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/7.0/rspec-rails/css/common.css" type="text/css" />
<link rel="stylesheet" href="/documentation/7.0/rspec-rails/css/rspec.css" type="text/css" />
<script type="text/javascript">
pathId = "RSpec::Rails::MailboxExampleGroup";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="/documentation/7.0/rspec-rails/js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="/documentation/7.0/rspec-rails/js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (M)</a> »
<span class='title'><span class='object_link'><a href="../../RSpec.html" title="RSpec (module)">RSpec</a></span></span> » <span class='title'><span class='object_link'><a href="../Rails.html" title="RSpec::Rails (module)">Rails</a></span></span>
»
<span class="title">MailboxExampleGroup</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: RSpec::Rails::MailboxExampleGroup
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd>ActionMailbox::TestHelper, ActiveSupport::Concern</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rspec/rails/example/mailbox_example_group.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Container module for mailbox spec functionality.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#have_been_delivered-instance_method" title="#have_been_delivered (instance method)">#<strong>have_been_delivered</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Passes if the inbound email was delivered.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#have_bounced-instance_method" title="#have_bounced (instance method)">#<strong>have_bounced</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Passes if the inbound email bounced during processing.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#have_failed-instance_method" title="#have_failed (instance method)">#<strong>have_failed</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Passes if the inbound email failed to process.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#process-instance_method" title="#process (instance method)">#<strong>process</strong>(message) ⇒ ActionMailbox::InboundMessage </a>
</span>
<span class="summary_desc"><div class='inline'><p>Process an inbound email message directly, bypassing routing.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="have_been_delivered-instance_method">
#<strong>have_been_delivered</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Passes if the inbound email was delivered</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_inbound_email'>inbound_email</span> <span class='op'>=</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_inbound_email'>inbound_email</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_delivered'>have_been_delivered</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
44
45
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/mailbox_example_group.rb', line 44</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_been_delivered'>have_been_delivered</span>
<span class='id identifier rubyid_satisfy'>satisfy</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>have been delivered</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='op'>&</span><span class='symbol'>:delivered?</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="have_bounced-instance_method">
#<strong>have_bounced</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Passes if the inbound email bounced during processing</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_inbound_email'>inbound_email</span> <span class='op'>=</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_inbound_email'>inbound_email</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_bounced'>have_bounced</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/mailbox_example_group.rb', line 54</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_bounced'>have_bounced</span>
<span class='id identifier rubyid_satisfy'>satisfy</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>have bounced</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='op'>&</span><span class='symbol'>:bounced?</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="have_failed-instance_method">
#<strong>have_failed</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Passes if the inbound email failed to process</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_inbound_email'>inbound_email</span> <span class='op'>=</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_inbound_email'>inbound_email</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_failed'>have_failed</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
64
65
66</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/mailbox_example_group.rb', line 64</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_failed'>have_failed</span>
<span class='id identifier rubyid_satisfy'>satisfy</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>have failed</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='op'>&</span><span class='symbol'>:failed?</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="process-instance_method">
#<strong>process</strong>(message) ⇒ <tt>ActionMailbox::InboundMessage</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Process an inbound email message directly, bypassing routing.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>message</span>
<span class='type'>(<tt>Hash</tt>, <tt>Mail::Message</tt>)</span>
—
<div class='inline'><p>a mail message or hash of
attributes used to build one</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>ActionMailbox::InboundMessage</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
73
74
75
76
77</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/example/mailbox_example_group.rb', line 73</span>
<span class='kw'>def</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="" title="RSpec::Rails::MailboxExampleGroup (module)">MailboxExampleGroup</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create_inbound_email'>create_inbound_email</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_mail'>mail</span><span class='op'>|</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_mailbox_class'>mailbox_class</span><span class='period'>.</span><span class='id identifier rubyid_receive'>receive</span><span class='lparen'>(</span><span class='id identifier rubyid_mail'>mail</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Sep 4 12:48:49 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.2.2).
</div>
</div>
</body>
</html>