mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2025-12-28 17:04:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Nim/smtp.html
github-actions[bot] ef3d9e7b38 Deploy to GitHub pages
2025-12-28 15:55:52 +00:00

657 lines
79 KiB
HTML
Raw Permalink Blame History

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>src/smtp</title>
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- Favicon -->
<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=="/>
<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=">
<!-- CSS -->
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
<!-- JS -->
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
</head>
<body>
<div class="document" id="documentId">
<div class="container">
<h1 class="title">src/smtp</h1>
<div class="row">
<div class="three columns">
<div class="theme-select-wrapper">
<label for="theme-select">Theme:&nbsp;</label>
<select id="theme-select" onchange="setTheme(this.value)">
<option value="auto">🌗 Match OS</option>
<option value="dark">🌑 Dark</option>
<option value="light">🌕 Light</option>
</select>
</div>
<div id="global-links">
<ul class="simple-boot">
<li><a href="manual.html">Manual</a></li>
<li><a href="lib.html">Standard library</a></li>
<li> <a id="indexLink" href="theindex.html">Index</a></li>
<li><a href="compiler/theindex.html">Compiler docs</a></li>
<li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
<li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="search" id="searchInput"
oninput="search()" />
</div>
<ul class="simple simple-toc" id="toc-list">
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#AsyncSmtp" title="AsyncSmtp = SmtpBase[AsyncSocket]">AsyncSmtp</a></li>
<li><a class="reference" href="#Email" title="Email = object
address*: string">Email</a></li>
<li><a class="reference" href="#Message" title="Message = object">Message</a></li>
<li><a class="reference" href="#ReplyError" title="ReplyError = object of IOError">ReplyError</a></li>
<li><a class="reference" href="#Smtp" title="Smtp = SmtpBase[Socket]">Smtp</a></li>
</ul>
</details>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">$
<li><a class="reference" href="#%24%2CEmail" title="`$`(email: Email): string">`$`(email: Email): string</a></li>
<li><a class="reference" href="#%24%2CMessage" title="`$`(msg: Message): string">`$`(msg: Message): string</a></li>
</ul>
<ul class="simple nested-toc-section">auth
<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>
<li><a class="reference" href="#auth%2CSmtp%2Cstring%2Cstring" title="auth(smtp: Smtp; username, password: string)">auth(smtp: Smtp; username, password: string)</a></li>
</ul>
<ul class="simple nested-toc-section">checkReply
<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>
<li><a class="reference" href="#checkReply%2CSmtp%2Cstring" title="checkReply(smtp: Smtp; reply: string)">checkReply(smtp: Smtp; reply: string)</a></li>
</ul>
<ul class="simple nested-toc-section">close
<li><a class="reference" href="#close%2CAsyncSmtp" title="close(smtp: AsyncSmtp): owned(Future[void])">close(smtp: AsyncSmtp): owned(Future[void])</a></li>
<li><a class="reference" href="#close%2CSmtp" title="close(smtp: Smtp)">close(smtp: Smtp)</a></li>
</ul>
<ul class="simple nested-toc-section">connect
<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>
<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>
</ul>
<ul class="simple nested-toc-section">createEmail
<li><a class="reference" href="#createEmail%2Cstring%2Cstring" title="createEmail(address: string; name: string = &quot;&quot;): Email">createEmail(address: string; name: string = &quot;&quot;): Email</a></li>
</ul>
<ul class="simple nested-toc-section">createMessage
<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>
<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];
otherHeaders: openArray[tuple[name, value: string]]): Message">createMessage(mSubject, mBody: string; mTo, mCc: seq[string];
otherHeaders: openArray[tuple[name, value: string]]): Message</a></li>
<li><a class="reference" href="#createMessage%2Cstring%2Cstring%2CT%2Cseq%5BT%5D%2Cseq%5BT%5D%2Cseq%5BT%5D%2Cseq%5BT%5D%2CopenArray%5Btuple%5Bstring%2Cstring%5D%5D" title="createMessage[T: Email | string](mSubject, mBody: string; sender: T;
mTo: seq[T] = @[]; mCc: seq[T] = @[];
mBcc: seq[T] = @[]; mReplyTo: seq[T] = @[];
otherHeaders: openArray[tuple[name, value: string]] = @[]): Message">createMessage[T: Email | string](mSubject, mBody: string; sender: T;
mTo: seq[T] = @[]; mCc: seq[T] = @[];
mBcc: seq[T] = @[]; mReplyTo: seq[T] = @[];
otherHeaders: openArray[tuple[name, value: string]] = @[]): Message</a></li>
</ul>
<ul class="simple nested-toc-section">debugRecv
<li><a class="reference" href="#debugRecv%2CAsyncSmtp" title="debugRecv(smtp: AsyncSmtp): Future[string]">debugRecv(smtp: AsyncSmtp): Future[string]</a></li>
<li><a class="reference" href="#debugRecv%2CSmtp" title="debugRecv(smtp: Smtp): string">debugRecv(smtp: Smtp): string</a></li>
</ul>
<ul class="simple nested-toc-section">debugSend
<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>
<li><a class="reference" href="#debugSend%2CSmtp%2Cstring" title="debugSend(smtp: Smtp; cmd: string)">debugSend(smtp: Smtp; cmd: string)</a></li>
</ul>
<ul class="simple nested-toc-section">ehlo
<li><a class="reference" href="#ehlo%2CAsyncSmtp" title="ehlo(smtp: AsyncSmtp): Future[bool]">ehlo(smtp: AsyncSmtp): Future[bool]</a></li>
<li><a class="reference" href="#ehlo%2CSmtp" title="ehlo(smtp: Smtp): bool">ehlo(smtp: Smtp): bool</a></li>
</ul>
<ul class="simple nested-toc-section">helo
<li><a class="reference" href="#helo%2CAsyncSmtp" title="helo(smtp: AsyncSmtp): owned(Future[void])">helo(smtp: AsyncSmtp): owned(Future[void])</a></li>
<li><a class="reference" href="#helo%2CSmtp" title="helo(smtp: Smtp)">helo(smtp: Smtp)</a></li>
</ul>
<ul class="simple nested-toc-section">newAsyncSmtp
<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>
</ul>
<ul class="simple nested-toc-section">newSmtp
<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>
</ul>
<ul class="simple nested-toc-section">recipients
<li><a class="reference" href="#recipients%2CMessage" title="recipients(msg: Message): seq[Email]">recipients(msg: Message): seq[Email]</a></li>
</ul>
<ul class="simple nested-toc-section">sender
<li><a class="reference" href="#sender%2CMessage" title="sender(msg: Message): Email">sender(msg: Message): Email</a></li>
</ul>
<ul class="simple nested-toc-section">sendMail
<li><a class="reference" href="#sendMail%2CAsyncSmtp%2Cstring%2Cseq%5Bstring%5D%2Cstring" title="sendMail(smtp: AsyncSmtp; fromAddr: string; toAddrs: seq[string]; msg: string): owned(
Future[void])">sendMail(smtp: AsyncSmtp; fromAddr: string; toAddrs: seq[string]; msg: string): owned(
Future[void])</a></li>
<li><a class="reference" href="#sendMail%2CAsyncSmtp%2CMessage" title="sendMail(smtp: AsyncSmtp; msg: Message): owned(Future[void])">sendMail(smtp: AsyncSmtp; msg: Message): owned(Future[void])</a></li>
<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>
<li><a class="reference" href="#sendMail%2CSmtp%2CMessage" title="sendMail(smtp: Smtp; msg: Message)">sendMail(smtp: Smtp; msg: Message)</a></li>
</ul>
<ul class="simple nested-toc-section">startTls
<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>
<li><a class="reference" href="#startTls%2CSmtp%2CSslContext" title="startTls(smtp: Smtp; sslContext: SslContext = nil)">startTls(smtp: Smtp; sslContext: SslContext = nil)</a></li>
</ul>
</ul>
</details>
</li>
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
<p class="module-desc"><div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
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>
<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>
<p>This module also implements the protocol used to format messages, as specified by RFC 2822.</p>
<p>Example gmail use:</p>
<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>
<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>
<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="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>
<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>
<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>
<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>
<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>
<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>
<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="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>
<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>
<span class="Identifier">smtpConn</span><span class="Operator">.</span><span class="Identifier">startTls</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<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>
<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>
</p>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="AsyncSmtp">
<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>
<dd>
</dd>
</div>
<div id="Email">
<dt><pre><a href="smtp.html#Email"><span class="Identifier">Email</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">address</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span></pre></dt>
<dd>
</dd>
</div>
<div id="Message">
<dt><pre><a href="smtp.html#Message"><span class="Identifier">Message</span></a> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
<dd>
</dd>
</div>
<div id="ReplyError">
<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>
<dd>
</dd>
</div>
<div id="Smtp">
<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>
<dd>
</dd>
</div>
</dl>
</div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="$-procs-all">
<div id="$,Email">
<dt><pre><span class="Keyword">proc</span> <a href="#%24%2CEmail"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">email</span><span class="Other">:</span> <a href="smtp.html#Email"><span class="Identifier">Email</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>
<dd>
stringify for <tt class="docutils literal"><span class="pre"><span class="Identifier">Email</span></span></tt>.
</dd>
</div>
<div id="$,Message">
<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>
<dd>
stringify for <tt class="docutils literal"><span class="pre"><span class="Identifier">Message</span></span></tt>.
</dd>
</div>
</div>
<div id="auth-procs-all">
<div id="auth,AsyncSmtp,string,string">
<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> {.
<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>
<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>
<dd>
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.
</dd>
</div>
<div id="auth,Smtp,string,string">
<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> {.
<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>
<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>
<dd>
</dd>
</div>
</div>
<div id="checkReply-procs-all">
<div id="checkReply,AsyncSmtp,string">
<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> {.
<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>
<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>
<dd>
<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>
<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>
</dd>
</div>
<div id="checkReply,Smtp,string">
<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> {.
<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>
<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>
<dd>
</dd>
</div>
</div>
<div id="close-procs-all">
<div id="close,AsyncSmtp">
<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>
<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>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Disconnects from the SMTP server and closes the socket.
</dd>
</div>
<div id="close,Smtp">
<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>
<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>
<dd>
</dd>
</div>
</div>
<div id="connect-procs-all">
<div id="connect,AsyncSmtp,string,Port">
<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>
<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>
<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>
<dd>
Establishes a connection with a SMTP server. May fail with ReplyError or with a socket error.
</dd>
</div>
<div id="connect,Smtp,string,Port">
<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> {.
<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>
<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>
<dd>
</dd>
</div>
</div>
<div id="createEmail-procs-all">
<div id="createEmail,string,string">
<dt><pre><span class="Keyword">proc</span> <a href="#createEmail%2Cstring%2Cstring"><span class="Identifier">createEmail</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">name</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <a href="smtp.html#Email"><span class="Identifier">Email</span></a> {.<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>
<dd>
<p>Creates a new email address</p>
<p>You need to make sure that <tt class="docutils literal"><span class="pre"><span class="Identifier">address</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">name</span></span></tt> (if specified) do not 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>
</dd>
</div>
</div>
<div id="createMessage-procs-all">
<div id="createMessage,string,string,seq[string],seq[string]">
<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> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">&quot;use `createMessage` overloads with a `sender`&quot;</span><span class="Other">,</span> <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>
<dd>
<div class="deprecation-message">
<b>Deprecated:</b> use `createMessage` overloads with a `sender`
</div>
<p>Alternate version of the above.</p>
<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>
</dd>
</div>
<div id="createMessage,string,string,seq[string],seq[string],openArray[tuple[string,string]]">
<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>
<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> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">&quot;use `createMessage` overloads with a `sender`&quot;</span><span class="Other">,</span> <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>
<dd>
<div class="deprecation-message">
<b>Deprecated:</b> use `createMessage` overloads with a `sender`
</div>
<p>Creates a new MIME compliant message.</p>
<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>
</dd>
</div>
<div id="createMessage,string,string,T,seq[T],seq[T],seq[T],seq[T],openArray[tuple[string,string]]">
<dt><pre><span class="Keyword">proc</span> <a href="#createMessage%2Cstring%2Cstring%2CT%2Cseq%5BT%5D%2Cseq%5BT%5D%2Cseq%5BT%5D%2Cseq%5BT%5D%2CopenArray%5Btuple%5Bstring%2Cstring%5D%5D"><span class="Identifier">createMessage</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="smtp.html#Email"><span class="Identifier">Email</span></a> <span class="Operator">|</span> <span class="Identifier">string</span><span class="Other">]</span><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">sender</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span>
<span class="Identifier">mTo</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">T</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="Identifier">mCc</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">T</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="Identifier">mBcc</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">T</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="Identifier">mReplyTo</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">T</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="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="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></pre></dt>
<dd>
<p>Creates a new MIME compliant message.</p>
<p>You need to make sure that <tt class="docutils literal"><span class="pre"><span class="Identifier">mSubject</span></span></tt> does not 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>
</dd>
</div>
</div>
<div id="debugRecv-procs-all">
<div id="debugRecv,AsyncSmtp">
<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>
<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>
<dd>
<p>Receives a line of data from the socket connected to the SMTP server.</p>
<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>
<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>
<p>See <a class="reference external" href="#checkReply,AsyncSmtp,string">checkReply(reply)</a>.</p>
</dd>
</div>
<div id="debugRecv,Smtp">
<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>
<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>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
</dd>
</div>
</div>
<div id="debugSend-procs-all">
<div id="debugSend,AsyncSmtp,string">
<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> {.
<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>
<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>
<dd>
<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>
<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>
<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>
</dd>
</div>
<div id="debugSend,Smtp,string">
<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>
<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>
<dd>
</dd>
</div>
</div>
<div id="ehlo-procs-all">
<div id="ehlo,AsyncSmtp">
<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>
<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>
<dd>
Sends EHLO request.
</dd>
</div>
<div id="ehlo,Smtp">
<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>
<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>
<dd>
</dd>
</div>
</div>
<div id="helo-procs-all">
<div id="helo,AsyncSmtp">
<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>
<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>
<dd>
</dd>
</div>
<div id="helo,Smtp">
<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>
<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>
<dd>
</dd>
</div>
</div>
<div id="newAsyncSmtp-procs-all">
<div id="newAsyncSmtp,SslContext">
<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> {.
<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>
<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>
<dd>
Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">AsyncSmtp</span></span></tt> instance.
</dd>
</div>
</div>
<div id="newSmtp-procs-all">
<div id="newSmtp,SslContext">
<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> {.
<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>
<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>
<dd>
Creates a new <tt class="docutils literal"><span class="pre"><span class="Identifier">Smtp</span></span></tt> instance.
</dd>
</div>
</div>
<div id="recipients-procs-all">
<div id="recipients,Message">
<dt><pre><span class="Keyword">proc</span> <a href="#recipients%2CMessage"><span class="Identifier">recipients</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">seq</span><span class="Other">[</span><a href="smtp.html#Email"><span class="Identifier">Email</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="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>
<dd>
Retrieves all recipients of the message, which are all recipients defined for to, cc and bcc
</dd>
</div>
</div>
<div id="sender-procs-all">
<div id="sender,Message">
<dt><pre><span class="Keyword">proc</span> <a href="#sender%2CMessage"><span class="Identifier">sender</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> <a href="smtp.html#Email"><span class="Identifier">Email</span></a> {.<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>
<dd>
</dd>
</div>
</div>
<div id="sendMail-procs-all">
<div id="sendMail,AsyncSmtp,string,seq[string],string">
<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>
<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>
<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>
<dd>
<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>
<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>
</dd>
</div>
<div id="sendMail,AsyncSmtp,Message">
<dt><pre><span class="Keyword">proc</span> <a href="#sendMail%2CAsyncSmtp%2CMessage"><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">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">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> <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>
<dd>
<p>Convenience utility for sending messages. Sends <tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt> from the sender as specified in <a class="reference external" href="#sender,Message">sender</a> and the recipients as specified in <a class="reference external" href="#recipients,Message">recipients</a>.</p>
<p>See also:</p>
<ul class="simple"><li><a class="reference external" href="#sendMail,Smtp,string,seq[string],string">sendMail</a></li>
</ul>
</dd>
</div>
<div id="sendMail,Smtp,string,seq[string],string">
<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> {.
<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>
<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>
<dd>
</dd>
</div>
<div id="sendMail,Smtp,Message">
<dt><pre><span class="Keyword">proc</span> <a href="#sendMail%2CSmtp%2CMessage"><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">msg</span><span class="Other">:</span> <a href="smtp.html#Message"><span class="Identifier">Message</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>
<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>
<dd>
</dd>
</div>
</div>
<div id="startTls-procs-all">
<div id="startTls,AsyncSmtp,SslContext">
<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>
<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>
<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>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Put the SMTP connection in TLS (Transport Layer Security) mode. May fail with ReplyError
</dd>
</div>
<div id="startTls,Smtp,SslContext">
<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>
<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>
<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>
<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>
<dd>
</dd>
</div>
</div>
</dl>
</div>
</div>
</div>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2025-12-28 15:55:37 UTC</small>
</div>
</div>
</div>
<script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink