-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathEpochtalkServer.Mailer.html
418 lines (298 loc) · 14.7 KB
/
EpochtalkServer.Mailer.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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.37.2">
<meta name="project" content="epochtalk_server v0.1.0">
<title>EpochtalkServer.Mailer — epochtalk_server v0.1.0</title>
<link rel="stylesheet" href="dist/html-elixir-6X3L5KMG.css" />
<script defer src="dist/sidebar_items-C8922E45.js"></script>
<script defer src="docs_config.js"></script>
<script defer src="dist/html-6XHBGSGW.js"></script>
</head>
<body>
<script>(()=>{var t="ex_doc:settings",e="dark";var o="dark",s="light";var E="sidebar_state",n="closed";var r="sidebar_width";var a="sidebar-open";var i=new URLSearchParams(window.location.search),S=i.get("theme")||JSON.parse(localStorage.getItem(t)||"{}").theme;(S===o||S!==s&&window.matchMedia("(prefers-color-scheme: dark)").matches)&&document.body.classList.add(e);var d=sessionStorage.getItem(E),A=d!==n&&!window.matchMedia(`screen and (max-width: ${768}px)`).matches;document.body.classList.toggle(a,A);var c=sessionStorage.getItem(r);c&&document.body.style.setProperty("--sidebarWidth",`${c}px`);var p=/(Macintosh|iPhone|iPad|iPod)/.test(window.navigator.userAgent);document.documentElement.classList.toggle("apple-os",p);})();
</script>
<div class="body-wrapper">
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<nav id="sidebar" class="sidebar">
<div class="sidebar-header">
<div class="sidebar-projectInfo">
<div>
<a href="api-reference.html" class="sidebar-projectName" translate="no">
epochtalk_server
</a>
<div class="sidebar-projectVersion" translate="no">
v0.1.0
</div>
</div>
</div>
<ul id="sidebar-list-nav" class="sidebar-list-nav" role="tablist" data-extras=""></ul>
</div>
</nav>
<output role="status" id="toast"></output>
<main class="content page-module" id="main" data-type="modules">
<div id="content" class="content-inner">
<div class="top-search">
<div class="search-settings">
<form class="search-bar" action="search.html">
<label class="search-label">
<span class="sr-only">Search documentation of epochtalk_server</span>
<input name="q" type="text" class="search-input" placeholder="Press / to search" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
<button type="submit" class="search-button" aria-label="Submit Search" tabindex="-1">
<i class="ri-search-2-line ri-lg" aria-hidden="true"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
<i class="ri-close-line ri-lg" title="Cancel search"></i>
</button>
</form>
<div class="autocomplete">
</div>
<button class="icon-settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
</div>
</div>
<div id="top-content">
<div class="heading-with-actions top-heading">
<h1>
<span translate="no">EpochtalkServer.Mailer</span>
<small class="app-vsn" translate="no">(epochtalk_server v0.1.0)</small>
</h1>
</div>
<section id="moduledoc">
<p>Used to generate and send emails from the API to a <code class="inline">User</code>.</p>
</section>
</div>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Summary</span>
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#deliver/2" data-no-tooltip="" translate="no">deliver(email, config \\ [])</a>
</div>
<div class="summary-synopsis"><p>Delivers an email.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#deliver!/2" data-no-tooltip="" translate="no">deliver!(email, config \\ [])</a>
</div>
<div class="summary-synopsis"><p>Delivers an email, raises on error.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#deliver_many/2" data-no-tooltip="" translate="no">deliver_many(emails, config \\ [])</a>
</div>
<div class="summary-synopsis"><p>Delivers a list of emails.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#send_confirm_account/1" data-no-tooltip="" translate="no">send_confirm_account(user)</a>
</div>
<div class="summary-synopsis"><p>Sends confirmation email</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#send_mention_notification/1" data-no-tooltip="" translate="no">send_mention_notification(map)</a>
</div>
<div class="summary-synopsis"><p>Sends mention notification email</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#send_thread_purge/1" data-no-tooltip="" translate="no">send_thread_purge(map)</a>
</div>
<div class="summary-synopsis"><p>Sends thread purge email</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#send_thread_subscription/1" data-no-tooltip="" translate="no">send_thread_subscription(map)</a>
</div>
<div class="summary-synopsis"><p>Sends thread subscription email</p></div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Functions</span>
</h1>
<div class="functions-list">
<section class="detail" id="deliver/2">
<span id="deliver/1"></span>
<div class="detail-header">
<a href="#deliver/2" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<div class="heading-with-actions">
<h1 class="signature" translate="no">deliver(email, config \\ [])</h1>
</div>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> deliver(<a href="https://hexdocs.pm/swoosh/1.17.10/Swoosh.Email.html#t:t/0">Swoosh.Email.t</a>(), <a href="https://hexdocs.pm/elixir/Keyword.html#t:t/0">Keyword.t</a>()) :: {:ok, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()} | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()}</pre>
</div>
<p>Delivers an email.</p><p>If the email is delivered it returns an <code class="inline">{:ok, result}</code> tuple. If it fails,
returns an <code class="inline">{:error, error}</code> tuple.</p>
</section>
</section>
<section class="detail" id="deliver!/2">
<span id="deliver!/1"></span>
<div class="detail-header">
<a href="#deliver!/2" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<div class="heading-with-actions">
<h1 class="signature" translate="no">deliver!(email, config \\ [])</h1>
</div>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> deliver!(<a href="https://hexdocs.pm/swoosh/1.17.10/Swoosh.Email.html#t:t/0">Swoosh.Email.t</a>(), <a href="https://hexdocs.pm/elixir/Keyword.html#t:t/0">Keyword.t</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
</div>
<p>Delivers an email, raises on error.</p><p>If the email is delivered, it returns the result. If it fails, it raises
a <code class="inline">DeliveryError</code>.</p>
</section>
</section>
<section class="detail" id="deliver_many/2">
<span id="deliver_many/1"></span>
<div class="detail-header">
<a href="#deliver_many/2" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<div class="heading-with-actions">
<h1 class="signature" translate="no">deliver_many(emails, config \\ [])</h1>
</div>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> deliver_many(
[
%Swoosh.Email{
assigns: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
attachments: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
bcc: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
cc: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
from: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
headers: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
html_body: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
private: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
provider_options: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
reply_to: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
subject: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
text_body: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
to: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()
}
],
<a href="https://hexdocs.pm/elixir/Keyword.html#t:t/0">Keyword.t</a>()
) :: {:ok, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()} | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()}</pre>
</div>
<p>Delivers a list of emails.</p><p>It accepts a list of <code class="inline">%Swoosh.Email{}</code> as its first parameter.</p>
</section>
</section>
<section class="detail" id="send_confirm_account/1">
<div class="detail-header">
<a href="#send_confirm_account/1" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<div class="heading-with-actions">
<h1 class="signature" translate="no">send_confirm_account(user)</h1>
</div>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> send_confirm_account(recipient :: <a href="EpochtalkServer.Models.User.html#t:t/0">EpochtalkServer.Models.User.t</a>()) ::
{:ok, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()} | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()}</pre>
</div>
<p>Sends confirmation email</p>
</section>
</section>
<section class="detail" id="send_mention_notification/1">
<div class="detail-header">
<a href="#send_mention_notification/1" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<div class="heading-with-actions">
<h1 class="signature" translate="no">send_mention_notification(map)</h1>
</div>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> send_mention_notification(email_data :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()) ::
{:ok, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()} | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()}</pre>
</div>
<p>Sends mention notification email</p>
</section>
</section>
<section class="detail" id="send_thread_purge/1">
<div class="detail-header">
<a href="#send_thread_purge/1" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<div class="heading-with-actions">
<h1 class="signature" translate="no">send_thread_purge(map)</h1>
</div>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> send_thread_purge(email_data :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()) :: {:ok, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()} | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()}</pre>
</div>
<p>Sends thread purge email</p>
</section>
</section>
<section class="detail" id="send_thread_subscription/1">
<div class="detail-header">
<a href="#send_thread_subscription/1" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<div class="heading-with-actions">
<h1 class="signature" translate="no">send_thread_subscription(map)</h1>
</div>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> send_thread_subscription(email_data :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>()) ::
{:ok, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()} | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()}</pre>
</div>
<p>Sends thread subscription email</p>
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="epochtalk_server.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.37.2) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</main>
</div>
</body>
</html>