PageRenderTime 34ms CodeModel.GetById 22ms app.highlight 7ms RepoModel.GetById 1ms app.codeStats 0ms

/doc/modules/mod_email_receive/mod_email_receive.html

https://code.google.com/p/zotonic/
HTML | 65 lines | 54 code | 11 blank | 0 comment | 0 complexity | 5a418e4c193e82c06dd0287d2eec35d7 MD5 | raw file
 1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 2<html>
 3<head>
 4<title>Module mod_email_receive</title>
 5<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
 6</head>
 7<body bgcolor="white">
 8<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
 9<hr>
10
11<h1>Module mod_email_receive</h1>
12<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Handle received e-mails, notifies email observers depending on the recipient.
13<p>Copyright Š 2011 Marc Worrell</p>
14
15<p><b>Authors:</b> Marc Worrell (<a href="mailto:marc@worrell.nl"><tt>marc@worrell.nl</tt></a>).</p>
16
17<h2><a name="description">Description</a></h2>Handle received e-mails, notifies email observers depending on the recipient.
18<h2><a name="index">Function Index</a></h2>
19<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#event-2">event/2</a></td><td></td></tr>
20<tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr>
21<tr><td valign="top"><a href="#observe_email_add_handler-2">observe_email_add_handler/2</a></td><td>Add an email handler, returns the email address for the handler.</td></tr>
22<tr><td valign="top"><a href="#observe_email_drop_handler-2">observe_email_drop_handler/2</a></td><td>Drop all handlers matching the parameters.</td></tr>
23<tr><td valign="top"><a href="#observe_email_ensure_handler-2">observe_email_ensure_handler/2</a></td><td>Ensure that en email handler exists.</td></tr>
24<tr><td valign="top"><a href="#observe_email_received-2">observe_email_received/2</a></td><td>Find handlers based on the recipient, forward the e-mail to those handlers.</td></tr>
25</table>
26
27<h2><a name="functions">Function Details</a></h2>
28
29<h3 class="function"><a name="event-2">event/2</a></h3>
30<div class="spec">
31<p><tt>event(Event, Context) -&gt; any()</tt></p>
32</div>
33
34<h3 class="function"><a name="init-1">init/1</a></h3>
35<div class="spec">
36<p><tt>init(Context) -&gt; any()</tt></p>
37</div>
38
39<h3 class="function"><a name="observe_email_add_handler-2">observe_email_add_handler/2</a></h3>
40<div class="spec">
41<p><tt>observe_email_add_handler(X1, Context) -&gt; any()</tt></p>
42</div><p>Add an email handler, returns the email address for the handler</p>
43
44<h3 class="function"><a name="observe_email_drop_handler-2">observe_email_drop_handler/2</a></h3>
45<div class="spec">
46<p><tt>observe_email_drop_handler(X1, Context) -&gt; any()</tt></p>
47</div><p>Drop all handlers matching the parameters</p>
48
49<h3 class="function"><a name="observe_email_ensure_handler-2">observe_email_ensure_handler/2</a></h3>
50<div class="spec">
51<p><tt>observe_email_ensure_handler(X1, Context) -&gt; any()</tt></p>
52</div><p>Ensure that en email handler exists</p>
53
54<h3 class="function"><a name="observe_email_received-2">observe_email_received/2</a></h3>
55<div class="spec">
56<p><tt>observe_email_received(Email_received, Context) -&gt; any()</tt></p>
57</div><p>Find handlers based on the recipient, forward the e-mail to those handlers.
58      The e-mail is already parsed and (mostly) sanitized.
59      The e-mail address can be of the form "recipient+tag"</p>
60<hr>
61
62<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
63<p><i>Generated by EDoc, Aug 12 2011, 19:36:11.</i></p>
64</body>
65</html>