Packages

mailman

0.4.0
0.4.3 0.4.2 0.4.1 0.4.0 0.3.0 0.2.2 0.2.1 0.2.0 0.1.2 0.1.1 0.1.0

Library providing a clean way of defining mailers in Elixir apps

HexDocs

Current section

Files

Jump to
Readme
11 Versions
3 Dependencies
Dependants
Files
Activity
mailman docs api-reference.html
Raw

docs/api-reference.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>API Reference – Mailman v0.4.0</title>

    <link rel="stylesheet" href="dist/app-5b9e160cec.css" />

    

      <link rel="canonical" href="https://hexdocs.pm/mailman/api-reference.html" />

    

    <script src="dist/sidebar_items-f0abb4a495.js"></script>

    

  </head>

  <body data-type="extras">

    <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>

  API Reference

</h1>





  <section class="details-list">

    <h2 id="modules" class="section-heading">

  <a href="#modules" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>

  Modules

</h2>



    <div class="summary">

      <div class="summary-row">

  <div class="summary-signature"><a href="Mailman.html">Mailman</a></div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.Attachment.html">Mailman.Attachment</a></div>

  

    <div class="summary-synopsis"><p>A struct defining an attachable file. It automatically detect the mime type based on file extension</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.Context.html">Mailman.Context</a></div>

  

    <div class="summary-synopsis"><p>Defines the configuration for both rendering and sending of messages</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.EexComposeConfig.html">Mailman.EexComposeConfig</a></div>

  

    <div class="summary-synopsis"><p>Defines the config for the Eex composer</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.EexComposer.html">Mailman.EexComposer</a></div>

  

    <div class="summary-synopsis"><p>Provides functions for rendering from Eex template files</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.Email.html">Mailman.Email</a></div>

  

    <div class="summary-synopsis"><p>Struct representing an email message</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.ExternalSmtpAdapter.html">Mailman.ExternalSmtpAdapter</a></div>

  

    <div class="summary-synopsis"><p>Adapter for sending email via external SMTP server</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.Header.html">Mailman.Header</a></div>

  

    <div class="summary-synopsis"><p>Represents a Mime-Mail header</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.LocalServer.html">Mailman.LocalServer</a></div>

  

    <div class="summary-synopsis"><p>Basic SMTP implementation via the gen_smtp_sever_session behavior. Implements relay’ing to external servers</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.LocalSmtpAdapter.html">Mailman.LocalSmtpAdapter</a></div>

  

    <div class="summary-synopsis"><p>Adapter for using locally spawned SMTP server</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.LocalSmtpConfig.html">Mailman.LocalSmtpConfig</a></div>

  

    <div class="summary-synopsis"><p>Configuration struct for the locally spawned SMTP server</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.Parsing.html">Mailman.Parsing</a></div>

  

    <div class="summary-synopsis"><p>Functions for parsin mail messages into Elixir structs</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.Render.html">Mailman.Render</a></div>

  

    <div class="summary-synopsis"><p>Functions for rendering email messages into strings</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.SmtpConfig.html">Mailman.SmtpConfig</a></div>

  

    <div class="summary-synopsis"><p>A config struct for external SMTP server adapter</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.TestConfig.html">Mailman.TestConfig</a></div>

  

    <div class="summary-synopsis"><p>Config struct for the testing adapter</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.TestServer.html">Mailman.TestServer</a></div>

  

    <div class="summary-synopsis"><p>Implementation of the testing SMTP server</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.TestServerSupervisor.html">Mailman.TestServerSupervisor</a></div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.TestingAdapter.html">Mailman.TestingAdapter</a></div>

  

    <div class="summary-synopsis"><p>Implementation of the testing SMTP adapter</p>

</div>

  

</div>



    </div>

  </section>











  <section class="details-list">

    <h2 id="protocols" class="section-heading">

  <a href="#protocols" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>

  Protocols

</h2>



    <div class="summary">

      <div class="summary-row">

  <div class="summary-signature"><a href="Mailman.Adapter.html">Mailman.Adapter</a></div>

  

    <div class="summary-synopsis"><p>Protocol for implementing different medium of emails delivery</p>

</div>

  

</div>

<div class="summary-row">

  <div class="summary-signature"><a href="Mailman.Composer.html">Mailman.Composer</a></div>

  

    <div class="summary-synopsis"><p>Protocol for implementing different template systems for compiling email bodies</p>

</div>

  

</div>



    </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>