diff options
Diffstat (limited to 'target/doc/mailparse/index.html')
| -rw-r--r-- | target/doc/mailparse/index.html | 280 |
1 files changed, 0 insertions, 280 deletions
diff --git a/target/doc/mailparse/index.html b/target/doc/mailparse/index.html deleted file mode 100644 index 9ec069b..0000000 --- a/target/doc/mailparse/index.html +++ /dev/null @@ -1,280 +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 `mailparse` crate."> - <meta name="keywords" content="rust, rustlang, rust-lang, mailparse"> - - <title>mailparse - 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 mod"> - <!--[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> - - <p class='location'>Crate mailparse</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'mailparse', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>mailparse</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#1-1226' title='goto source code'>[src]</a></span></h1><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2> -<table> - <tr class=' module-item'> - <td><a class="struct" href="struct.MailHeader.html" - title='struct mailparse::MailHeader'>MailHeader</a></td> - <td class='docblock-short'> - <p>A struct that represents a single header in the message. -It holds slices into the raw byte array passed to parse_mail, and so the -lifetime of this struct must be contained within the lifetime of the raw -input. There are additional accessor functions on this struct to extract -the data as Rust strings.</p> - - </td> - </tr> - <tr class=' module-item'> - <td><a class="struct" href="struct.ParsedContentDisposition.html" - title='struct mailparse::ParsedContentDisposition'>ParsedContentDisposition</a></td> - <td class='docblock-short'> - <p>A struct to hold a more structured representation of the Content-Disposition header. -This is provided mostly as a convenience since this metadata is usually -needed to interpret the message body properly.</p> - - </td> - </tr> - <tr class=' module-item'> - <td><a class="struct" href="struct.ParsedContentType.html" - title='struct mailparse::ParsedContentType'>ParsedContentType</a></td> - <td class='docblock-short'> - <p>A struct to hold a more structured representation of the Content-Type header. -This is provided mostly as a convenience since this metadata is usually -needed to interpret the message body properly.</p> - - </td> - </tr> - <tr class=' module-item'> - <td><a class="struct" href="struct.ParsedMail.html" - title='struct mailparse::ParsedMail'>ParsedMail</a></td> - <td class='docblock-short'> - <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> - - </td> - </tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2> -<table> - <tr class=' module-item'> - <td><a class="enum" href="enum.DispositionType.html" - title='enum mailparse::DispositionType'>DispositionType</a></td> - <td class='docblock-short'> - <p>The possible disposition types in a Content-Disposition header. A more -comprehensive list of IANA-recognized types can be found at -https://www.iana.org/assignments/cont-disp/cont-disp.xhtml. This library -only enumerates the types most commonly found in email messages, and -provides the <code>Extension</code> value for holding all other types.</p> - - </td> - </tr> - <tr class=' module-item'> - <td><a class="enum" href="enum.MailParseError.html" - title='enum mailparse::MailParseError'>MailParseError</a></td> - <td class='docblock-short'> - <p>An error type that represents the different kinds of errors that may be -encountered during message parsing.</p> - - </td> - </tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2> -<table> - <tr class=' module-item'> - <td><a class="trait" href="trait.MailHeaderMap.html" - title='trait mailparse::MailHeaderMap'>MailHeaderMap</a></td> - <td class='docblock-short'> - <p>A trait that is implemented by the Vec<MailHeader> returned by the parse_headers -function. It provides a map-like interface to look up header values by their -name.</p> - - </td> - </tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2> -<table> - <tr class=' module-item'> - <td><a class="fn" href="fn.dateparse.html" - title='fn mailparse::dateparse'>dateparse</a></td> - <td class='docblock-short'> - <p>Convert a date field from an email header into a UNIX epoch timestamp. -This function handles the most common formatting of date fields found in -email headers. It may fail to parse some of the more creative formattings.</p> - - </td> - </tr> - <tr class=' module-item'> - <td><a class="fn" href="fn.parse_content_disposition.html" - title='fn mailparse::parse_content_disposition'>parse_content_disposition</a></td> - <td class='docblock-short'> - <p>Helper method to parse a header value as a Content-Disposition header. The disposition -defaults to "inline" if no disposition parameter is provided in the header -value.</p> - - </td> - </tr> - <tr class=' module-item'> - <td><a class="fn" href="fn.parse_content_type.html" - title='fn mailparse::parse_content_type'>parse_content_type</a></td> - <td class='docblock-short'> - <p>Helper method to parse a header value as a Content-Type header. Note that -the returned object's <code>params</code> map will contain a charset key if a charset -was explicitly specified in the header; otherwise the <code>params</code> map will not -contain a charset key. Regardless, the <code>charset</code> field will contain a -charset - either the one explicitly specified or the default of "us-ascii".</p> - - </td> - </tr> - <tr class=' module-item'> - <td><a class="fn" href="fn.parse_header.html" - title='fn mailparse::parse_header'>parse_header</a></td> - <td class='docblock-short'> - <p>Parse a single header from the raw data given. -This function takes raw byte data, and starts parsing it, expecting there -to be a MIME header key-value pair right at the beginning. It parses that -header and returns it, along with the index at which the next header is -expected to start. If you just want to parse a single header, you can ignore -the second component of the tuple, which is the index of the next header. -Error values are returned if the data could not be successfully interpreted -as a MIME key-value pair.</p> - - </td> - </tr> - <tr class=' module-item'> - <td><a class="fn" href="fn.parse_headers.html" - title='fn mailparse::parse_headers'>parse_headers</a></td> - <td class='docblock-short'> - <p>Parses all the headers from the raw data given. -This function takes raw byte data, and starts parsing it, expecting there -to be zero or more MIME header key-value pair right at the beginning, -followed by two consecutive newlines (i.e. a blank line). It parses those -headers and returns them in a vector. The normal vector functions can be -used to access the headers linearly, or the MailHeaderMap trait can be used -to access them in a map-like fashion. Along with this vector, the function -returns the index at which the message body is expected to start. If you -just care about the headers, you can ignore the second component of the -returned tuple. -Error values are returned if there was some sort of parsing error.</p> - - </td> - </tr> - <tr class=' module-item'> - <td><a class="fn" href="fn.parse_mail.html" - title='fn mailparse::parse_mail'>parse_mail</a></td> - <td class='docblock-short'> - <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> - - </td> - </tr></table></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 |