Current section
Files
Jump to
Current section
Files
docs/Mailman.Parsing.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.16.3">
<title>Mailman.Parsing – Mailman v0.4.0</title>
<link rel="stylesheet" href="dist/app-5b9e160cec.css" />
<link rel="canonical" href="https://hexdocs.pm/mailman/Mailman.Parsing.html" />
<script src="dist/sidebar_items-f0abb4a495.js"></script>
</head>
<body data-type="modules">
<script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script>
<div class="main">
<button class="sidebar-toggle">
<span class="icon-menu" aria-hidden="true"></span>
<span class="sr-only">Toggle Sidebar</span>
</button>
<section class="sidebar">
<a href="https://github.com/kamilc/mailman" class="sidebar-projectLink">
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
Mailman
</h1>
<h2 class="sidebar-projectVersion">
v0.4.0
</h2>
</div>
</a>
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button">
<span class="icon-search" aria-hidden="true"></span>
</button>
<input name="q" type="text" id="search-list" class="search-input" placeholder="search" aria-label="Search" autocomplete="off" />
</form>
<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>
<li><a id="modules-list" href="#full-list">Modules</a></li>
<li><a id="protocols-list" href="#full-list">Protocols</a></li>
</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<small class="visible-xs">Mailman v0.4.0</small>
Mailman.Parsing
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L1" title="View Source" class="view-source" rel="help">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</h1>
<section id="moduledoc">
<p>Functions for parsin mail messages into Elixir structs</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#all_headers/1">all_headers(raw)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#content_parts/1">content_parts(raw)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#filename_from_raw/1">filename_from_raw(raw_part)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_attachments/1">get_attachments(raw)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_delivery/1">get_delivery(raw)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_header/2">get_header(raw, name)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_html/1">get_html(raw)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_raw_body/1">get_raw_body(raw)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_subtype/1">get_subtype(raw)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_text/1">get_text(raw)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_type/1">get_type(raw)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#is_raw_attachement/1">is_raw_attachement(raw_part)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#is_raw_html_part/1">is_raw_html_part(raw)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#is_raw_plain_part/1">is_raw_plain_part(raw)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#parse/1">parse(message)</a>
</div>
<div class="summary-synopsis"><p>Parses given mime mail and returns Email</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#parse!/1">parse!(message_text)</a>
</div>
<div class="summary-synopsis"><p>Parses the message and returns Email</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#raw_parameters_for/1">raw_parameters_for(raw_part)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#raw_to_attachement/1">raw_to_attachement(raw_part)</a>
</div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Functions
</h1>
<div class="detail" id="all_headers/1">
<div class="detail-header">
<a href="#all_headers/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">all_headers(raw)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L51" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="content_parts/1">
<div class="detail-header">
<a href="#content_parts/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">content_parts(raw)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L104" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="filename_from_raw/1">
<div class="detail-header">
<a href="#filename_from_raw/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">filename_from_raw(raw_part)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L55" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="get_attachments/1">
<div class="detail-header">
<a href="#get_attachments/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">get_attachments(raw)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L88" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="get_delivery/1">
<div class="detail-header">
<a href="#get_delivery/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">get_delivery(raw)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L139" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="get_header/2">
<div class="detail-header">
<a href="#get_header/2" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">get_header(raw, name)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L32" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="get_html/1">
<div class="detail-header">
<a href="#get_html/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">get_html(raw)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L125" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="get_raw_body/1">
<div class="detail-header">
<a href="#get_raw_body/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">get_raw_body(raw)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L121" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="get_subtype/1">
<div class="detail-header">
<a href="#get_subtype/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">get_subtype(raw)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L117" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="get_text/1">
<div class="detail-header">
<a href="#get_text/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">get_text(raw)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L132" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="get_type/1">
<div class="detail-header">
<a href="#get_type/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">get_type(raw)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L113" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="is_raw_attachement/1">
<div class="detail-header">
<a href="#is_raw_attachement/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">is_raw_attachement(raw_part)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L73" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="is_raw_html_part/1">
<div class="detail-header">
<a href="#is_raw_html_part/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">is_raw_html_part(raw)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L80" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="is_raw_plain_part/1">
<div class="detail-header">
<a href="#is_raw_plain_part/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">is_raw_plain_part(raw)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L84" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="parse/1">
<div class="detail-header">
<a href="#parse/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">parse(message)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L9" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Parses given mime mail and returns Email</p>
</section>
</div>
<div class="detail" id="parse!/1">
<div class="detail-header">
<a href="#parse!/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">parse!(message_text)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L25" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Parses the message and returns Email</p>
</section>
</div>
<div class="detail" id="raw_parameters_for/1">
<div class="detail-header">
<a href="#raw_parameters_for/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">raw_parameters_for(raw_part)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L69" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="raw_to_attachement/1">
<div class="detail-header">
<a href="#raw_to_attachement/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<span class="signature">raw_to_attachement(raw_part)</span>
<a href="https://github.com/kamilc/mailman/blob/master/lib/mailman/parsing.ex#L95" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.16.3),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
<button class="night-mode-toggle"><span class="sr-only">Switch theme</span></button>
</footer>
</div>
</div>
</section>
</div>
<script src="dist/app-da04b39d0c.js"></script>
</body>
</html>