diff options
Diffstat (limited to 'target/doc/mailparse/struct.ParsedMail.html')
| -rw-r--r-- | target/doc/mailparse/struct.ParsedMail.html | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/target/doc/mailparse/struct.ParsedMail.html b/target/doc/mailparse/struct.ParsedMail.html new file mode 100644 index 0000000..0a7ff79 --- /dev/null +++ b/target/doc/mailparse/struct.ParsedMail.html @@ -0,0 +1,145 @@ +<!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 `ParsedMail` struct in crate `mailparse`."> + <meta name="keywords" content="rust, rustlang, rust-lang, ParsedMail"> + + <title>mailparse::ParsedMail - Rust</title> + + <link rel="stylesheet" type="text/css" href="../rustdoc.css"> + <link rel="stylesheet" type="text/css" href="../main.css"> + + + + +</head> +<body class="rustdoc"> + <!--[if lte IE 8]> + <div class="warning"> + This old browser is unsupported and will most likely display funky + things. + </div> + <![endif]--> + + + + <nav class="sidebar"> + + <p class='location'><a href='index.html'>mailparse</a></p><script>window.sidebarCurrent = {name: 'ParsedMail', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script> + </nav> + + <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 struct"> +<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>mailparse</a>::<wbr><a class='struct' href=''>ParsedMail</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 id='src-233' class='srclink' href='../src/mailparse/src/lib.rs.html#521-531' title='goto source code'>[src]</a></span></h1> +<pre class='rust struct'>pub struct ParsedMail<'a> { + pub headers: <a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a><<a class='struct' href='../mailparse/struct.MailHeader.html' title='mailparse::MailHeader'>MailHeader</a><'a>>, + pub ctype: <a class='struct' href='../mailparse/struct.ParsedContentType.html' title='mailparse::ParsedContentType'>ParsedContentType</a>, + pub subparts: <a class='struct' href='https://doc.rust-lang.org/nightly/collections/vec/struct.Vec.html' title='collections::vec::Vec'>Vec</a><<a class='struct' href='../mailparse/struct.ParsedMail.html' title='mailparse::ParsedMail'>ParsedMail</a><'a>>, + // some fields omitted +}</pre><div class='docblock'><p>Struct that holds the structured representation of the message. Note that +since MIME allows for nested multipart messages, a tree-like structure is +necessary to represent it properly. This struct accomplishes that by holding +a vector of other ParsedMail structures for the subparts.</p> +</div><h2 class='fields'>Fields</h2> +<table><tr class='stab '> + <td id='structfield.headers'><code>headers</code></td><td><div class='docblock'><p>The headers for the message (or message subpart).</p> +</div></td></tr><tr class='stab '> + <td id='structfield.ctype'><code>ctype</code></td><td><div class='docblock'><p>The Content-Type information for the message (or message subpart).</p> +</div></td></tr><tr class='stab '> + <td id='structfield.subparts'><code>subparts</code></td><td><div class='docblock'><p>The subparts of this message or subpart. This vector is only non-empty +if ctype.mimetype starts with "multipart/".</p> +</div></td></tr></table><h2 id='methods'>Methods</h2><h3 class='impl'><code>impl<'a> <a class='struct' href='../mailparse/struct.ParsedMail.html' title='mailparse::ParsedMail'>ParsedMail</a><'a></code></h3><div class='impl-items'><h4 id='method.get_body' class='method'><code>fn <a href='#method.get_body' class='fnname'>get_body</a>(&self) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/result/enum.Result.html' title='core::result::Result'>Result</a><<a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>, <a class='enum' href='../mailparse/enum.MailParseError.html' title='mailparse::MailParseError'>MailParseError</a>></code></h4> +<div class='docblock'><p>Get the body of the message as a Rust string. This function tries to +unapply the Content-Transfer-Encoding if there is one, and then converts +the result into a Rust UTF-8 string using the charset in the Content-Type +(or "us-ascii" if the charset was missing or not recognized).</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='ident'>parse_mail</span>; + <span class='kw'>let</span> <span class='ident'>p</span> <span class='op'>=</span> <span class='ident'>parse_mail</span>(<span class='macro'>concat</span><span class='macro'>!</span>( + <span class='string'>"Subject: test\n"</span>, + <span class='string'>"\n"</span>, + <span class='string'>"This is the body"</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'>p</span>.<span class='ident'>get_body</span>().<span class='ident'>unwrap</span>(), <span class='string'>"This is the body"</span>);</pre> +</div></div><h2 id='implementations'>Trait Implementations</h2><h3 id='derived_implementations'>Derived Implementations </h3><h3 class='impl'><code>impl<'a> <a class='trait' href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title='core::fmt::Debug'>Debug</a> for <a class='struct' href='../mailparse/struct.ParsedMail.html' title='mailparse::ParsedMail'>ParsedMail</a><'a></code></h3><div class='impl-items'><h4 id='method.fmt' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class='struct' href='https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title='core::fmt::Formatter'>Formatter</a>) -> <a class='type' href='https://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title='core::fmt::Result'>Result</a></code></h4> +</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>?</dt> + <dd>Show this help dialog</dd> + <dt>S</dt> + <dd>Focus the search field</dd> + <dt>⇤</dt> + <dd>Move up in search results</dd> + <dt>⇥</dt> + <dd>Move down in search results</dd> + <dt>⏎</dt> + <dd>Go to active search result</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"; + 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 |