diff options
Diffstat (limited to 'target/doc/mailparse/fn.parse_mail.html')
-rw-r--r-- | target/doc/mailparse/fn.parse_mail.html | 161 |
1 files changed, 0 insertions, 161 deletions
diff --git a/target/doc/mailparse/fn.parse_mail.html b/target/doc/mailparse/fn.parse_mail.html deleted file mode 100644 index a14735a..0000000 --- a/target/doc/mailparse/fn.parse_mail.html +++ /dev/null @@ -1,161 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> -<head> - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <meta name="generator" content="rustdoc"> - <meta name="description" content="API documentation for the Rust `parse_mail` fn in crate `mailparse`."> - <meta name="keywords" content="rust, rustlang, rust-lang, parse_mail"> - - <title>mailparse::parse_mail - Rust</title> - - <link rel="stylesheet" type="text/css" href="../normalize.css"> - <link rel="stylesheet" type="text/css" href="../rustdoc.css" - id="mainThemeStyle"> - - <link rel="stylesheet" type="text/css" href="../dark.css"> - <link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"> - <script src="../storage.js"></script> - - - - -</head> -<body class="rustdoc fn"> - <!--[if lte IE 8]> - <div class="warning"> - This old browser is unsupported and will most likely display funky - things. - </div> - <![endif]--> - - - - <nav class="sidebar"> - <div class="sidebar-menu">☰</div> - - <div class="sidebar-elems"><p class='location'><a href='index.html'>mailparse</a></p><script>window.sidebarCurrent = {name: 'parse_mail', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div> - </nav> - - <div class="theme-picker"> - <button id="theme-picker" aria-label="Pick another theme!"> - <img src="../brush.svg" width="18" alt="Pick another theme!"> - </button> - <div id="theme-choices"></div> - </div> - <script src="../theme.js"></script> - <nav class="sub"> - <form class="search-form js-only"> - <div class="search-container"> - <input class="search-input" name="search" - autocomplete="off" - placeholder="Click or press ‘S’ to search, ‘?’ for more options…" - type="search"> - </div> - </form> - </nav> - - <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'>−</span>] - </a> - </span><a class='srclink' href='../src/mailparse/lib.rs.html#775-814' 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">&[</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>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>></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="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">"Subject: This is a test email\n"</span>, - <span class="string">"Content-Type: multipart/alternative; boundary=foobar\n"</span>, - <span class="string">"Date: Sun, 02 Oct 2016 07:06:22 -0700 (PDT)\n"</span>, - <span class="string">"\n"</span>, - <span class="string">"--foobar\n"</span>, - <span class="string">"Content-Type: text/plain; charset=utf-8\n"</span>, - <span class="string">"Content-Transfer-Encoding: quoted-printable\n"</span>, - <span class="string">"\n"</span>, - <span class="string">"This is the plaintext version, in utf-8. Proof by Euro: =E2=82=AC\n"</span>, - <span class="string">"--foobar\n"</span>, - <span class="string">"Content-Type: text/html\n"</span>, - <span class="string">"Content-Transfer-Encoding: base64\n"</span>, - <span class="string">"\n"</span>, - <span class="string">"PGh0bWw+PGJvZHk+VGhpcyBpcyB0aGUgPGI+SFRNTDwvYj4gdmVyc2lvbiwgaW4g \n"</span>, - <span class="string">"dXMtYXNjaWkuIFByb29mIGJ5IEV1cm86ICZldXJvOzwvYm9keT48L2h0bWw+Cg== \n"</span>, - <span class="string">"--foobar--\n"</span>, - <span class="string">"After the final boundary stuff gets ignored.\n"</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">"Subject"</span>).<span class="ident">unwrap</span>(), - <span class="prelude-val">Some</span>(<span class="string">"This is a test email"</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">"This is the plaintext version, in utf-8. Proof by Euro: \u{20AC}"</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">"base64"</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">"text/html"</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">"<html>"</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">"Date"</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> - - <section class="footer"></section> - - <aside id="help" class="hidden"> - <div> - <h1 class="hidden">Help</h1> - - <div class="shortcuts"> - <h2>Keyboard Shortcuts</h2> - - <dl> - <dt><kbd>?</kbd></dt> - <dd>Show this help dialog</dd> - <dt><kbd>S</kbd></dt> - <dd>Focus the search field</dd> - <dt><kbd>↑</kbd></dt> - <dd>Move up in search results</dd> - <dt><kbd>↓</kbd></dt> - <dd>Move down in search results</dd> - <dt><kbd>↹</kbd></dt> - <dd>Switch tab</dd> - <dt><kbd>⏎</kbd></dt> - <dd>Go to active search result</dd> - <dt><kbd>+</kbd></dt> - <dd>Expand all sections</dd> - <dt><kbd>-</kbd></dt> - <dd>Collapse all sections</dd> - </dl> - </div> - - <div class="infos"> - <h2>Search Tricks</h2> - - <p> - Prefix searches with a type followed by a colon (e.g. - <code>fn:</code>) to restrict the search to a given type. - </p> - - <p> - Accepted types are: <code>fn</code>, <code>mod</code>, - <code>struct</code>, <code>enum</code>, - <code>trait</code>, <code>type</code>, <code>macro</code>, - and <code>const</code>. - </p> - - <p> - Search functions by type signature (e.g. - <code>vec -> usize</code> or <code>* -> vec</code>) - </p> - </div> - </div> - </aside> - - - - <script> - window.rootPath = "../"; - window.currentCrate = "mailparse"; - </script> - <script src="../main.js"></script> - <script defer src="../search-index.js"></script> -</body> -</html>
\ No newline at end of file |