Ana Sayfa Keşfet Yardım
Giriş Yap
levovix
/
Nim
şunun yansıması https://github.com/nim-lang/Nim
İzle 1
Yıldızla 0
Çatalla 1
Dosyalar Sorunlar 0 Wiki
Dal: gh-pages
Dallar Biçim İmleri
Nim
/
smtp.html

smtp.html 64 KB
Kalıcı Bağlantı Geçmiş Ham

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534 
  1. <?xml version="1.0" encoding="utf-8" ?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <!--  This file is generated by Nim. -->
    4. 

  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
    5. 

  5. <head>
    6. 

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

  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
    8. 

  8. <title>src/smtp</title>
    9. 

  9. 

  10. <!-- Google fonts -->
    11. 

  11. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
    12. 

  12. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
    13. 

  13. 

  14. <!-- Favicon -->
    15. 

  15. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
    16. 

  16. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
    17. 

  17. 

  18. <!-- CSS -->
    19. 

  19. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
    20. 

  20. 

  21. <!-- JS -->
    22. 

  22. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
    23. 

  23. </head>
    24. 

  24. <body>
    25. 

  25.   <div class="document" id="documentId">
    26. 

  26.     <div class="container">
    27. 

  27.       <h1 class="title">src/smtp</h1>
    28. 

  28.       <div class="row">
    29. 

  29.   <div class="three columns">
    30. 

  30.     <div class="theme-select-wrapper">
    31. 

  31.       <label for="theme-select">Theme:&nbsp;</label>
    32. 

  32.       <select id="theme-select" onchange="setTheme(this.value)">
    33. 

  33.         <option value="auto">🌗 Match OS</option>
    34. 

  34.         <option value="dark">🌑 Dark</option>
    35. 

  35.         <option value="light">🌕 Light</option>
    36. 

  36.       </select>
    37. 

  37.     </div>
    38. 

  38.     <div id="global-links">
    39. 

  39.       <ul class="simple-boot">
    40. 

  40.         <li><a href="manual.html">Manual</a></li>
    41. 

  41.         <li><a href="lib.html">Standard library</a></li>
    42. 

  42.         <li> <a id="indexLink" href="theindex.html">Index</a></li>
    43. 

  43.         <li><a href="compiler/theindex.html">Compiler docs</a></li>
    44. 

  44.         <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
    45. 

  45.         <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
    46. 

  46.       </ul>
    47. 

  47.     </div>
    48. 

  48.     <div id="searchInputDiv">
    49. 

  49.       Search: <input type="search" id="searchInput"
    50. 

  50.         oninput="search()" />
    51. 

  51.     </div>
    52. 

  52.     
    53. 

  53.     <ul class="simple simple-toc" id="toc-list">
    54. 

  54.   <li>
    55. 

  55.   <details open>
    56. 

  56.     <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    57. 

  57.     <ul class="simple simple-toc-section">
    58. 

  58.       <li><a class="reference" href="#AsyncSmtp" title="AsyncSmtp = SmtpBase[AsyncSocket]">AsyncSmtp</a></li>
    59. 

  59. <li><a class="reference" href="#Message" title="Message = object">Message</a></li>
    60. 

  60. <li><a class="reference" href="#ReplyError" title="ReplyError = object of IOError">ReplyError</a></li>
    61. 

  61. <li><a class="reference" href="#Smtp" title="Smtp = SmtpBase[Socket]">Smtp</a></li>
    62. 

  62. 

  63.     </ul>
    64. 

  64.   </details>
    65. 

  65. </li>
    66. 

  66. <li>
    67. 

  67.   <details open>
    68. 

  68.     <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    69. 

  69.     <ul class="simple simple-toc-section">
    70. 

  70.       <ul class="simple nested-toc-section">$
    71. 

  71.   <li><a class="reference" href="#%24%2CMessage" title="`$`(msg: Message): string">`$`(msg: Message): string</a></li>
    72. 

  72. 

  73. </ul>
    74. 

  74. <ul class="simple nested-toc-section">auth
    75. 

  75.   <li><a class="reference" href="#auth%2CAsyncSmtp%2Cstring%2Cstring" title="auth(smtp: AsyncSmtp; username, password: string): owned(Future[void])">auth(smtp: AsyncSmtp; username, password: string): owned(Future[void])</a></li>
    76. 

  76. <li><a class="reference" href="#auth%2CSmtp%2Cstring%2Cstring" title="auth(smtp: Smtp; username, password: string)">auth(smtp: Smtp; username, password: string)</a></li>
    77. 

  77. 

  78. </ul>
    79. 

  79. <ul class="simple nested-toc-section">checkReply
    80. 

  80.   <li><a class="reference" href="#checkReply%2CAsyncSmtp%2Cstring" title="checkReply(smtp: AsyncSmtp; reply: string): owned(Future[void])">checkReply(smtp: AsyncSmtp; reply: string): owned(Future[void])</a></li>
    81. 

  81. <li><a class="reference" href="#checkReply%2CSmtp%2Cstring" title="checkReply(smtp: Smtp; reply: string)">checkReply(smtp: Smtp; reply: string)</a></li>
    82. 

  82. 

  83. </ul>
    84. 

  84. <ul class="simple nested-toc-section">close
    85. 

  85.   <li><a class="reference" href="#close%2CAsyncSmtp" title="close(smtp: AsyncSmtp): owned(Future[void])">close(smtp: AsyncSmtp): owned(Future[void])</a></li>
    86. 

  86. <li><a class="reference" href="#close%2CSmtp" title="close(smtp: Smtp)">close(smtp: Smtp)</a></li>
    87. 

  87. 

  88. </ul>
    89. 

  89. <ul class="simple nested-toc-section">connect
    90. 

  90.   <li><a class="reference" href="#connect%2CAsyncSmtp%2Cstring%2CPort" title="connect(smtp: AsyncSmtp; address: string; port: Port): owned(Future[void])">connect(smtp: AsyncSmtp; address: string; port: Port): owned(Future[void])</a></li>
    91. 

  91. <li><a class="reference" href="#connect%2CSmtp%2Cstring%2CPort" title="connect(smtp: Smtp; address: string; port: Port)">connect(smtp: Smtp; address: string; port: Port)</a></li>
    92. 

  92. 

  93. </ul>
    94. 

  94. <ul class="simple nested-toc-section">createMessage
    95. 

  95.   <li><a class="reference" href="#createMessage%2Cstring%2Cstring%2Cseq%5Bstring%5D%2Cseq%5Bstring%5D" title="createMessage(mSubject, mBody: string; mTo, mCc: seq[string] = @[]): Message">createMessage(mSubject, mBody: string; mTo, mCc: seq[string] = @[]): Message</a></li>
    96. 

  96. <li><a class="reference" href="#createMessage%2Cstring%2Cstring%2Cseq%5Bstring%5D%2Cseq%5Bstring%5D%2CopenArray%5Btuple%5Bstring%2Cstring%5D%5D" title="createMessage(mSubject, mBody: string; mTo, mCc: seq[string];
    97. 

  97.               otherHeaders: openArray[tuple[name, value: string]]): Message">createMessage(mSubject, mBody: string; mTo, mCc: seq[string];
    98. 

  98.               otherHeaders: openArray[tuple[name, value: string]]): Message</a></li>
    99. 

  99. 

  100. </ul>
    101. 

  101. <ul class="simple nested-toc-section">debugRecv
    102. 

  102.   <li><a class="reference" href="#debugRecv%2CAsyncSmtp" title="debugRecv(smtp: AsyncSmtp): Future[string]">debugRecv(smtp: AsyncSmtp): Future[string]</a></li>
    103. 

  103. <li><a class="reference" href="#debugRecv%2CSmtp" title="debugRecv(smtp: Smtp): string">debugRecv(smtp: Smtp): string</a></li>
    104. 

  104. 

  105. </ul>
    106. 

  106. <ul class="simple nested-toc-section">debugSend
    107. 

  107.   <li><a class="reference" href="#debugSend%2CAsyncSmtp%2Cstring" title="debugSend(smtp: AsyncSmtp; cmd: string): owned(Future[void])">debugSend(smtp: AsyncSmtp; cmd: string): owned(Future[void])</a></li>
    108. 

  108. <li><a class="reference" href="#debugSend%2CSmtp%2Cstring" title="debugSend(smtp: Smtp; cmd: string)">debugSend(smtp: Smtp; cmd: string)</a></li>
    109. 

  109. 

  110. </ul>
    111. 

  111. <ul class="simple nested-toc-section">ehlo
    112. 

  112.   <li><a class="reference" href="#ehlo%2CAsyncSmtp" title="ehlo(smtp: AsyncSmtp): Future[bool]">ehlo(smtp: AsyncSmtp): Future[bool]</a></li>
    113. 

  113. <li><a class="reference" href="#ehlo%2CSmtp" title="ehlo(smtp: Smtp): bool">ehlo(smtp: Smtp): bool</a></li>
    114. 

  114. 

  115. </ul>
    116. 

  116. <ul class="simple nested-toc-section">helo
    117. 

  117.   <li><a class="reference" href="#helo%2CAsyncSmtp" title="helo(smtp: AsyncSmtp): owned(Future[void])">helo(smtp: AsyncSmtp): owned(Future[void])</a></li>
    118. 

  118. <li><a class="reference" href="#helo%2CSmtp" title="helo(smtp: Smtp)">helo(smtp: Smtp)</a></li>
    119. 

  119. 

  120. </ul>
    121. 

  121. <ul class="simple nested-toc-section">newAsyncSmtp
    122. 

  122.   <li><a class="reference" href="#newAsyncSmtp%2CSslContext" title="newAsyncSmtp(useSsl = false; debug = false; sslContext: SslContext = nil): AsyncSmtp">newAsyncSmtp(useSsl = false; debug = false; sslContext: SslContext = nil): AsyncSmtp</a></li>
    123. 

  123. 

  124. </ul>
    125. 

  125. <ul class="simple nested-toc-section">newSmtp
    126. 

  126.   <li><a class="reference" href="#newSmtp%2CSslContext" title="newSmtp(useSsl = false; debug = false; sslContext: SslContext = nil): Smtp">newSmtp(useSsl = false; debug = false; sslContext: SslContext = nil): Smtp</a></li>
    127. 

  127. 

  128. </ul>
    129. 

  129. <ul class="simple nested-toc-section">sendMail
    130. 

  130.   <li><a class="reference" href="#sendMail%2CAsyncSmtp%2Cstring%2Cseq%5Bstring%5D%2Cstring" title="sendMail(smtp: AsyncSmtp; fromAddr: string; toAddrs: seq[string]; msg: string): owned(
    131. 

  131.     Future[void])">sendMail(smtp: AsyncSmtp; fromAddr: string; toAddrs: seq[string]; msg: string): owned(
    132. 

  132.     Future[void])</a></li>
    133. 

  133. <li><a class="reference" href="#sendMail%2CSmtp%2Cstring%2Cseq%5Bstring%5D%2Cstring" title="sendMail(smtp: Smtp; fromAddr: string; toAddrs: seq[string]; msg: string)">sendMail(smtp: Smtp; fromAddr: string; toAddrs: seq[string]; msg: string)</a></li>
    134. 

  134. 

  135. </ul>
    136. 

  136. <ul class="simple nested-toc-section">startTls
    137. 

  137.   <li><a class="reference" href="#startTls%2CAsyncSmtp%2CSslContext" title="startTls(smtp: AsyncSmtp; sslContext: SslContext = nil): owned(Future[void])">startTls(smtp: AsyncSmtp; sslContext: SslContext = nil): owned(Future[void])</a></li>
    138. 

  138. <li><a class="reference" href="#startTls%2CSmtp%2CSslContext" title="startTls(smtp: Smtp; sslContext: SslContext = nil)">startTls(smtp: Smtp; sslContext: SslContext = nil)</a></li>
    139. 

  139. 

  140. </ul>
    141. 

  141. 

  142.     </ul>
    143. 

  143.   </details>
    144. 

  144. </li>
    145. 

  145. 

  146. </ul>
    147. 

  147. 

  148.   </div>
    149. 

  149.   <div class="nine columns" id="content">
    150. 

  150.     
    151. 

  151.     <div id="tocRoot"></div>
    152. 

  152.     
    153. 

  153.     <p class="module-desc"><div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
    154. 

  154. In order to use this module, run <tt class="docutils literal"><span class="pre"><span class="Identifier">nimble</span> <span class="Identifier">install</span> <span class="Identifier">smtp</span></span></tt>.</div>
    155. 

  155. <p>This module implements the SMTP client protocol as specified by RFC 5321, this can be used to send mail to any SMTP Server.</p>
    156. 

  156. <p>This module also implements the protocol used to format messages, as specified by RFC 2822.</p>
    157. 

  157. <p>Example gmail use:</p>
    158. 

  158. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">msg</span> <span class="Operator">=</span> <span class="Identifier">createMessage</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello from Nim's SMTP&quot;</span><span class="Punctuation">,</span>
    159. 

  159.                         <span class="StringLit">&quot;Hello!.</span><span class="EscapeSequence">\n</span><span class="StringLit"> Is this awesome or what?&quot;</span><span class="Punctuation">,</span>
    160. 

  160.                         <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;foo@gmail.com&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    161. 

  161. <span class="Keyword">let</span> <span class="Identifier">smtpConn</span> <span class="Operator">=</span> <span class="Identifier">newSmtp</span><span class="Punctuation">(</span><span class="Identifier">useSsl</span> <span class="Operator">=</span> <span class="Identifier">true</span><span class="Punctuation">,</span> <span class="Identifier">debug</span><span class="Operator">=</span><span class="Identifier">true</span><span class="Punctuation">)</span>
    162. 

  162. <span class="Identifier">smtpConn</span><span class="Operator">.</span><span class="Identifier">connect</span><span class="Punctuation">(</span><span class="StringLit">&quot;smtp.gmail.com&quot;</span><span class="Punctuation">,</span> <span class="Identifier">Port</span> <span class="DecNumber">465</span><span class="Punctuation">)</span>
    163. 

  163. <span class="Identifier">smtpConn</span><span class="Operator">.</span><span class="Identifier">auth</span><span class="Punctuation">(</span><span class="StringLit">&quot;username&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;password&quot;</span><span class="Punctuation">)</span>
    164. 

  164. <span class="Identifier">smtpConn</span><span class="Operator">.</span><span class="Identifier">sendmail</span><span class="Punctuation">(</span><span class="StringLit">&quot;username@gmail.com&quot;</span><span class="Punctuation">,</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;foo@gmail.com&quot;</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Operator">$</span><span class="Identifier">msg</span><span class="Punctuation">)</span></pre><p>Example for startTls use:</p>
    165. 

  165. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">msg</span> <span class="Operator">=</span> <span class="Identifier">createMessage</span><span class="Punctuation">(</span><span class="StringLit">&quot;Hello from Nim's SMTP&quot;</span><span class="Punctuation">,</span>
    166. 

  166.                         <span class="StringLit">&quot;Hello!.</span><span class="EscapeSequence">\n</span><span class="StringLit"> Is this awesome or what?&quot;</span><span class="Punctuation">,</span>
    167. 

  167.                         <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;foo@gmail.com&quot;</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
    168. 

  168. <span class="Keyword">let</span> <span class="Identifier">smtpConn</span> <span class="Operator">=</span> <span class="Identifier">newSmtp</span><span class="Punctuation">(</span><span class="Identifier">debug</span><span class="Operator">=</span><span class="Identifier">true</span><span class="Punctuation">)</span>
    169. 

  169. <span class="Identifier">smtpConn</span><span class="Operator">.</span><span class="Identifier">connect</span><span class="Punctuation">(</span><span class="StringLit">&quot;smtp.mailtrap.io&quot;</span><span class="Punctuation">,</span> <span class="Identifier">Port</span> <span class="DecNumber">2525</span><span class="Punctuation">)</span>
    170. 

  170. <span class="Identifier">smtpConn</span><span class="Operator">.</span><span class="Identifier">startTls</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
    171. 

  171. <span class="Identifier">smtpConn</span><span class="Operator">.</span><span class="Identifier">auth</span><span class="Punctuation">(</span><span class="StringLit">&quot;username&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;password&quot;</span><span class="Punctuation">)</span>
    172. 

  172. <span class="Identifier">smtpConn</span><span class="Operator">.</span><span class="Identifier">sendmail</span><span class="Punctuation">(</span><span class="StringLit">&quot;username@gmail.com&quot;</span><span class="Punctuation">,</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">&quot;foo@gmail.com&quot;</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Operator">$</span><span class="Identifier">msg</span><span class="Punctuation">)</span></pre><p>For SSL support this module relies on OpenSSL. If you want to enable SSL, compile with <tt class="docutils literal"><span class="pre"><span class="Operator">-</span><span class="Identifier">d</span><span class="Punctuation">:</span><span class="Identifier">ssl</span></span></tt>.</p>
    173. 

  173. </p>
    174. 

  174.     <div class="section" id="7">
    175. 

  175.   <h1><a class="toc-backref" href="#7">Types</a></h1>
    176. 

  176.   <dl class="item">
    177. 

  177.     <div id="AsyncSmtp">
    178. 

  178.   <dt><pre><a href="smtp.html#AsyncSmtp"><span class="Identifier">AsyncSmtp</span></a> <span class="Other">=</span> <span class="Identifier">SmtpBase</span><span class="Other">[</span><span class="Identifier">AsyncSocket</span><span class="Other">]</span></pre></dt>
    179. 

  179.   <dd>
    180. 

  180.     
    181. 

  181.     
    182. 

  182.     
    183. 

  183.   </dd>
    184. 

  184. </div>
    185. 

  185. <div id="Message">
    186. 

  186.   <dt><pre><a href="smtp.html#Message"><span class="Identifier">Message</span></a> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
    187. 

  187.   <dd>
    188. 

  188.     
    189. 

  189.     
    190. 

  190.     
    191. 

  191.   </dd>
    192. 

  192. </div>
    193. 

  193. <div id="ReplyError">
    194. 

  194.   <dt><pre><a href="smtp.html#ReplyError"><span class="Identifier">ReplyError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">IOError</span></pre></dt>
    195. 

  195.   <dd>
    196. 

  196.     
    197. 

  197.     
    198. 

  198.     
    199. 

  199.   </dd>
    200. 

  200. </div>
    201. 

  201. <div id="Smtp">
    202. 

  202.   <dt><pre><a href="smtp.html#Smtp"><span class="Identifier">Smtp</span></a> <span class="Other">=</span> <span class="Identifier">SmtpBase</span><span class="Other">[</span><span class="Identifier">Socket</span><span class="Other">]</span></pre></dt>
    203. 

  203.   <dd>
    204. 

  204.     
    205. 

  205.     
    206. 

  206.     
    207. 

  207.   </dd>
    208. 

  208. </div>
    209. 

  209. 

  210.   </dl>
    211. 

  211. </div>
    212. 

  212. <div class="section" id="12">
    213. 

  213.   <h1><a class="toc-backref" href="#12">Procs</a></h1>
    214. 

  214.   <dl class="item">
    215. 

  215.     <div id="$-procs-all">
    216. 

  216.   <div id="$,Message">
    217. 

  217.   <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CMessage"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">msg</span><span class="Other">:</span> <a href="smtp.html#Message"><span class="Identifier">Message</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    218. 

  218.   <dd>
    219. 

  219.     
    220. 

  220.     stringify for <tt class="docutils literal"><span class="pre"><span class="Identifier">Message</span></span></tt>.
    221. 

  221.     
    222. 

  222.   </dd>
    223. 

  223. </div>
    224. 

  224. 

  225. </div>
    226. 

  226. <div id="auth-procs-all">
    227. 

  227.   <div id="auth,AsyncSmtp,string,string">
    228. 

  228.   <dt><pre><span class="Keyword">proc</span> <a href="#auth%2CAsyncSmtp%2Cstring%2Cstring"><span class="Identifier">auth</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#AsyncSmtp"><span class="Identifier">AsyncSmtp</span></a><span class="Other">;</span> <span class="Identifier">username</span><span class="Other">,</span> <span class="Identifier">password</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">)</span> {.
    229. 

  229.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
    230. 

  230.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    231. 

  231.   <dd>
    232. 

  232.     
    233. 

  233.     Sends an AUTH command to the server to login as the <tt class="docutils literal"><span class="pre"><span class="Identifier">username</span></span></tt> using <tt class="docutils literal"><span class="pre"><span class="Identifier">password</span></span></tt>. May fail with ReplyError.
    234. 

  234.     
    235. 

  235.   </dd>
    236. 

  236. </div>
    237. 

  237. <div id="auth,Smtp,string,string">
    238. 

  238.   <dt><pre><span class="Keyword">proc</span> <a href="#auth%2CSmtp%2Cstring%2Cstring"><span class="Identifier">auth</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#Smtp"><span class="Identifier">Smtp</span></a><span class="Other">;</span> <span class="Identifier">username</span><span class="Other">,</span> <span class="Identifier">password</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span> {.
    239. 

  239.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">TimeoutError</span><span class="Other">,</span> <span class="Identifier">ReplyError</span><span class="Other">]</span><span class="Other">,</span>
    240. 

  240.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    241. 

  241.   <dd>
    242. 

  242.     
    243. 

  243.     
    244. 

  244.     
    245. 

  245.   </dd>
    246. 

  246. </div>
    247. 

  247. 

  248. </div>
    249. 

  249. <div id="checkReply-procs-all">
    250. 

  250.   <div id="checkReply,AsyncSmtp,string">
    251. 

  251.   <dt><pre><span class="Keyword">proc</span> <a href="#checkReply%2CAsyncSmtp%2Cstring"><span class="Identifier">checkReply</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#AsyncSmtp"><span class="Identifier">AsyncSmtp</span></a><span class="Other">;</span> <span class="Identifier">reply</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">)</span> {.
    252. 

  252.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">]</span><span class="Other">,</span>
    253. 

  253.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    254. 

  254.   <dd>
    255. 

  255.     
    256. 

  256.     <p>Calls <a class="reference external" href="#debugRecv,AsyncSmtp">debugRecv</a> and checks that the received data starts with <tt class="docutils literal"><span class="pre"><span class="Identifier">reply</span></span></tt>. If the received data does not start with <tt class="docutils literal"><span class="pre"><span class="Identifier">reply</span></span></tt>, then a <tt class="docutils literal"><span class="pre"><span class="Identifier">QUIT</span></span></tt> command will be sent to the SMTP server and a <tt class="docutils literal"><span class="pre"><span class="Identifier">ReplyError</span></span></tt> exception will be raised.</p>
    257. 

  257. <p>This is a lower level proc and not something that you typically would need to call when using this module. One exception to this is if you are implementing any <a class="reference external" href="https://en.wikipedia.org/wiki/Extended_SMTP">SMTP extensions</a>.</p>
    258. 

  258. 

  259.     
    260. 

  260.   </dd>
    261. 

  261. </div>
    262. 

  262. <div id="checkReply,Smtp,string">
    263. 

  263.   <dt><pre><span class="Keyword">proc</span> <a href="#checkReply%2CSmtp%2Cstring"><span class="Identifier">checkReply</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#Smtp"><span class="Identifier">Smtp</span></a><span class="Other">;</span> <span class="Identifier">reply</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span> {.
    264. 

  264.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimeoutError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">ReplyError</span><span class="Other">]</span><span class="Other">,</span>
    265. 

  265.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    266. 

  266.   <dd>
    267. 

  267.     
    268. 

  268.     
    269. 

  269.     
    270. 

  270.   </dd>
    271. 

  271. </div>
    272. 

  272. 

  273. </div>
    274. 

  274. <div id="close-procs-all">
    275. 

  275.   <div id="close,AsyncSmtp">
    276. 

  276.   <dt><pre><span class="Keyword">proc</span> <a href="#close%2CAsyncSmtp"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#AsyncSmtp"><span class="Identifier">AsyncSmtp</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
    277. 

  277.     <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">LibraryError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
    278. 

  278.     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    279. 

  279.   <dd>
    280. 

  280.     
    281. 

  281.     Disconnects from the SMTP server and closes the socket.
    282. 

  282.     
    283. 

  283.   </dd>
    284. 

  284. </div>
    285. 

  285. <div id="close,Smtp">
    286. 

  286.   <dt><pre><span class="Keyword">proc</span> <a href="#close%2CSmtp"><span class="Identifier">close</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#Smtp"><span class="Identifier">Smtp</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">LibraryError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
    287. 

  287.                          <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    288. 

  288.   <dd>
    289. 

  289.     
    290. 

  290.     
    291. 

  291.     
    292. 

  292.   </dd>
    293. 

  293. </div>
    294. 

  294. 

  295. </div>
    296. 

  296. <div id="connect-procs-all">
    297. 

  297.   <div id="connect,AsyncSmtp,string,Port">
    298. 

  298.   <dt><pre><span class="Keyword">proc</span> <a href="#connect%2CAsyncSmtp%2Cstring%2CPort"><span class="Identifier">connect</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#AsyncSmtp"><span class="Identifier">AsyncSmtp</span></a><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">port</span><span class="Other">:</span> <span class="Identifier">Port</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span>
    299. 

  299.     <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">,</span>
    300. 

  300.     <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    301. 

  301.   <dd>
    302. 

  302.     
    303. 

  303.     Establishes a connection with a SMTP server. May fail with ReplyError or with a socket error.
    304. 

  304.     
    305. 

  305.   </dd>
    306. 

  306. </div>
    307. 

  307. <div id="connect,Smtp,string,Port">
    308. 

  308.   <dt><pre><span class="Keyword">proc</span> <a href="#connect%2CSmtp%2Cstring%2CPort"><span class="Identifier">connect</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#Smtp"><span class="Identifier">Smtp</span></a><span class="Other">;</span> <span class="Identifier">address</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">port</span><span class="Other">:</span> <span class="Identifier">Port</span><span class="Other">)</span> {.
    309. 

  309.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">TimeoutError</span><span class="Other">,</span> <span class="Identifier">ReplyError</span><span class="Other">]</span><span class="Other">,</span>
    310. 

  310.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    311. 

  311.   <dd>
    312. 

  312.     
    313. 

  313.     
    314. 

  314.     
    315. 

  315.   </dd>
    316. 

  316. </div>
    317. 

  317. 

  318. </div>
    319. 

  319. <div id="createMessage-procs-all">
    320. 

  320.   <div id="createMessage,string,string,seq[string],seq[string]">
    321. 

  321.   <dt><pre><span class="Keyword">proc</span> <a href="#createMessage%2Cstring%2Cstring%2Cseq%5Bstring%5D%2Cseq%5Bstring%5D"><span class="Identifier">createMessage</span></a><span class="Other">(</span><span class="Identifier">mSubject</span><span class="Other">,</span> <span class="Identifier">mBody</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">mTo</span><span class="Other">,</span> <span class="Identifier">mCc</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="smtp.html#Message"><span class="Identifier">Message</span></a> {.
    322. 

  322.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    323. 

  323.   <dd>
    324. 

  324.     
    325. 

  325.     <p>Alternate version of the above.</p>
    326. 

  326. <p>You need to make sure that <tt class="docutils literal"><span class="pre"><span class="Identifier">mSubject</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">mTo</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">mCc</span></span></tt> don't contain any newline characters. Failing to do so will raise <tt class="docutils literal"><span class="pre"><span class="Identifier">AssertionDefect</span></span></tt>.</p>
    327. 

  327. 

  328.     
    329. 

  329.   </dd>
    330. 

  330. </div>
    331. 

  331. <div id="createMessage,string,string,seq[string],seq[string],openArray[tuple[string,string]]">
    332. 

  332.   <dt><pre><span class="Keyword">proc</span> <a href="#createMessage%2Cstring%2Cstring%2Cseq%5Bstring%5D%2Cseq%5Bstring%5D%2CopenArray%5Btuple%5Bstring%2Cstring%5D%5D"><span class="Identifier">createMessage</span></a><span class="Other">(</span><span class="Identifier">mSubject</span><span class="Other">,</span> <span class="Identifier">mBody</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">mTo</span><span class="Other">,</span> <span class="Identifier">mCc</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">;</span>
    333. 

  333.                    <span class="Identifier">otherHeaders</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">name</span><span class="Other">,</span> <span class="Identifier">value</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">]</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="smtp.html#Message"><span class="Identifier">Message</span></a> {.
    334. 

  334.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    335. 

  335.   <dd>
    336. 

  336.     
    337. 

  337.     <p>Creates a new MIME compliant message.</p>
    338. 

  338. <p>You need to make sure that <tt class="docutils literal"><span class="pre"><span class="Identifier">mSubject</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">mTo</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">mCc</span></span></tt> don't contain any newline characters. Failing to do so will raise <tt class="docutils literal"><span class="pre"><span class="Identifier">AssertionDefect</span></span></tt>.</p>
    339. 

  339. 

  340.     
    341. 

  341.   </dd>
    342. 

  342. </div>
    343. 

  343. 

  344. </div>
    345. 

  345. <div id="debugRecv-procs-all">
    346. 

  346.   <div id="debugRecv,AsyncSmtp">
    347. 

  347.   <dt><pre><span class="Keyword">proc</span> <a href="#debugRecv%2CAsyncSmtp"><span class="Identifier">debugRecv</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#AsyncSmtp"><span class="Identifier">AsyncSmtp</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
    348. 

  348.     <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    349. 

  349.   <dd>
    350. 

  350.     
    351. 

  351.     <p>Receives a line of data from the socket connected to the SMTP server.</p>
    352. 

  352. <p>If the <tt class="docutils literal"><span class="pre"><span class="Identifier">smtp</span></span></tt> object was created with <tt class="docutils literal"><span class="pre"><span class="Identifier">debug</span></span></tt> enabled, debugRecv will invoke <tt class="docutils literal"><span class="pre"><span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;S:&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">result</span><span class="Operator">.</span><span class="Identifier">string</span><span class="Punctuation">)</span></span></tt> after the data is received.</p>
    353. 

  353. <p>This is a lower level proc and not something that you typically would need to call when using this module. One exception to this is if you are implementing any <a class="reference external" href="https://en.wikipedia.org/wiki/Extended_SMTP">SMTP extensions</a>.</p>
    354. 

  354. <p>See <a class="reference external" href="#checkReply,AsyncSmtp,string">checkReply(reply)</a>.</p>
    355. 

  355. 

  356.     
    357. 

  357.   </dd>
    358. 

  358. </div>
    359. 

  359. <div id="debugRecv,Smtp">
    360. 

  360.   <dt><pre><span class="Keyword">proc</span> <a href="#debugRecv%2CSmtp"><span class="Identifier">debugRecv</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#Smtp"><span class="Identifier">Smtp</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">TimeoutError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">]</span><span class="Other">,</span>
    361. 

  361.                                      <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span><span class="Other">,</span>
    362. 

  362.                                      <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    363. 

  363.   <dd>
    364. 

  364.     
    365. 

  365.     
    366. 

  366.     
    367. 

  367.   </dd>
    368. 

  368. </div>
    369. 

  369. 

  370. </div>
    371. 

  371. <div id="debugSend-procs-all">
    372. 

  372.   <div id="debugSend,AsyncSmtp,string">
    373. 

  373.   <dt><pre><span class="Keyword">proc</span> <a href="#debugSend%2CAsyncSmtp%2Cstring"><span class="Identifier">debugSend</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#AsyncSmtp"><span class="Identifier">AsyncSmtp</span></a><span class="Other">;</span> <span class="Identifier">cmd</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">)</span> {.
    374. 

  374.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
    375. 

  375.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    376. 

  376.   <dd>
    377. 

  377.     
    378. 

  378.     <p>Sends <tt class="docutils literal"><span class="pre"><span class="Identifier">cmd</span></span></tt> on the socket connected to the SMTP server.</p>
    379. 

  379. <p>If the <tt class="docutils literal"><span class="pre"><span class="Identifier">smtp</span></span></tt> object was created with <tt class="docutils literal"><span class="pre"><span class="Identifier">debug</span></span></tt> enabled, debugSend will invoke <tt class="docutils literal"><span class="pre"><span class="Identifier">echo</span><span class="Punctuation">(</span><span class="StringLit">&quot;C:&quot;</span> <span class="Operator">&amp;</span> <span class="Identifier">cmd</span><span class="Punctuation">)</span></span></tt> before sending.</p>
    380. 

  380. <p>This is a lower level proc and not something that you typically would need to call when using this module. One exception to this is if you are implementing any <a class="reference external" href="https://en.wikipedia.org/wiki/Extended_SMTP">SMTP extensions</a>.</p>
    381. 

  381. 

  382.     
    383. 

  383.   </dd>
    384. 

  384. </div>
    385. 

  385. <div id="debugSend,Smtp,string">
    386. 

  386.   <dt><pre><span class="Keyword">proc</span> <a href="#debugSend%2CSmtp%2Cstring"><span class="Identifier">debugSend</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#Smtp"><span class="Identifier">Smtp</span></a><span class="Other">;</span> <span class="Identifier">cmd</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span>
    387. 

  387.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    388. 

  388.   <dd>
    389. 

  389.     
    390. 

  390.     
    391. 

  391.     
    392. 

  392.   </dd>
    393. 

  393. </div>
    394. 

  394. 

  395. </div>
    396. 

  396. <div id="ehlo-procs-all">
    397. 

  397.   <div id="ehlo,AsyncSmtp">
    398. 

  398.   <dt><pre><span class="Keyword">proc</span> <a href="#ehlo%2CAsyncSmtp"><span class="Identifier">ehlo</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#AsyncSmtp"><span class="Identifier">AsyncSmtp</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">bool</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
    399. 

  399.     <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    400. 

  400.   <dd>
    401. 

  401.     
    402. 

  402.     Sends EHLO request.
    403. 

  403.     
    404. 

  404.   </dd>
    405. 

  405. </div>
    406. 

  406. <div id="ehlo,Smtp">
    407. 

  407.   <dt><pre><span class="Keyword">proc</span> <a href="#ehlo%2CSmtp"><span class="Identifier">ehlo</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#Smtp"><span class="Identifier">Smtp</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">TimeoutError</span><span class="Other">]</span><span class="Other">,</span>
    408. 

  408.                               <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span><span class="Other">,</span>
    409. 

  409.                               <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    410. 

  410.   <dd>
    411. 

  411.     
    412. 

  412.     
    413. 

  413.     
    414. 

  414.   </dd>
    415. 

  415. </div>
    416. 

  416. 

  417. </div>
    418. 

  418. <div id="helo-procs-all">
    419. 

  419.   <div id="helo,AsyncSmtp">
    420. 

  420.   <dt><pre><span class="Keyword">proc</span> <a href="#helo%2CAsyncSmtp"><span class="Identifier">helo</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#AsyncSmtp"><span class="Identifier">AsyncSmtp</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
    421. 

  421.     <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    422. 

  422.   <dd>
    423. 

  423.     
    424. 

  424.     
    425. 

  425.     
    426. 

  426.   </dd>
    427. 

  427. </div>
    428. 

  428. <div id="helo,Smtp">
    429. 

  429.   <dt><pre><span class="Keyword">proc</span> <a href="#helo%2CSmtp"><span class="Identifier">helo</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#Smtp"><span class="Identifier">Smtp</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">TimeoutError</span><span class="Other">,</span> <span class="Identifier">ReplyError</span><span class="Other">]</span><span class="Other">,</span>
    430. 

  430.                         <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span><span class="Other">,</span>
    431. 

  431.                         <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    432. 

  432.   <dd>
    433. 

  433.     
    434. 

  434.     
    435. 

  435.     
    436. 

  436.   </dd>
    437. 

  437. </div>
    438. 

  438. 

  439. </div>
    440. 

  440. <div id="newAsyncSmtp-procs-all">
    441. 

  441.   <div id="newAsyncSmtp,SslContext">
    442. 

  442.   <dt><pre><span class="Keyword">proc</span> <a href="#newAsyncSmtp%2CSslContext"><span class="Identifier">newAsyncSmtp</span></a><span class="Other">(</span><span class="Identifier">useSsl</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">debug</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">sslContext</span><span class="Other">:</span> <span class="Identifier">SslContext</span> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="smtp.html#AsyncSmtp"><span class="Identifier">AsyncSmtp</span></a> {.
    443. 

  443.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">LibraryError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    444. 

  444.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">ReadDirEffect</span><span class="Other">,</span> <span class="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    445. 

  445.   <dd>
    446. 

  446.     
    447. 

  447.     Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">AsyncSmtp</span></span></tt> instance.
    448. 

  448.     
    449. 

  449.   </dd>
    450. 

  450. </div>
    451. 

  451. 

  452. </div>
    453. 

  453. <div id="newSmtp-procs-all">
    454. 

  454.   <div id="newSmtp,SslContext">
    455. 

  455.   <dt><pre><span class="Keyword">proc</span> <a href="#newSmtp%2CSslContext"><span class="Identifier">newSmtp</span></a><span class="Other">(</span><span class="Identifier">useSsl</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">debug</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">;</span> <span class="Identifier">sslContext</span><span class="Other">:</span> <span class="Identifier">SslContext</span> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="smtp.html#Smtp"><span class="Identifier">Smtp</span></a> {.
    456. 

  456.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">LibraryError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
    457. 

  457.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">ReadDirEffect</span><span class="Other">,</span> <span class="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    458. 

  458.   <dd>
    459. 

  459.     
    460. 

  460.     Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">Smtp</span></span></tt> instance.
    461. 

  461.     
    462. 

  462.   </dd>
    463. 

  463. </div>
    464. 

  464. 

  465. </div>
    466. 

  466. <div id="sendMail-procs-all">
    467. 

  467.   <div id="sendMail,AsyncSmtp,string,seq[string],string">
    468. 

  468.   <dt><pre><span class="Keyword">proc</span> <a href="#sendMail%2CAsyncSmtp%2Cstring%2Cseq%5Bstring%5D%2Cstring"><span class="Identifier">sendMail</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#AsyncSmtp"><span class="Identifier">AsyncSmtp</span></a><span class="Other">;</span> <span class="Identifier">fromAddr</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">toAddrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">;</span>
    469. 

  469.               <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
    470. 

  470.     <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    471. 

  471.   <dd>
    472. 

  472.     
    473. 

  473.     <p>Sends <tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt> from <tt class="docutils literal"><span class="pre"><span class="Identifier">fromAddr</span></span></tt> to the addresses specified in <tt class="docutils literal"><span class="pre"><span class="Identifier">toAddrs</span></span></tt>. Messages may be formed using <tt class="docutils literal"><span class="pre"><span class="Identifier">createMessage</span></span></tt> by converting the Message into a string.</p>
    474. 

  474. <p>You need to make sure that <tt class="docutils literal"><span class="pre"><span class="Identifier">fromAddr</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">toAddrs</span></span></tt> don't contain any newline characters. Failing to do so will raise <tt class="docutils literal"><span class="pre"><span class="Identifier">AssertionDefect</span></span></tt>.</p>
    475. 

  475. 

  476.     
    477. 

  477.   </dd>
    478. 

  478. </div>
    479. 

  479. <div id="sendMail,Smtp,string,seq[string],string">
    480. 

  480.   <dt><pre><span class="Keyword">proc</span> <a href="#sendMail%2CSmtp%2Cstring%2Cseq%5Bstring%5D%2Cstring"><span class="Identifier">sendMail</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#Smtp"><span class="Identifier">Smtp</span></a><span class="Other">;</span> <span class="Identifier">fromAddr</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">toAddrs</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">msg</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span> {.
    481. 

  481.     <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">TimeoutError</span><span class="Other">,</span> <span class="Identifier">ReplyError</span><span class="Other">]</span><span class="Other">,</span>
    482. 

  482.     <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    483. 

  483.   <dd>
    484. 

  484.     
    485. 

  485.     
    486. 

  486.     
    487. 

  487.   </dd>
    488. 

  488. </div>
    489. 

  489. 

  490. </div>
    491. 

  491. <div id="startTls-procs-all">
    492. 

  492.   <div id="startTls,AsyncSmtp,SslContext">
    493. 

  493.   <dt><pre><span class="Keyword">proc</span> <a href="#startTls%2CAsyncSmtp%2CSslContext"><span class="Identifier">startTls</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#AsyncSmtp"><span class="Identifier">AsyncSmtp</span></a><span class="Other">;</span> <span class="Identifier">sslContext</span><span class="Other">:</span> <span class="Identifier">SslContext</span> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span>
    494. 

  494.     <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">SslError</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">,</span>
    495. 

  495.     <span class="Identifier">LibraryError</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">ReadDirEffect</span><span class="Other">,</span> <span class="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span>
    496. 

  496.                     <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    497. 

  497.   <dd>
    498. 

  498.     
    499. 

  499.     Put the SMTP connection in TLS (Transport Layer Security) mode. May fail with ReplyError
    500. 

  500.     
    501. 

  501.   </dd>
    502. 

  502. </div>
    503. 

  503. <div id="startTls,Smtp,SslContext">
    504. 

  504.   <dt><pre><span class="Keyword">proc</span> <a href="#startTls%2CSmtp%2CSslContext"><span class="Identifier">startTls</span></a><span class="Other">(</span><span class="Identifier">smtp</span><span class="Other">:</span> <a href="smtp.html#Smtp"><span class="Identifier">Smtp</span></a><span class="Other">;</span> <span class="Identifier">sslContext</span><span class="Other">:</span> <span class="Identifier">SslContext</span> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">SslError</span><span class="Other">,</span>
    505. 

  505.     <span class="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">TimeoutError</span><span class="Other">,</span> <span class="Identifier">ReplyError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">LibraryError</span><span class="Other">,</span> <span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span>
    506. 

  506.     <span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">ReadDirEffect</span><span class="Other">,</span>
    507. 

  507.     <span class="Identifier">ReadEnvEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
    508. 

  508.   <dd>
    509. 

  509.     
    510. 

  510.     
    511. 

  511.     
    512. 

  512.   </dd>
    513. 

  513. </div>
    514. 

  514. 

  515. </div>
    516. 

  516. 

  517.   </dl>
    518. 

  518. </div>
    519. 

  519. 

  520.   </div>
    521. 

  521. </div>
    522. 

  522. 

  523.       <div class="twelve-columns footer">
    524. 

  524.         <span class="nim-sprite"></span>
    525. 

  525.         <br>
    526. 

  526.         <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-03 14:57:38 UTC</small>
    527. 

  527.       </div>
    528. 

  528.     </div>
    529. 

  529.   </div>
    530. 

  530.       <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    531. 

  531.     
    532. 

  532. </body>
    533. 

  533. </html>
    534. 

  534.