mirror of
https://github.com/nim-lang/Nim.git
synced 2026-04-18 21:40:32 +00:00
remove smtp
This commit is contained in:
narimiran
@@ -238,9 +238,6 @@ Internet Protocols and Support
|
||||
This module implements a simple HTTP client which supports both synchronous
|
||||
and asynchronous retrieval of web pages.
|
||||
|
||||
* `smtp <smtp.html>`_
|
||||
This module implement a simple SMTP client.
|
||||
|
||||
* `cookies <cookies.html>`_
|
||||
This module contains helper procs for parsing and generating cookies.
|
||||
|
||||
|
||||
@@ -1,253 +0,0 @@
|
||||
#
|
||||
#
|
||||
# Nim's Runtime Library
|
||||
# (c) Copyright 2012 Dominik Picheta
|
||||
#
|
||||
# See the file "copying.txt", included in this
|
||||
# distribution, for details about the copyright.
|
||||
#
|
||||
|
||||
## This module implements the SMTP client protocol as specified by RFC 5321,
|
||||
## this can be used to send mail to any SMTP Server.
|
||||
##
|
||||
## This module also implements the protocol used to format messages,
|
||||
## as specified by RFC 2822.
|
||||
##
|
||||
## Example gmail use:
|
||||
##
|
||||
##
|
||||
## .. code-block:: Nim
|
||||
## var msg = createMessage("Hello from Nim's SMTP",
|
||||
## "Hello!.\n Is this awesome or what?",
|
||||
## @["foo@gmail.com"])
|
||||
## let smtpConn = newSmtp(useSsl = true, debug=true)
|
||||
## smtpConn.connect("smtp.gmail.com", Port 465)
|
||||
## smtpConn.auth("username", "password")
|
||||
## smtpConn.sendmail("username@gmail.com", @["foo@gmail.com"], $msg)
|
||||
##
|
||||
##
|
||||
## For SSL support this module relies on OpenSSL. If you want to
|
||||
## enable SSL, compile with ``-d:ssl``.
|
||||
|
||||
import net, strutils, strtabs, base64, os
|
||||
import asyncnet, asyncdispatch
|
||||
|
||||
export Port
|
||||
|
||||
type
|
||||
Message* = object
|
||||
msgTo: seq[string]
|
||||
msgCc: seq[string]
|
||||
msgSubject: string
|
||||
msgOtherHeaders: StringTableRef
|
||||
msgBody: string
|
||||
|
||||
ReplyError* = object of IOError
|
||||
|
||||
SmtpBase[SocketType] = ref object
|
||||
sock: SocketType
|
||||
debug: bool
|
||||
|
||||
Smtp* = SmtpBase[Socket]
|
||||
AsyncSmtp* = SmtpBase[AsyncSocket]
|
||||
|
||||
proc debugSend(smtp: Smtp | AsyncSmtp, cmd: string) {.multisync.} =
|
||||
if smtp.debug:
|
||||
echo("C:" & cmd)
|
||||
await smtp.sock.send(cmd)
|
||||
|
||||
proc debugRecv(smtp: Smtp | AsyncSmtp): Future[TaintedString] {.multisync.} =
|
||||
result = await smtp.sock.recvLine()
|
||||
if smtp.debug:
|
||||
echo("S:" & result.string)
|
||||
|
||||
proc quitExcpt(smtp: Smtp, msg: string) =
|
||||
smtp.debugSend("QUIT")
|
||||
raise newException(ReplyError, msg)
|
||||
|
||||
const compiledWithSsl = defined(ssl)
|
||||
|
||||
when not defined(ssl):
|
||||
type PSSLContext = ref object
|
||||
let defaultSSLContext: PSSLContext = nil
|
||||
else:
|
||||
var defaultSSLContext {.threadvar.}: SSLContext
|
||||
|
||||
proc getSSLContext(): SSLContext =
|
||||
if defaultSSLContext == nil:
|
||||
defaultSSLContext = newContext(verifyMode = CVerifyNone)
|
||||
result = defaultSSLContext
|
||||
|
||||
proc createMessage*(mSubject, mBody: string, mTo, mCc: seq[string],
|
||||
otherHeaders: openarray[tuple[name, value: string]]): Message =
|
||||
## Creates a new MIME compliant message.
|
||||
result.msgTo = mTo
|
||||
result.msgCc = mCc
|
||||
result.msgSubject = mSubject
|
||||
result.msgBody = mBody
|
||||
result.msgOtherHeaders = newStringTable()
|
||||
for n, v in items(otherHeaders):
|
||||
result.msgOtherHeaders[n] = v
|
||||
|
||||
proc createMessage*(mSubject, mBody: string, mTo,
|
||||
mCc: seq[string] = @[]): Message =
|
||||
## Alternate version of the above.
|
||||
result.msgTo = mTo
|
||||
result.msgCc = mCc
|
||||
result.msgSubject = mSubject
|
||||
result.msgBody = mBody
|
||||
result.msgOtherHeaders = newStringTable()
|
||||
|
||||
proc `$`*(msg: Message): string =
|
||||
## stringify for ``Message``.
|
||||
result = ""
|
||||
if msg.msgTo.len() > 0:
|
||||
result = "TO: " & msg.msgTo.join(", ") & "\c\L"
|
||||
if msg.msgCc.len() > 0:
|
||||
result.add("CC: " & msg.msgCc.join(", ") & "\c\L")
|
||||
# TODO: Folding? i.e when a line is too long, shorten it...
|
||||
result.add("Subject: " & msg.msgSubject & "\c\L")
|
||||
for key, value in pairs(msg.msgOtherHeaders):
|
||||
result.add(key & ": " & value & "\c\L")
|
||||
|
||||
result.add("\c\L")
|
||||
result.add(msg.msgBody)
|
||||
|
||||
proc newSmtp*(useSsl = false, debug=false,
|
||||
sslContext: SSLContext = nil): Smtp =
|
||||
## Creates a new ``Smtp`` instance.
|
||||
new result
|
||||
result.debug = debug
|
||||
result.sock = newSocket()
|
||||
if useSsl:
|
||||
when compiledWithSsl:
|
||||
if sslContext == nil:
|
||||
getSSLContext().wrapSocket(result.sock)
|
||||
else:
|
||||
sslContext.wrapSocket(result.sock)
|
||||
else:
|
||||
{.error: "SMTP module compiled without SSL support".}
|
||||
|
||||
proc newAsyncSmtp*(useSsl = false, debug=false,
|
||||
sslContext: SSLContext = nil): AsyncSmtp =
|
||||
## Creates a new ``AsyncSmtp`` instance.
|
||||
new result
|
||||
result.debug = debug
|
||||
|
||||
result.sock = newAsyncSocket()
|
||||
if useSsl:
|
||||
when compiledWithSsl:
|
||||
if sslContext == nil:
|
||||
getSSLContext().wrapSocket(result.sock)
|
||||
else:
|
||||
sslContext.wrapSocket(result.sock)
|
||||
else:
|
||||
{.error: "SMTP module compiled without SSL support".}
|
||||
|
||||
proc quitExcpt(smtp: AsyncSmtp, msg: string): Future[void] =
|
||||
var retFuture = newFuture[void]()
|
||||
var sendFut = smtp.debugSend("QUIT")
|
||||
sendFut.callback =
|
||||
proc () =
|
||||
# TODO: Fix this in async procs.
|
||||
raise newException(ReplyError, msg)
|
||||
return retFuture
|
||||
|
||||
proc checkReply(smtp: Smtp | AsyncSmtp, reply: string) {.multisync.} =
|
||||
var line = await smtp.debugRecv()
|
||||
if not line.startswith(reply):
|
||||
await quitExcpt(smtp, "Expected " & reply & " reply, got: " & line)
|
||||
|
||||
proc connect*(smtp: Smtp | AsyncSmtp,
|
||||
address: string, port: Port) {.multisync.} =
|
||||
## Establishes a connection with a SMTP server.
|
||||
## May fail with ReplyError or with a socket error.
|
||||
await smtp.sock.connect(address, port)
|
||||
|
||||
await smtp.checkReply("220")
|
||||
await smtp.debugSend("HELO " & address & "\c\L")
|
||||
await smtp.checkReply("250")
|
||||
|
||||
proc auth*(smtp: Smtp | AsyncSmtp, username, password: string) {.multisync.} =
|
||||
## Sends an AUTH command to the server to login as the `username`
|
||||
## using `password`.
|
||||
## May fail with ReplyError.
|
||||
|
||||
await smtp.debugSend("AUTH LOGIN\c\L")
|
||||
await smtp.checkReply("334") # TODO: Check whether it's asking for the "Username:"
|
||||
# i.e "334 VXNlcm5hbWU6"
|
||||
await smtp.debugSend(encode(username) & "\c\L")
|
||||
await smtp.checkReply("334") # TODO: Same as above, only "Password:" (I think?)
|
||||
|
||||
await smtp.debugSend(encode(password) & "\c\L")
|
||||
await smtp.checkReply("235") # Check whether the authentification was successful.
|
||||
|
||||
proc sendMail*(smtp: Smtp | AsyncSmtp, fromAddr: string,
|
||||
toAddrs: seq[string], msg: string) {.multisync.} =
|
||||
## Sends ``msg`` from ``fromAddr`` to the addresses specified in ``toAddrs``.
|
||||
## Messages may be formed using ``createMessage`` by converting the
|
||||
## Message into a string.
|
||||
|
||||
await smtp.debugSend("MAIL FROM:<" & fromAddr & ">\c\L")
|
||||
await smtp.checkReply("250")
|
||||
for address in items(toAddrs):
|
||||
await smtp.debugSend("RCPT TO:<" & address & ">\c\L")
|
||||
await smtp.checkReply("250")
|
||||
|
||||
# Send the message
|
||||
await smtp.debugSend("DATA " & "\c\L")
|
||||
await smtp.checkReply("354")
|
||||
await smtp.sock.send(msg & "\c\L")
|
||||
await smtp.debugSend(".\c\L")
|
||||
await smtp.checkReply("250")
|
||||
|
||||
proc close*(smtp: Smtp | AsyncSmtp) {.multisync.} =
|
||||
## Disconnects from the SMTP server and closes the socket.
|
||||
await smtp.debugSend("QUIT\c\L")
|
||||
smtp.sock.close()
|
||||
|
||||
when not defined(testing) and isMainModule:
|
||||
# To test with a real SMTP service, create a smtp.ini file, e.g.:
|
||||
# username = ""
|
||||
# password = ""
|
||||
# smtphost = "smtp.gmail.com"
|
||||
# port = 465
|
||||
# use_tls = true
|
||||
# sender = ""
|
||||
# recipient = ""
|
||||
|
||||
import parsecfg
|
||||
|
||||
proc `[]`(c: Config, key: string): string = c.getSectionValue("", key)
|
||||
|
||||
let
|
||||
conf = loadConfig("smtp.ini")
|
||||
msg = createMessage("Hello from Nim's SMTP!",
|
||||
"Hello!\n Is this awesome or what?", @[conf["recipient"]])
|
||||
|
||||
assert conf["smtphost"] != ""
|
||||
|
||||
proc async_test() {.async.} =
|
||||
let client = newAsyncSmtp(
|
||||
conf["use_tls"].parseBool,
|
||||
debug=true
|
||||
)
|
||||
await client.connect(conf["smtphost"], conf["port"].parseInt.Port)
|
||||
await client.auth(conf["username"], conf["password"])
|
||||
await client.sendMail(conf["sender"], @[conf["recipient"]], $msg)
|
||||
await client.close()
|
||||
echo "async email sent"
|
||||
|
||||
proc sync_test() =
|
||||
var smtpConn = newSmtp(
|
||||
conf["use_tls"].parseBool,
|
||||
debug=true
|
||||
)
|
||||
smtpConn.connect(conf["smtphost"], conf["port"].parseInt.Port)
|
||||
smtpConn.auth(conf["username"], conf["password"])
|
||||
smtpConn.sendMail(conf["sender"], @[conf["recipient"]], $msg)
|
||||
smtpConn.close()
|
||||
echo "sync email sent"
|
||||
|
||||
waitFor async_test()
|
||||
sync_test()
|
||||
@@ -1 +0,0 @@
|
||||
-d:ssl
|
||||
@@ -167,7 +167,6 @@ lib/impure/db_sqlite.nim
|
||||
lib/impure/db_odbc.nim
|
||||
lib/pure/db_common.nim
|
||||
lib/pure/httpclient.nim
|
||||
lib/pure/smtp.nim
|
||||
lib/pure/ropes.nim
|
||||
lib/pure/unidecode/unidecode.nim
|
||||
lib/pure/xmlparser.nim
|
||||
|
||||
Reference in New Issue
Block a user