-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
36 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Decoder (received.Received.Decoder)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">received</a> » <a href="../index.html">Received</a> » Decoder</nav><header class="odoc-preamble"><h1>Module <code><span>Received.Decoder</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-stamp"><a href="#val-stamp" class="anchor"></a><code><span><span class="keyword">val</span> stamp : <span><a href="../index.html#type-t">t</a> <span class="xref-unresolved">Angstrom</span>.t</span></span></code></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Encoder (received.Received.Encoder)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">received</a> » <a href="../index.html">Received</a> » Encoder</nav><header class="odoc-preamble"><h1>Module <code><span>Received.Encoder</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-received"><a href="#val-received" class="anchor"></a><code><span><span class="keyword">val</span> received : <span><a href="../index.html#type-t">t</a> <span class="xref-unresolved">Prettym</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-as_field"><a href="#val-as_field" class="anchor"></a><code><span><span class="keyword">val</span> as_field : <span><a href="../index.html#type-t">t</a> <span class="xref-unresolved">Prettym</span>.t</span></span></code></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Received (received.Received)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">received</a> » Received</nav><header class="odoc-preamble"><h1>Module <code><span>Received</span></code></h1><p>Received field</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>Type of <code>Received</code> value.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-with_info"><a href="#type-with_info" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a with_info</span></span><span> = </span></code><ol><li id="type-with_info.Only" class="def variant constructor anchored"><a href="#type-with_info.Only" class="anchor"></a><code><span>| </span><span><span class="constructor">Only</span> <span class="keyword">of</span> <span class="type-var">'a</span></span></code></li><li id="type-with_info.With" class="def variant constructor anchored"><a href="#type-with_info.With" class="anchor"></a><code><span>| </span><span><span class="constructor">With</span> <span class="keyword">of</span> <span class="type-var">'a</span> * <a href="#type-info">info</a></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-info"><a href="#type-info" class="anchor"></a><code><span><span class="keyword">and</span> info</span><span> = </span><span>[ </span></code><ol><li id="type-info.Address" class="def variant constructor anchored"><a href="#type-info.Address" class="anchor"></a><code><span>| </span><span>`Address <span class="keyword">of</span> <a href="../../colombe/Colombe/Domain/index.html#type-t">Colombe.Domain.t</a></span></code></li><li id="type-info.Domain_and_address" class="def variant constructor anchored"><a href="#type-info.Domain_and_address" class="anchor"></a><code><span>| </span><span>`Domain_and_address <span class="keyword">of</span> <a href="../../colombe/Colombe/Domain/index.html#type-t">Colombe.Domain.t</a> * <a href="../../colombe/Colombe/Domain/index.html#type-t">Colombe.Domain.t</a></span></code></li></ol><code><span> ]</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-received_by"><a href="#val-received_by" class="anchor"></a><code><span><span class="keyword">val</span> received_by : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span><a href="../../colombe/Colombe/Domain/index.html#type-t">Colombe.Domain.t</a> <a href="#type-with_info">with_info</a></span> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-received_from"><a href="#val-received_from" class="anchor"></a><code><span><span class="keyword">val</span> received_from : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span><a href="../../colombe/Colombe/Domain/index.html#type-t">Colombe.Domain.t</a> <a href="#type-with_info">with_info</a></span> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-received_for"><a href="#val-received_for" class="anchor"></a><code><span><span class="keyword">val</span> received_for : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../colombe/Colombe/Path/index.html#type-t">Colombe.Path.t</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-link"><a href="#type-link" class="anchor"></a><code><span><span class="keyword">type</span> link</span><span> = <span class="keyword">private</span> </span><span>[ </span></code><ol><li id="type-link.TCP" class="def variant constructor anchored"><a href="#type-link.TCP" class="anchor"></a><code><span>| </span><span>`TCP</span></code></li><li id="type-link.Atom" class="def variant constructor anchored"><a href="#type-link.Atom" class="anchor"></a><code><span>| </span><span>`Atom <span class="keyword">of</span> string</span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Type of underlying protocol used to receive email.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-protocol"><a href="#type-protocol" class="anchor"></a><code><span><span class="keyword">type</span> protocol</span><span> = <span class="keyword">private</span> </span><span>[ </span></code><ol><li id="type-protocol.ESMTP" class="def variant constructor anchored"><a href="#type-protocol.ESMTP" class="anchor"></a><code><span>| </span><span>`ESMTP</span></code></li><li id="type-protocol.SMTP" class="def variant constructor anchored"><a href="#type-protocol.SMTP" class="anchor"></a><code><span>| </span><span>`SMTP</span></code></li><li id="type-protocol.Atom" class="def variant constructor anchored"><a href="#type-protocol.Atom" class="anchor"></a><code><span>| </span><span>`Atom <span class="keyword">of</span> string</span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>Type of protocol used to receive email:</p><ul><li><code>SMTP</code></li><li><code>ESMTP</code></li><li>Other protocol</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-received_with"><a href="#val-received_with" class="anchor"></a><code><span><span class="keyword">val</span> received_with : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-protocol">protocol</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-received_via"><a href="#val-received_via" class="anchor"></a><code><span><span class="keyword">val</span> received_via : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-link">link</a> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-id"><a href="#val-id" class="anchor"></a><code><span><span class="keyword">val</span> id : | ||
| <span><a href="#type-t">t</a> <span class="arrow">-></span></span> | ||
| <span><span>[ <span>`Local of <span class="xref-unresolved">Emile</span>.local</span> <span><span>| `MsgID</span> of <span class="xref-unresolved">Mrmime</span>.MessageID.t</span> <span><span>| `Atom</span> of string</span> ]</span> | ||
| option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-date_time"><a href="#val-date_time" class="anchor"></a><code><span><span class="keyword">val</span> date_time : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Mrmime</span>.Date.t</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-stream"><a href="#type-stream" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a stream</span></span><span> = <span>unit <span class="arrow">-></span></span> <span><span class="type-var">'a</span> option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tcp"><a href="#val-tcp" class="anchor"></a><code><span><span class="keyword">val</span> tcp : <a href="#type-link">link</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-link"><a href="#val-link" class="anchor"></a><code><span><span class="keyword">val</span> link : <span>string <span class="arrow">-></span></span> <a href="#type-link">link</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-smtp"><a href="#val-smtp" class="anchor"></a><code><span><span class="keyword">val</span> smtp : <a href="#type-protocol">protocol</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-esmtp"><a href="#val-esmtp" class="anchor"></a><code><span><span class="keyword">val</span> esmtp : <a href="#type-protocol">protocol</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-protocol"><a href="#val-protocol" class="anchor"></a><code><span><span class="keyword">val</span> protocol : <span>string <span class="arrow">-></span></span> <a href="#type-protocol">protocol</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make : | ||
| <span><span class="optlabel">?from</span>:<span><a href="../../colombe/Colombe/Domain/index.html#type-t">Colombe.Domain.t</a> <a href="#type-with_info">with_info</a></span> <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?by</span>:<span><a href="../../colombe/Colombe/Domain/index.html#type-t">Colombe.Domain.t</a> <a href="#type-with_info">with_info</a></span> <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?via</span>:<a href="#type-link">link</a> <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?protocol</span>:<a href="#type-protocol">protocol</a> <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?id</span>:<span class="xref-unresolved">Mrmime</span>.MessageID.t <span class="arrow">-></span></span> | ||
| <span><span><a href="../../colombe/Colombe/Path/index.html#type-t">Colombe.Path.t</a> option</span> <span class="arrow">-></span></span> | ||
| <span><span class="label">zone</span>:<span class="xref-unresolved">Mrmime</span>.Date.Zone.t <span class="arrow">-></span></span> | ||
| <span><span class="xref-unresolved">Ptime</span>.t <span class="arrow">-></span></span> | ||
| <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>make ?from ?by ?via ?protocol ?id path ~zone time</code>:</p><ul><li><code>from</code> is the domain where the email comes from.</li><li><code>by</code> is the domain where the email is received.</li><li><code>via</code> is the underlying protocol used to receive the email (usually <code>tcp</code>).</li><li><code>protocol</code> is the protocol used to receive the email.</li><li><code>id</code> is the chosen ID by the <i>MTA</i>.</li><li><code>path</code> is the given <code>Path.t</code> received by the <i>MTA</i></li><li><code>zone</code> is the <i>time-zone</i> of the <i>MTA</i>.</li><li><code>time</code> is the time when the <i>MTA</i> received the email.</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><a href="#type-t">t</a> <span class="xref-unresolved">Fmt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Decoder"><a href="#module-Decoder" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Decoder/index.html">Decoder</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Encoder"><a href="#module-Encoder" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Encoder/index.html">Encoder</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_stream"><a href="#val-of_stream" class="anchor"></a><code><span><span class="keyword">val</span> of_stream : | ||
| <span><span><span>(string * int * int)</span> <a href="#type-stream">stream</a></span> <span class="arrow">-></span></span> | ||
| <span><span>(string * <span><a href="#type-t">t</a> list</span>, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (received.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – received</nav><header class="odoc-preamble"><h1 id="received-index"><a href="#received-index" class="anchor"></a>received index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-received">Library received</a></li></ul></nav><div class="odoc-content"><h2 id="library-received"><a href="#library-received" class="anchor"></a>Library received</h2><p>The entry point of this library is the module: <a href="Received/index.html"><code>Received</code></a>.</p></div></body></html> |
Oops, something went wrong.