anoopmb
/
frappe
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
252 Commits
1 Branch
314 MiB
 
 
 
 
 
 
Tree: 98acabbb96
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '98acabbb96'
${ noResults }
frappe/docs/_build/html/webnotes.utils.email_lib.html

442 lines
34 KiB
Raw Blame History 

  1. 

  2. 

  3. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

  4.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  5. 

  6. <html xmlns="http://www.w3.org/1999/xhtml">

  7.   <head>

  8.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  9.     

  10.     <title>email_lib Package &mdash; WNFramework v1.8 documentation</title>

  11.     <link rel="stylesheet" href="_static/default.css" type="text/css" />

  12.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

  13.     <script type="text/javascript">

  14.       var DOCUMENTATION_OPTIONS = {

  15.         URL_ROOT:    '',

  16.         VERSION:     '1.8',

  17.         COLLAPSE_INDEX: false,

  18.         FILE_SUFFIX: '.html',

  19.         HAS_SOURCE:  true

  20.       };

  21.     </script>

  22.     <script type="text/javascript" src="_static/jquery.js"></script>

  23.     <script type="text/javascript" src="_static/underscore.js"></script>

  24.     <script type="text/javascript" src="_static/doctools.js"></script>

  25.     <link rel="top" title="WNFramework v1.8 documentation" href="index.html" /> 

  26.   </head>

  27.   <body>

  28.     <div class="related">

  29.       <h3>Navigation</h3>

  30.       <ul>

  31.         <li class="right" style="margin-right: 10px">

  32.           <a href="genindex.html" title="General Index"

  33.              accesskey="I">index</a></li>

  34.         <li class="right" >

  35.           <a href="py-modindex.html" title="Python Module Index"

  36.              >modules</a> |</li>

  37.         <li><a href="index.html">WNFramework v1.8 documentation</a> &raquo;</li> 

  38.       </ul>

  39.     </div>  

  40. 

  41.     <div class="document">

  42.       <div class="documentwrapper">

  43.         <div class="bodywrapper">

  44.           <div class="body">

  45.             

  46.   <div class="section" id="email-lib-package">

  47. <h1>email_lib Package<a class="headerlink" href="#email-lib-package" title="Permalink to this headline">¶</a></h1>

  48. <div class="section" id="id1">

  49. <h2><tt class="xref py py-mod docutils literal"><span class="pre">email_lib</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>

  50. <span class="target" id="module-webnotes.utils.email_lib"></span><dl class="function">

  51. <dt id="webnotes.utils.email_lib.get_contact_list">

  52. <tt class="descclassname">webnotes.utils.email_lib.</tt><tt class="descname">get_contact_list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib.html#get_contact_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.get_contact_list" title="Permalink to this definition">¶</a></dt>

  53. <dd><p>Returns contacts (from autosuggest)</p>

  54. </dd></dl>

  55. 

  56. <dl class="function">

  57. <dt id="webnotes.utils.email_lib.get_footer">

  58. <tt class="descclassname">webnotes.utils.email_lib.</tt><tt class="descname">get_footer</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib.html#get_footer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.get_footer" title="Permalink to this definition">¶</a></dt>

  59. <dd><p>Returns combination of footer from globals and Control Panel</p>

  60. </dd></dl>

  61. 

  62. <dl class="function">

  63. <dt id="webnotes.utils.email_lib.make_html_body">

  64. <tt class="descclassname">webnotes.utils.email_lib.</tt><tt class="descname">make_html_body</tt><big>(</big><em>content</em>, <em>template=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib.html#make_html_body"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.make_html_body" title="Permalink to this definition">¶</a></dt>

  65. <dd><p>Generate html content from a Page Template object</p>

  66. </dd></dl>

  67. 

  68. <dl class="function">

  69. <dt id="webnotes.utils.email_lib.send_form">

  70. <tt class="descclassname">webnotes.utils.email_lib.</tt><tt class="descname">send_form</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib.html#send_form"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send_form" title="Permalink to this definition">¶</a></dt>

  71. <dd><p>Emails a print format (form)

  72. Called from form UI</p>

  73. </dd></dl>

  74. 

  75. <dl class="function">

  76. <dt id="webnotes.utils.email_lib.sendmail">

  77. <tt class="descclassname">webnotes.utils.email_lib.</tt><tt class="descname">sendmail</tt><big>(</big><em>recipients</em>, <em>sender=''</em>, <em>msg=''</em>, <em>subject='[No Subject]'</em>, <em>parts=</em><span class="optional">[</span><span class="optional">]</span>, <em>cc=</em><span class="optional">[</span><span class="optional">]</span>, <em>attach=</em><span class="optional">[</span><span class="optional">]</span>, <em>send_now=1</em>, <em>reply_to=None</em>, <em>template=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib.html#sendmail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.sendmail" title="Permalink to this definition">¶</a></dt>

  78. <dd><p>send an html email as multipart with attachments and all</p>

  79. </dd></dl>

  80. 

  81. <dl class="function">

  82. <dt id="webnotes.utils.email_lib.sendmail_html">

  83. <tt class="descclassname">webnotes.utils.email_lib.</tt><tt class="descname">sendmail_html</tt><big>(</big><em>sender</em>, <em>recipients</em>, <em>subject</em>, <em>html</em>, <em>text=None</em>, <em>template=None</em>, <em>send_now=1</em>, <em>reply_to=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib.html#sendmail_html"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.sendmail_html" title="Permalink to this definition">¶</a></dt>

  84. <dd><p>Send an html mail with alternative text and using Page Templates</p>

  85. </dd></dl>

  86. 

  87. </div>

  88. <div class="section" id="module-webnotes.utils.email_lib.form_email">

  89. <span id="form-email-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">form_email</span></tt> Module<a class="headerlink" href="#module-webnotes.utils.email_lib.form_email" title="Permalink to this headline">¶</a></h2>

  90. <dl class="class">

  91. <dt id="webnotes.utils.email_lib.form_email.FormEmail">

  92. <em class="property">class </em><tt class="descclassname">webnotes.utils.email_lib.form_email.</tt><tt class="descname">FormEmail</tt><a class="reference internal" href="_modules/webnotes/utils/email_lib/form_email.html#FormEmail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.form_email.FormEmail" title="Permalink to this definition">¶</a></dt>

  93. <dd><p>Represents an email sent from a Form</p>

  94. <dl class="method">

  95. <dt id="webnotes.utils.email_lib.form_email.FormEmail.build_message">

  96. <tt class="descname">build_message</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/form_email.html#FormEmail.build_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.form_email.FormEmail.build_message" title="Permalink to this definition">¶</a></dt>

  97. <dd><p>Builds the message object</p>

  98. </dd></dl>

  99. 

  100. <dl class="method">

  101. <dt id="webnotes.utils.email_lib.form_email.FormEmail.get_form_link">

  102. <tt class="descname">get_form_link</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/form_email.html#FormEmail.get_form_link"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.form_email.FormEmail.get_form_link" title="Permalink to this definition">¶</a></dt>

  103. <dd><p>Returns publicly accessible form link</p>

  104. </dd></dl>

  105. 

  106. <dl class="method">

  107. <dt id="webnotes.utils.email_lib.form_email.FormEmail.make_full_links">

  108. <tt class="descname">make_full_links</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/form_email.html#FormEmail.make_full_links"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.form_email.FormEmail.make_full_links" title="Permalink to this definition">¶</a></dt>

  109. <dd><p>Adds server name the relative links, so that images etc can be seen correctly</p>

  110. </dd></dl>

  111. 

  112. <dl class="method">

  113. <dt id="webnotes.utils.email_lib.form_email.FormEmail.send">

  114. <tt class="descname">send</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/form_email.html#FormEmail.send"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.form_email.FormEmail.send" title="Permalink to this definition">¶</a></dt>

  115. <dd><p>Send the form with html attachment</p>

  116. </dd></dl>

  117. 

  118. <dl class="method">

  119. <dt id="webnotes.utils.email_lib.form_email.FormEmail.set_attachments">

  120. <tt class="descname">set_attachments</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/form_email.html#FormEmail.set_attachments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.form_email.FormEmail.set_attachments" title="Permalink to this definition">¶</a></dt>

  121. <dd><p>Set attachments to the email from the form</p>

  122. </dd></dl>

  123. 

  124. <dl class="method">

  125. <dt id="webnotes.utils.email_lib.form_email.FormEmail.update_contacts">

  126. <tt class="descname">update_contacts</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/form_email.html#FormEmail.update_contacts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.form_email.FormEmail.update_contacts" title="Permalink to this definition">¶</a></dt>

  127. <dd><p>Add new email contact to database</p>

  128. </dd></dl>

  129. 

  130. </dd></dl>

  131. 

  132. </div>

  133. <div class="section" id="module-webnotes.utils.email_lib.html2text">

  134. <span id="html2text-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">html2text</span></tt> Module<a class="headerlink" href="#module-webnotes.utils.email_lib.html2text" title="Permalink to this headline">¶</a></h2>

  135. <p>html2text: Turn HTML into equivalent Markdown-structured text.</p>

  136. <dl class="function">

  137. <dt id="webnotes.utils.email_lib.html2text.charref">

  138. <tt class="descclassname">webnotes.utils.email_lib.html2text.</tt><tt class="descname">charref</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/html2text.html#charref"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.html2text.charref" title="Permalink to this definition">¶</a></dt>

  139. <dd></dd></dl>

  140. 

  141. <dl class="function">

  142. <dt id="webnotes.utils.email_lib.html2text.entityref">

  143. <tt class="descclassname">webnotes.utils.email_lib.html2text.</tt><tt class="descname">entityref</tt><big>(</big><em>c</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/html2text.html#entityref"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.html2text.entityref" title="Permalink to this definition">¶</a></dt>

  144. <dd></dd></dl>

  145. 

  146. <dl class="function">

  147. <dt id="webnotes.utils.email_lib.html2text.has_key">

  148. <tt class="descclassname">webnotes.utils.email_lib.html2text.</tt><tt class="descname">has_key</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/html2text.html#has_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.html2text.has_key" title="Permalink to this definition">¶</a></dt>

  149. <dd></dd></dl>

  150. 

  151. <dl class="function">

  152. <dt id="webnotes.utils.email_lib.html2text.hn">

  153. <tt class="descclassname">webnotes.utils.email_lib.html2text.</tt><tt class="descname">hn</tt><big>(</big><em>tag</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/html2text.html#hn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.html2text.hn" title="Permalink to this definition">¶</a></dt>

  154. <dd></dd></dl>

  155. 

  156. <dl class="function">

  157. <dt id="webnotes.utils.email_lib.html2text.html2text">

  158. <tt class="descclassname">webnotes.utils.email_lib.html2text.</tt><tt class="descname">html2text</tt><big>(</big><em>html</em>, <em>baseurl=''</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/html2text.html#html2text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.html2text.html2text" title="Permalink to this definition">¶</a></dt>

  159. <dd></dd></dl>

  160. 

  161. <dl class="function">

  162. <dt id="webnotes.utils.email_lib.html2text.html2text_file">

  163. <tt class="descclassname">webnotes.utils.email_lib.html2text.</tt><tt class="descname">html2text_file</tt><big>(</big><em>html</em>, <em>out=&lt;function wrapwrite at 0x38ff030&gt;</em>, <em>baseurl=''</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/html2text.html#html2text_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.html2text.html2text_file" title="Permalink to this definition">¶</a></dt>

  164. <dd></dd></dl>

  165. 

  166. <dl class="function">

  167. <dt id="webnotes.utils.email_lib.html2text.name2cp">

  168. <tt class="descclassname">webnotes.utils.email_lib.html2text.</tt><tt class="descname">name2cp</tt><big>(</big><em>k</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/html2text.html#name2cp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.html2text.name2cp" title="Permalink to this definition">¶</a></dt>

  169. <dd></dd></dl>

  170. 

  171. <dl class="function">

  172. <dt id="webnotes.utils.email_lib.html2text.onlywhite">

  173. <tt class="descclassname">webnotes.utils.email_lib.html2text.</tt><tt class="descname">onlywhite</tt><big>(</big><em>line</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/html2text.html#onlywhite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.html2text.onlywhite" title="Permalink to this definition">¶</a></dt>

  174. <dd><p>Return true if the line does only consist of whitespace characters.</p>

  175. </dd></dl>

  176. 

  177. <dl class="function">

  178. <dt id="webnotes.utils.email_lib.html2text.optwrap">

  179. <tt class="descclassname">webnotes.utils.email_lib.html2text.</tt><tt class="descname">optwrap</tt><big>(</big><em>text</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/html2text.html#optwrap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.html2text.optwrap" title="Permalink to this definition">¶</a></dt>

  180. <dd><p>Wrap all paragraphs in the provided text.</p>

  181. </dd></dl>

  182. 

  183. <dl class="function">

  184. <dt id="webnotes.utils.email_lib.html2text.replaceEntities">

  185. <tt class="descclassname">webnotes.utils.email_lib.html2text.</tt><tt class="descname">replaceEntities</tt><big>(</big><em>s</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/html2text.html#replaceEntities"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.html2text.replaceEntities" title="Permalink to this definition">¶</a></dt>

  186. <dd></dd></dl>

  187. 

  188. <dl class="function">

  189. <dt id="webnotes.utils.email_lib.html2text.unescape">

  190. <tt class="descclassname">webnotes.utils.email_lib.html2text.</tt><tt class="descname">unescape</tt><big>(</big><em>s</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/html2text.html#unescape"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.html2text.unescape" title="Permalink to this definition">¶</a></dt>

  191. <dd></dd></dl>

  192. 

  193. <dl class="function">

  194. <dt id="webnotes.utils.email_lib.html2text.wrapwrite">

  195. <tt class="descclassname">webnotes.utils.email_lib.html2text.</tt><tt class="descname">wrapwrite</tt><big>(</big><em>text</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/html2text.html#wrapwrite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.html2text.wrapwrite" title="Permalink to this definition">¶</a></dt>

  196. <dd></dd></dl>

  197. 

  198. </div>

  199. <div class="section" id="module-webnotes.utils.email_lib.receive">

  200. <span id="receive-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">receive</span></tt> Module<a class="headerlink" href="#module-webnotes.utils.email_lib.receive" title="Permalink to this headline">¶</a></h2>

  201. <p>This module contains classes for managing incoming emails</p>

  202. <dl class="class">

  203. <dt id="webnotes.utils.email_lib.receive.IncomingMail">

  204. <em class="property">class </em><tt class="descclassname">webnotes.utils.email_lib.receive.</tt><tt class="descname">IncomingMail</tt><big>(</big><em>content</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/receive.html#IncomingMail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.receive.IncomingMail" title="Permalink to this definition">¶</a></dt>

  205. <dd><p>Single incoming email object. Extracts, text / html and attachments from the email</p>

  206. <dl class="method">

  207. <dt id="webnotes.utils.email_lib.receive.IncomingMail.get_attachment">

  208. <tt class="descname">get_attachment</tt><big>(</big><em>part</em>, <em>charset</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/receive.html#IncomingMail.get_attachment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.receive.IncomingMail.get_attachment" title="Permalink to this definition">¶</a></dt>

  209. <dd><p>Extracts an attachment</p>

  210. </dd></dl>

  211. 

  212. <dl class="method">

  213. <dt id="webnotes.utils.email_lib.receive.IncomingMail.get_charset">

  214. <tt class="descname">get_charset</tt><big>(</big><em>part</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/receive.html#IncomingMail.get_charset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.receive.IncomingMail.get_charset" title="Permalink to this definition">¶</a></dt>

  215. <dd><p>Guesses character set</p>

  216. </dd></dl>

  217. 

  218. <dl class="method">

  219. <dt id="webnotes.utils.email_lib.receive.IncomingMail.get_payload">

  220. <tt class="descname">get_payload</tt><big>(</big><em>part</em>, <em>charset</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/receive.html#IncomingMail.get_payload"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.receive.IncomingMail.get_payload" title="Permalink to this definition">¶</a></dt>

  221. <dd><p>get utf-8 encoded part content</p>

  222. </dd></dl>

  223. 

  224. <dl class="method">

  225. <dt id="webnotes.utils.email_lib.receive.IncomingMail.get_text_content">

  226. <tt class="descname">get_text_content</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/receive.html#IncomingMail.get_text_content"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.receive.IncomingMail.get_text_content" title="Permalink to this definition">¶</a></dt>

  227. <dd><p>Returns the text parts of the email. If None, then HTML parts</p>

  228. </dd></dl>

  229. 

  230. <dl class="method">

  231. <dt id="webnotes.utils.email_lib.receive.IncomingMail.get_thread_id">

  232. <tt class="descname">get_thread_id</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/receive.html#IncomingMail.get_thread_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.receive.IncomingMail.get_thread_id" title="Permalink to this definition">¶</a></dt>

  233. <dd><p>Extracts thread id of the message between first [] 

  234. from the subject</p>

  235. </dd></dl>

  236. 

  237. <dl class="method">

  238. <dt id="webnotes.utils.email_lib.receive.IncomingMail.parse">

  239. <tt class="descname">parse</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/receive.html#IncomingMail.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.receive.IncomingMail.parse" title="Permalink to this definition">¶</a></dt>

  240. <dd><p>Extracts text, html and attachments from the mail</p>

  241. </dd></dl>

  242. 

  243. <dl class="method">

  244. <dt id="webnotes.utils.email_lib.receive.IncomingMail.process_part">

  245. <tt class="descname">process_part</tt><big>(</big><em>part</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/receive.html#IncomingMail.process_part"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.receive.IncomingMail.process_part" title="Permalink to this definition">¶</a></dt>

  246. <dd><p>Process a single part of an email</p>

  247. </dd></dl>

  248. 

  249. </dd></dl>

  250. 

  251. <dl class="class">

  252. <dt id="webnotes.utils.email_lib.receive.POP3Mailbox">

  253. <em class="property">class </em><tt class="descclassname">webnotes.utils.email_lib.receive.</tt><tt class="descname">POP3Mailbox</tt><big>(</big><em>settings_doc</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/receive.html#POP3Mailbox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.receive.POP3Mailbox" title="Permalink to this definition">¶</a></dt>

  254. <dd><p>A simple pop3 mailbox, abstracts connection and mail extraction

  255. To use, subclass it and override method process_message(from, subject, text, thread_id)</p>

  256. <dl class="method">

  257. <dt id="webnotes.utils.email_lib.receive.POP3Mailbox.check_mails">

  258. <tt class="descname">check_mails</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/receive.html#POP3Mailbox.check_mails"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.receive.POP3Mailbox.check_mails" title="Permalink to this definition">¶</a></dt>

  259. <dd><p>To be overridden

  260. If mailbox is to be scanned, returns true</p>

  261. </dd></dl>

  262. 

  263. <dl class="method">

  264. <dt id="webnotes.utils.email_lib.receive.POP3Mailbox.connect">

  265. <tt class="descname">connect</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/receive.html#POP3Mailbox.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.receive.POP3Mailbox.connect" title="Permalink to this definition">¶</a></dt>

  266. <dd><p>Connects to the mailbox</p>

  267. </dd></dl>

  268. 

  269. <dl class="method">

  270. <dt id="webnotes.utils.email_lib.receive.POP3Mailbox.get_messages">

  271. <tt class="descname">get_messages</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/receive.html#POP3Mailbox.get_messages"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.receive.POP3Mailbox.get_messages" title="Permalink to this definition">¶</a></dt>

  272. <dd><p>Loads messages from the mailbox and calls

  273. process_message for each message</p>

  274. </dd></dl>

  275. 

  276. <dl class="method">

  277. <dt id="webnotes.utils.email_lib.receive.POP3Mailbox.process_message">

  278. <tt class="descname">process_message</tt><big>(</big><em>mail</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/receive.html#POP3Mailbox.process_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.receive.POP3Mailbox.process_message" title="Permalink to this definition">¶</a></dt>

  279. <dd><p>To be overriden</p>

  280. </dd></dl>

  281. 

  282. </dd></dl>

  283. 

  284. </div>

  285. <div class="section" id="module-webnotes.utils.email_lib.send">

  286. <span id="send-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">send</span></tt> Module<a class="headerlink" href="#module-webnotes.utils.email_lib.send" title="Permalink to this headline">¶</a></h2>

  287. <p>Sends email via outgoing server specified in &#8220;Control Panel&#8221;

  288. Allows easy adding of Attachments of &#8220;File&#8221; objects</p>

  289. <dl class="class">

  290. <dt id="webnotes.utils.email_lib.send.EMail">

  291. <em class="property">class </em><tt class="descclassname">webnotes.utils.email_lib.send.</tt><tt class="descname">EMail</tt><big>(</big><em>sender=''</em>, <em>recipients=</em><span class="optional">[</span><span class="optional">]</span>, <em>subject=''</em>, <em>from_defs=0</em>, <em>alternative=0</em>, <em>reply_to=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EMail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EMail" title="Permalink to this definition">¶</a></dt>

  292. <dd><p>Wrapper on the email module. Email object represents emails to be sent to the client. 

  293. Also provides a clean way to add binary <cite>FileData</cite> attachments

  294. Also sets all messages as multipart/alternative for cleaner reading in text-only clients</p>

  295. <dl class="method">

  296. <dt id="webnotes.utils.email_lib.send.EMail.add_attachment">

  297. <tt class="descname">add_attachment</tt><big>(</big><em>fname</em>, <em>fcontent</em>, <em>content_type=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EMail.add_attachment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EMail.add_attachment" title="Permalink to this definition">¶</a></dt>

  298. <dd></dd></dl>

  299. 

  300. <dl class="method">

  301. <dt id="webnotes.utils.email_lib.send.EMail.add_to_queue">

  302. <tt class="descname">add_to_queue</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EMail.add_to_queue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EMail.add_to_queue" title="Permalink to this definition">¶</a></dt>

  303. <dd></dd></dl>

  304. 

  305. <dl class="method">

  306. <dt id="webnotes.utils.email_lib.send.EMail.attach_file">

  307. <tt class="descname">attach_file</tt><big>(</big><em>n</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EMail.attach_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EMail.attach_file" title="Permalink to this definition">¶</a></dt>

  308. <dd><p>attach a file from the <cite>FileData</cite> table</p>

  309. </dd></dl>

  310. 

  311. <dl class="method">

  312. <dt id="webnotes.utils.email_lib.send.EMail.make_msg">

  313. <tt class="descname">make_msg</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EMail.make_msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EMail.make_msg" title="Permalink to this definition">¶</a></dt>

  314. <dd></dd></dl>

  315. 

  316. <dl class="method">

  317. <dt id="webnotes.utils.email_lib.send.EMail.send">

  318. <tt class="descname">send</tt><big>(</big><em>send_now=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EMail.send"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EMail.send" title="Permalink to this definition">¶</a></dt>

  319. <dd><p>send the message</p>

  320. </dd></dl>

  321. 

  322. <dl class="method">

  323. <dt id="webnotes.utils.email_lib.send.EMail.set_html">

  324. <tt class="descname">set_html</tt><big>(</big><em>message</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EMail.set_html"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EMail.set_html" title="Permalink to this definition">¶</a></dt>

  325. <dd><p>Attach message in the html portion of multipart/alternative</p>

  326. </dd></dl>

  327. 

  328. <dl class="method">

  329. <dt id="webnotes.utils.email_lib.send.EMail.set_message">

  330. <tt class="descname">set_message</tt><big>(</big><em>message</em>, <em>mime_type='text/html'</em>, <em>as_attachment=0</em>, <em>filename='attachment.html'</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EMail.set_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EMail.set_message" title="Permalink to this definition">¶</a></dt>

  331. <dd><p>Append the message with MIME content to the root node (as attachment)</p>

  332. </dd></dl>

  333. 

  334. <dl class="method">

  335. <dt id="webnotes.utils.email_lib.send.EMail.set_text">

  336. <tt class="descname">set_text</tt><big>(</big><em>message</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EMail.set_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EMail.set_text" title="Permalink to this definition">¶</a></dt>

  337. <dd><p>Attach message in the text portion of multipart/alternative</p>

  338. </dd></dl>

  339. 

  340. <dl class="method">

  341. <dt id="webnotes.utils.email_lib.send.EMail.setup">

  342. <tt class="descname">setup</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EMail.setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EMail.setup" title="Permalink to this definition">¶</a></dt>

  343. <dd><p>setup the SMTP (outgoing) server from <cite>Control Panel</cite> or defs.py</p>

  344. </dd></dl>

  345. 

  346. <dl class="method">

  347. <dt id="webnotes.utils.email_lib.send.EMail.validate">

  348. <tt class="descname">validate</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EMail.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EMail.validate" title="Permalink to this definition">¶</a></dt>

  349. <dd><p>validate the email ids</p>

  350. </dd></dl>

  351. 

  352. </dd></dl>

  353. 

  354. <dl class="class">

  355. <dt id="webnotes.utils.email_lib.send.EmailQueue">

  356. <em class="property">class </em><tt class="descclassname">webnotes.utils.email_lib.send.</tt><tt class="descname">EmailQueue</tt><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EmailQueue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EmailQueue" title="Permalink to this definition">¶</a></dt>

  357. <dd><dl class="method">

  358. <dt id="webnotes.utils.email_lib.send.EmailQueue.close">

  359. <tt class="descname">close</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EmailQueue.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EmailQueue.close" title="Permalink to this definition">¶</a></dt>

  360. <dd></dd></dl>

  361. 

  362. <dl class="method">

  363. <dt id="webnotes.utils.email_lib.send.EmailQueue.flush">

  364. <tt class="descname">flush</tt><big>(</big><em>qty=100</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EmailQueue.flush"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EmailQueue.flush" title="Permalink to this definition">¶</a></dt>

  365. <dd></dd></dl>

  366. 

  367. <dl class="method">

  368. <dt id="webnotes.utils.email_lib.send.EmailQueue.get_smtp_session">

  369. <tt class="descname">get_smtp_session</tt><big>(</big><em>e</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EmailQueue.get_smtp_session"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EmailQueue.get_smtp_session" title="Permalink to this definition">¶</a></dt>

  370. <dd></dd></dl>

  371. 

  372. <dl class="method">

  373. <dt id="webnotes.utils.email_lib.send.EmailQueue.push">

  374. <tt class="descname">push</tt><big>(</big><em>email</em><big>)</big><a class="reference internal" href="_modules/webnotes/utils/email_lib/send.html#EmailQueue.push"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.utils.email_lib.send.EmailQueue.push" title="Permalink to this definition">¶</a></dt>

  375. <dd></dd></dl>

  376. 

  377. </dd></dl>

  378. 

  379. </div>

  380. </div>

  381. 

  382. 

  383.           </div>

  384.         </div>

  385.       </div>

  386.       <div class="sphinxsidebar">

  387.         <div class="sphinxsidebarwrapper">

  388.             <p class="logo"><a href="index.html">

  389.               <img class="logo" src="_static/wnflogo200.gif" alt="Logo"/>

  390.             </a></p>

  391.   <h3><a href="index.html">Table Of Contents</a></h3>

  392.   <ul>

  393. <li><a class="reference internal" href="#">email_lib Package</a><ul>

  394. <li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">email_lib</span></tt> Package</a></li>

  395. <li><a class="reference internal" href="#module-webnotes.utils.email_lib.form_email"><tt class="docutils literal"><span class="pre">form_email</span></tt> Module</a></li>

  396. <li><a class="reference internal" href="#module-webnotes.utils.email_lib.html2text"><tt class="docutils literal"><span class="pre">html2text</span></tt> Module</a></li>

  397. <li><a class="reference internal" href="#module-webnotes.utils.email_lib.receive"><tt class="docutils literal"><span class="pre">receive</span></tt> Module</a></li>

  398. <li><a class="reference internal" href="#module-webnotes.utils.email_lib.send"><tt class="docutils literal"><span class="pre">send</span></tt> Module</a></li>

  399. </ul>

  400. </li>

  401. </ul>

  402. 

  403.   <h3>This Page</h3>

  404.   <ul class="this-page-menu">

  405.     <li><a href="_sources/webnotes.utils.email_lib.txt"

  406.            rel="nofollow">Show Source</a></li>

  407.   </ul>

  408. <div id="searchbox" style="display: none">

  409.   <h3>Quick search</h3>

  410.     <form class="search" action="search.html" method="get">

  411.       <input type="text" name="q" size="18" />

  412.       <input type="submit" value="Go" />

  413.       <input type="hidden" name="check_keywords" value="yes" />

  414.       <input type="hidden" name="area" value="default" />

  415.     </form>

  416.     <p class="searchtip" style="font-size: 90%">

  417.     Enter search terms or a module, class or function name.

  418.     </p>

  419. </div>

  420. <script type="text/javascript">$('#searchbox').show(0);</script>

  421.         </div>

  422.       </div>

  423.       <div class="clearer"></div>

  424.     </div>

  425.     <div class="related">

  426.       <h3>Navigation</h3>

  427.       <ul>

  428.         <li class="right" style="margin-right: 10px">

  429.           <a href="genindex.html" title="General Index"

  430.              >index</a></li>

  431.         <li class="right" >

  432.           <a href="py-modindex.html" title="Python Module Index"

  433.              >modules</a> |</li>

  434.         <li><a href="index.html">WNFramework v1.8 documentation</a> &raquo;</li> 

  435.       </ul>

  436.     </div>

  437.     <div class="footer">

  438.         &copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.

  439.       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.

  440.     </div>

  441.   </body>

  442. </html>