src/build/html/pyams_mail.html
changeset 11 ba0b83b57c0c
parent 10 1d12ff3f036a
child 12 f1f1e99a6572
equal deleted inserted replaced
10:1d12ff3f036a 11:ba0b83b57c0c
     1 
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
       
     4 
       
     5 <html xmlns="http://www.w3.org/1999/xhtml">
       
     6   <head>
       
     7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
       
     8     <title>pyams_mail package &#8212; PyAMS User Guide 0.1.0 documentation</title>
       
     9     <link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
       
    10     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       
    11     <script type="text/javascript">
       
    12       var DOCUMENTATION_OPTIONS = {
       
    13         URL_ROOT:    './',
       
    14         VERSION:     '0.1.0',
       
    15         COLLAPSE_INDEX: false,
       
    16         FILE_SUFFIX: '.html',
       
    17         HAS_SOURCE:  true,
       
    18         SOURCELINK_SUFFIX: '.txt'
       
    19       };
       
    20     </script>
       
    21     <script type="text/javascript" src="_static/jquery.js"></script>
       
    22     <script type="text/javascript" src="_static/underscore.js"></script>
       
    23     <script type="text/javascript" src="_static/doctools.js"></script>
       
    24     <link rel="index" title="Index" href="genindex.html" />
       
    25     <link rel="search" title="Search" href="search.html" />
       
    26 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
       
    27 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
       
    28 <!--[if lte IE 6]>
       
    29 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
       
    30 <![endif]-->
       
    31 
       
    32   </head>
       
    33   <body>
       
    34 
       
    35     <div class="related" role="navigation" aria-label="related navigation">
       
    36       <h3>Navigation</h3>
       
    37       <ul>
       
    38         <li class="right" style="margin-right: 10px">
       
    39           <a href="genindex.html" title="General Index"
       
    40              accesskey="I">index</a></li>
       
    41         <li class="right" >
       
    42           <a href="py-modindex.html" title="Python Module Index"
       
    43              >modules</a> |</li>
       
    44         <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
       
    45       </ul>
       
    46     </div>  
       
    47 
       
    48     <div class="document">
       
    49       <div class="documentwrapper">
       
    50         <div class="bodywrapper">
       
    51           <div class="body" role="main">
       
    52             
       
    53   <div class="section" id="pyams-mail-package">
       
    54 <h1>pyams_mail package<a class="headerlink" href="#pyams-mail-package" title="Permalink to this headline">¶</a></h1>
       
    55 <div class="section" id="subpackages">
       
    56 <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
       
    57 <div class="toctree-wrapper compound">
       
    58 <ul>
       
    59 <li class="toctree-l1"><a class="reference internal" href="pyams_mail.interfaces.html">pyams_mail.interfaces package</a><ul>
       
    60 <li class="toctree-l2"><a class="reference internal" href="pyams_mail.interfaces.html#module-pyams_mail.interfaces">Module contents</a></li>
       
    61 </ul>
       
    62 </li>
       
    63 <li class="toctree-l1"><a class="reference internal" href="pyams_mail.tests.html">pyams_mail.tests package</a><ul>
       
    64 <li class="toctree-l2"><a class="reference internal" href="pyams_mail.tests.html#submodules">Submodules</a></li>
       
    65 <li class="toctree-l2"><a class="reference internal" href="pyams_mail.tests.html#module-pyams_mail.tests.test_utilsdocs">pyams_mail.tests.test_utilsdocs module</a></li>
       
    66 <li class="toctree-l2"><a class="reference internal" href="pyams_mail.tests.html#module-pyams_mail.tests.test_utilsdocstrings">pyams_mail.tests.test_utilsdocstrings module</a></li>
       
    67 <li class="toctree-l2"><a class="reference internal" href="pyams_mail.tests.html#module-pyams_mail.tests">Module contents</a></li>
       
    68 </ul>
       
    69 </li>
       
    70 </ul>
       
    71 </div>
       
    72 </div>
       
    73 <div class="section" id="submodules">
       
    74 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
       
    75 </div>
       
    76 <div class="section" id="module-pyams_mail.include">
       
    77 <span id="pyams-mail-include-module"></span><h2>pyams_mail.include module<a class="headerlink" href="#module-pyams_mail.include" title="Permalink to this headline">¶</a></h2>
       
    78 <dl class="function">
       
    79 <dt id="pyams_mail.include.include_package">
       
    80 <code class="descclassname">pyams_mail.include.</code><code class="descname">include_package</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_mail.include.include_package" title="Permalink to this definition">¶</a></dt>
       
    81 <dd><p>Pyramid include</p>
       
    82 </dd></dl>
       
    83 
       
    84 </div>
       
    85 <div class="section" id="module-pyams_mail.mailer">
       
    86 <span id="pyams-mail-mailer-module"></span><h2>pyams_mail.mailer module<a class="headerlink" href="#module-pyams_mail.mailer" title="Permalink to this headline">¶</a></h2>
       
    87 <dl class="class">
       
    88 <dt id="pyams_mail.mailer.MailerVocabulary">
       
    89 <em class="property">class </em><code class="descclassname">pyams_mail.mailer.</code><code class="descname">MailerVocabulary</code><span class="sig-paren">(</span><em>context</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_mail.mailer.MailerVocabulary" title="Permalink to this definition">¶</a></dt>
       
    90 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.componentvocabulary.vocabulary.UtilityVocabulary</span></code></p>
       
    91 <p>Mailer vocabulary</p>
       
    92 <dl class="attribute">
       
    93 <dt id="pyams_mail.mailer.MailerVocabulary.interface">
       
    94 <code class="descname">interface</code><em class="property"> = &lt;InterfaceClass pyramid_mailer.interfaces.IMailer&gt;</em><a class="headerlink" href="#pyams_mail.mailer.MailerVocabulary.interface" title="Permalink to this definition">¶</a></dt>
       
    95 <dd></dd></dl>
       
    96 
       
    97 <dl class="attribute">
       
    98 <dt id="pyams_mail.mailer.MailerVocabulary.nameOnly">
       
    99 <code class="descname">nameOnly</code><em class="property"> = True</em><a class="headerlink" href="#pyams_mail.mailer.MailerVocabulary.nameOnly" title="Permalink to this definition">¶</a></dt>
       
   100 <dd></dd></dl>
       
   101 
       
   102 </dd></dl>
       
   103 
       
   104 </div>
       
   105 <div class="section" id="module-pyams_mail.message">
       
   106 <span id="pyams-mail-message-module"></span><h2>pyams_mail.message module<a class="headerlink" href="#module-pyams_mail.message" title="Permalink to this headline">¶</a></h2>
       
   107 <dl class="function">
       
   108 <dt id="pyams_mail.message.HTMLMessage">
       
   109 <code class="descclassname">pyams_mail.message.</code><code class="descname">HTMLMessage</code><span class="sig-paren">(</span><em>subject</em>, <em>fromaddr</em>, <em>toaddr</em>, <em>html</em>, <em>text=None</em>, <em>encoding='utf-8'</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_mail.message.HTMLMessage" title="Permalink to this definition">¶</a></dt>
       
   110 <dd><p>Create a MIME message that will render as HTML or text</p>
       
   111 </dd></dl>
       
   112 
       
   113 <dl class="function">
       
   114 <dt id="pyams_mail.message.TextMessage">
       
   115 <code class="descclassname">pyams_mail.message.</code><code class="descname">TextMessage</code><span class="sig-paren">(</span><em>subject</em>, <em>fromaddr</em>, <em>toaddr</em>, <em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_mail.message.TextMessage" title="Permalink to this definition">¶</a></dt>
       
   116 <dd><p>Create a text message</p>
       
   117 </dd></dl>
       
   118 
       
   119 <dl class="function">
       
   120 <dt id="pyams_mail.message.html_encode">
       
   121 <code class="descclassname">pyams_mail.message.</code><code class="descname">html_encode</code><span class="sig-paren">(</span><em>unicode_data</em>, <em>encoding='utf-8'</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_mail.message.html_encode" title="Permalink to this definition">¶</a></dt>
       
   122 <dd></dd></dl>
       
   123 
       
   124 <dl class="function">
       
   125 <dt id="pyams_mail.message.html_replace">
       
   126 <code class="descclassname">pyams_mail.message.</code><code class="descname">html_replace</code><span class="sig-paren">(</span><em>exc</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_mail.message.html_replace" title="Permalink to this definition">¶</a></dt>
       
   127 <dd></dd></dl>
       
   128 
       
   129 </div>
       
   130 <div class="section" id="module-pyams_mail">
       
   131 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_mail" title="Permalink to this headline">¶</a></h2>
       
   132 <dl class="function">
       
   133 <dt id="pyams_mail.includeme">
       
   134 <code class="descclassname">pyams_mail.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_mail.includeme" title="Permalink to this definition">¶</a></dt>
       
   135 <dd><p>Pyramid include</p>
       
   136 </dd></dl>
       
   137 
       
   138 </div>
       
   139 </div>
       
   140 
       
   141 
       
   142           </div>
       
   143         </div>
       
   144       </div>
       
   145       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
       
   146         <div class="sphinxsidebarwrapper">
       
   147   <h3><a href="index.html">Table Of Contents</a></h3>
       
   148   <ul>
       
   149 <li><a class="reference internal" href="#">pyams_mail package</a><ul>
       
   150 <li><a class="reference internal" href="#subpackages">Subpackages</a></li>
       
   151 <li><a class="reference internal" href="#submodules">Submodules</a></li>
       
   152 <li><a class="reference internal" href="#module-pyams_mail.include">pyams_mail.include module</a></li>
       
   153 <li><a class="reference internal" href="#module-pyams_mail.mailer">pyams_mail.mailer module</a></li>
       
   154 <li><a class="reference internal" href="#module-pyams_mail.message">pyams_mail.message module</a></li>
       
   155 <li><a class="reference internal" href="#module-pyams_mail">Module contents</a></li>
       
   156 </ul>
       
   157 </li>
       
   158 </ul>
       
   159 
       
   160 <div id="searchbox" style="display: none" role="search">
       
   161   <h3>Quick search</h3>
       
   162     <form class="search" action="search.html" method="get">
       
   163       <div><input type="text" name="q" /></div>
       
   164       <div><input type="submit" value="Go" /></div>
       
   165       <input type="hidden" name="check_keywords" value="yes" />
       
   166       <input type="hidden" name="area" value="default" />
       
   167     </form>
       
   168 </div>
       
   169 <script type="text/javascript">$('#searchbox').show(0);</script>
       
   170         </div>
       
   171       </div>
       
   172       <div class="clearer"></div>
       
   173     </div>
       
   174     <div class="related" role="navigation" aria-label="related navigation">
       
   175       <h3>Navigation</h3>
       
   176       <ul>
       
   177         <li class="right" style="margin-right: 10px">
       
   178           <a href="genindex.html" title="General Index"
       
   179              >index</a></li>
       
   180         <li class="right" >
       
   181           <a href="py-modindex.html" title="Python Module Index"
       
   182              >modules</a> |</li>
       
   183         <li class="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
       
   184       </ul>
       
   185     </div>
       
   186     <div class="footer" role="contentinfo">
       
   187         &#169; Copyright 2017, Thierry Florac.
       
   188       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
       
   189     </div>
       
   190   </body>
       
   191 </html>