summaryrefslogtreecommitdiffstats
path: root/target/doc/mailparse/fn.parse_mail.html
diff options
context:
space:
mode:
Diffstat (limited to 'target/doc/mailparse/fn.parse_mail.html')
-rw-r--r--target/doc/mailparse/fn.parse_mail.html74
1 files changed, 36 insertions, 38 deletions
diff --git a/target/doc/mailparse/fn.parse_mail.html b/target/doc/mailparse/fn.parse_mail.html
index 7f17d0f..939186a 100644
--- a/target/doc/mailparse/fn.parse_mail.html
+++ b/target/doc/mailparse/fn.parse_mail.html
@@ -9,6 +9,7 @@
<title>mailparse::parse_mail - Rust</title>
+ <link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
@@ -16,7 +17,7 @@
</head>
-<body class="rustdoc">
+<body class="rustdoc fn">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
@@ -42,48 +43,48 @@
</form>
</nav>
- <section id='main' class="content fn">
-<h1 class='fqn'><span class='in-band'>Function <a href='index.html'>mailparse</a>::<wbr><a class='fn' href=''>parse_mail</a></span><span class='out-of-band'><span id='render-detail'>
+ <section id='main' class="content">
+<h1 class='fqn'><span class='in-band'>Function <a href='index.html'>mailparse</a>::<wbr><a class="fn" href=''>parse_mail</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
- </span><a id='src-328' class='srclink' href='../src/mailparse/src/lib.rs.html#668-712' title='goto source code'>[src]</a></span></h1>
-<pre class='rust fn'>pub fn parse_mail(raw_data: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;[</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a>) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a>&lt;<a class='struct' href='../mailparse/struct.ParsedMail.html' title='mailparse::ParsedMail'>ParsedMail</a>,&nbsp;<a class='enum' href='../mailparse/enum.MailParseError.html' title='mailparse::MailParseError'>MailParseError</a>&gt;</pre><div class='docblock'><p>The main mail-parsing entry point.
+ </span><a class='srclink' href='../src/mailparse/lib.rs.html#668-712' title='goto source code'>[src]</a></span></h1>
+<pre class='rust fn'>pub fn parse_mail(raw_data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../mailparse/struct.ParsedMail.html" title="struct mailparse::ParsedMail">ParsedMail</a>, <a class="enum" href="../mailparse/enum.MailParseError.html" title="enum mailparse::MailParseError">MailParseError</a>&gt;</pre><div class='docblock'><p>The main mail-parsing entry point.
This function takes the raw data making up the message body and returns a
structured version of it, which allows easily accessing the header and body
information as needed.</p>
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
-<pre class='rust rust-example-rendered'>
- <span class='kw'>use</span> <span class='ident'>mailparse</span>::<span class='op'>*</span>;
- <span class='kw'>let</span> <span class='ident'>parsed</span> <span class='op'>=</span> <span class='ident'>parse_mail</span>(<span class='macro'>concat</span><span class='macro'>!</span>(
- <span class='string'>&quot;Subject: This is a test email\n&quot;</span>,
- <span class='string'>&quot;Content-Type: multipart/alternative; boundary=foobar\n&quot;</span>,
- <span class='string'>&quot;Date: Sun, 02 Oct 2016 07:06:22 -0700 (PDT)\n&quot;</span>,
- <span class='string'>&quot;\n&quot;</span>,
- <span class='string'>&quot;--foobar\n&quot;</span>,
- <span class='string'>&quot;Content-Type: text/plain; charset=utf-8\n&quot;</span>,
- <span class='string'>&quot;Content-Transfer-Encoding: quoted-printable\n&quot;</span>,
- <span class='string'>&quot;\n&quot;</span>,
- <span class='string'>&quot;This is the plaintext version, in utf-8. Proof by Euro: =E2=82=AC\n&quot;</span>,
- <span class='string'>&quot;--foobar\n&quot;</span>,
- <span class='string'>&quot;Content-Type: text/html\n&quot;</span>,
- <span class='string'>&quot;Content-Transfer-Encoding: base64\n&quot;</span>,
- <span class='string'>&quot;\n&quot;</span>,
- <span class='string'>&quot;PGh0bWw+PGJvZHk+VGhpcyBpcyB0aGUgPGI+SFRNTDwvYj4gdmVyc2lvbiwgaW4g \n&quot;</span>,
- <span class='string'>&quot;dXMtYXNjaWkuIFByb29mIGJ5IEV1cm86ICZldXJvOzwvYm9keT48L2h0bWw+Cg== \n&quot;</span>,
- <span class='string'>&quot;--foobar--\n&quot;</span>,
- <span class='string'>&quot;After the final boundary stuff gets ignored.\n&quot;</span>).<span class='ident'>as_bytes</span>())
- .<span class='ident'>unwrap</span>();
- <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>parsed</span>.<span class='ident'>headers</span>.<span class='ident'>get_first_value</span>(<span class='string'>&quot;Subject&quot;</span>).<span class='ident'>unwrap</span>(),
- <span class='prelude-val'>Some</span>(<span class='string'>&quot;This is a test email&quot;</span>.<span class='ident'>to_string</span>()));
- <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>parsed</span>.<span class='ident'>subparts</span>.<span class='ident'>len</span>(), <span class='number'>2</span>);
- <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>parsed</span>.<span class='ident'>subparts</span>[<span class='number'>0</span>].<span class='ident'>get_body</span>().<span class='ident'>unwrap</span>(),
- <span class='string'>&quot;This is the plaintext version, in utf-8. Proof by Euro: \u{20AC}&quot;</span>);
- <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>parsed</span>.<span class='ident'>subparts</span>[<span class='number'>1</span>].<span class='ident'>headers</span>[<span class='number'>1</span>].<span class='ident'>get_value</span>().<span class='ident'>unwrap</span>(), <span class='string'>&quot;base64&quot;</span>);
- <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>parsed</span>.<span class='ident'>subparts</span>[<span class='number'>1</span>].<span class='ident'>ctype</span>.<span class='ident'>mimetype</span>, <span class='string'>&quot;text/html&quot;</span>);
- <span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>parsed</span>.<span class='ident'>subparts</span>[<span class='number'>1</span>].<span class='ident'>get_body</span>().<span class='ident'>unwrap</span>().<span class='ident'>starts_with</span>(<span class='string'>&quot;&lt;html&gt;&quot;</span>));
- <span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>dateparse</span>(<span class='ident'>parsed</span>.<span class='ident'>headers</span>.<span class='ident'>get_first_value</span>(<span class='string'>&quot;Date&quot;</span>).<span class='ident'>unwrap</span>().<span class='ident'>unwrap</span>().<span class='ident'>as_str</span>()).<span class='ident'>unwrap</span>(), <span class='number'>1475417182</span>);<a class='test-arrow' target='_blank' href=''>Run</a></pre>
+<pre class="rust rust-example-rendered">
+<span class="kw">use</span> <span class="ident">mailparse</span>::<span class="kw-2">*</span>;
+ <span class="kw">let</span> <span class="ident">parsed</span> <span class="op">=</span> <span class="ident">parse_mail</span>(<span class="macro">concat</span><span class="macro">!</span>(
+ <span class="string">&quot;Subject: This is a test email\n&quot;</span>,
+ <span class="string">&quot;Content-Type: multipart/alternative; boundary=foobar\n&quot;</span>,
+ <span class="string">&quot;Date: Sun, 02 Oct 2016 07:06:22 -0700 (PDT)\n&quot;</span>,
+ <span class="string">&quot;\n&quot;</span>,
+ <span class="string">&quot;--foobar\n&quot;</span>,
+ <span class="string">&quot;Content-Type: text/plain; charset=utf-8\n&quot;</span>,
+ <span class="string">&quot;Content-Transfer-Encoding: quoted-printable\n&quot;</span>,
+ <span class="string">&quot;\n&quot;</span>,
+ <span class="string">&quot;This is the plaintext version, in utf-8. Proof by Euro: =E2=82=AC\n&quot;</span>,
+ <span class="string">&quot;--foobar\n&quot;</span>,
+ <span class="string">&quot;Content-Type: text/html\n&quot;</span>,
+ <span class="string">&quot;Content-Transfer-Encoding: base64\n&quot;</span>,
+ <span class="string">&quot;\n&quot;</span>,
+ <span class="string">&quot;PGh0bWw+PGJvZHk+VGhpcyBpcyB0aGUgPGI+SFRNTDwvYj4gdmVyc2lvbiwgaW4g \n&quot;</span>,
+ <span class="string">&quot;dXMtYXNjaWkuIFByb29mIGJ5IEV1cm86ICZldXJvOzwvYm9keT48L2h0bWw+Cg== \n&quot;</span>,
+ <span class="string">&quot;--foobar--\n&quot;</span>,
+ <span class="string">&quot;After the final boundary stuff gets ignored.\n&quot;</span>).<span class="ident">as_bytes</span>())
+ .<span class="ident">unwrap</span>();
+ <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">parsed</span>.<span class="ident">headers</span>.<span class="ident">get_first_value</span>(<span class="string">&quot;Subject&quot;</span>).<span class="ident">unwrap</span>(),
+ <span class="prelude-val">Some</span>(<span class="string">&quot;This is a test email&quot;</span>.<span class="ident">to_string</span>()));
+ <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">parsed</span>.<span class="ident">subparts</span>.<span class="ident">len</span>(), <span class="number">2</span>);
+ <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">parsed</span>.<span class="ident">subparts</span>[<span class="number">0</span>].<span class="ident">get_body</span>().<span class="ident">unwrap</span>(),
+ <span class="string">&quot;This is the plaintext version, in utf-8. Proof by Euro: \u{20AC}&quot;</span>);
+ <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">parsed</span>.<span class="ident">subparts</span>[<span class="number">1</span>].<span class="ident">headers</span>[<span class="number">1</span>].<span class="ident">get_value</span>().<span class="ident">unwrap</span>(), <span class="string">&quot;base64&quot;</span>);
+ <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">parsed</span>.<span class="ident">subparts</span>[<span class="number">1</span>].<span class="ident">ctype</span>.<span class="ident">mimetype</span>, <span class="string">&quot;text/html&quot;</span>);
+ <span class="macro">assert</span><span class="macro">!</span>(<span class="ident">parsed</span>.<span class="ident">subparts</span>[<span class="number">1</span>].<span class="ident">get_body</span>().<span class="ident">unwrap</span>().<span class="ident">starts_with</span>(<span class="string">&quot;&lt;html&gt;&quot;</span>));
+ <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">dateparse</span>(<span class="ident">parsed</span>.<span class="ident">headers</span>.<span class="ident">get_first_value</span>(<span class="string">&quot;Date&quot;</span>).<span class="ident">unwrap</span>().<span class="ident">unwrap</span>().<span class="ident">as_str</span>()).<span class="ident">unwrap</span>(), <span class="number">1475417182</span>);</pre>
</div></section>
<section id='search' class="content hidden"></section>
@@ -140,11 +141,8 @@ information as needed.</p>
<script>
window.rootPath = "../";
window.currentCrate = "mailparse";
- window.playgroundUrl = "";
</script>
- <script src="../jquery.js"></script>
<script src="../main.js"></script>
-
<script defer src="../search-index.js"></script>
</body>
</html> \ No newline at end of file