Network.HaskellNet.SMTP

This module provides functions for working with the SMTP protocol in the client side, including opening and closing connections, sending commands to the server, authenticate and sending mails.

Here's a basic usage example:

import Network.HaskellNet.SMTP
import Network.HaskellNet.Auth
import qualified Data.Text.Lazy as T

main = doSMTP "your.smtp.server.com" $ \conn ->
   authSucceed <- authenticate PLAIN "username" "password" conn
   if authSucceed
       then sendPlainTextMail "[e-mail]" "[e-mail]" "subject" (T.pack "Hello! This is the mail body!") conn
       else print "Authentication failed."

Notes for the above example:

• First the SMTPConnection is opened with the doSMTP function. The connection should also be established with functions such as connectSMTP, connectSMTPPort and doSMTPPort. With the doSMTP* functions the connection is opened, then executed an action with it and then closed automatically. If the connection is opened with the connectSMTP* functions you may want to close it with the closeSMTP function after using it. It is also possible to create a SMTPConnection from an already opened connection stream (BSStream) using the connectStream or doSMTPStream functions.

NOTE: For SSL/TLS support you may establish the connection using the functions (such as connectSMTPSSL) provided in the Network.HaskellNet.SMTP.SSL module of the HaskellNet-SSL package.

• The authenticate function authenticates to the server with the specified AuthType. PLAIN, LOGIN and CRAM_MD5 AuthTypes are available. It returns a Bool indicating either the authentication succeed or not.
• To send a mail you can use sendPlainTextMail for plain text mail, or sendMimeMail for mime mail.

Types

data Command

Constructors

HELO String

EHLO String

MAIL String

RCPT String

DATA ByteString

EXPN String

VRFY String

HELP String

AUTH AuthType UserName Password

NOOP

RSET

QUIT

Instances

Eq Command

Defined in Network.HaskellNet.SMTP

Methods

(==) :: Command -> Command -> Bool

(/=) :: Command -> Command -> Bool

Show Command

Defined in Network.HaskellNet.SMTP

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS

data Response

Constructors

Ok

SystemStatus

HelpMessage

ServiceReady

ServiceClosing

UserNotLocal

CannotVerify

StartMailInput

ServiceNotAvailable

MailboxUnavailable

ErrorInProcessing

InsufficientSystemStorage

SyntaxError

ParameterError

CommandNotImplemented

BadSequence

ParameterNotImplemented

MailboxUnavailableError

UserNotLocalError

ExceededStorage

MailboxNotAllowed

TransactionFailed

Instances

Eq Response

Defined in Network.HaskellNet.SMTP

Methods

(==) :: Response -> Response -> Bool

(/=) :: Response -> Response -> Bool

Show Response

Defined in Network.HaskellNet.SMTP

Methods

showsPrec :: Int -> Response -> ShowS

show :: Response -> String

showList :: [Response] -> ShowS

data AuthType

Constructors

PLAIN

LOGIN

CRAM_MD5

Instances

Eq AuthType

Defined in Network.HaskellNet.Auth

Methods

(==) :: AuthType -> AuthType -> Bool

(/=) :: AuthType -> AuthType -> Bool

Show AuthType

Defined in Network.HaskellNet.Auth

Methods

showsPrec :: Int -> AuthType -> ShowS

show :: AuthType -> String

showList :: [AuthType] -> ShowS

data SMTPConnection

Establishing Connection

connectSMTPPort

Arguments

:: String

name of the server

-> PortNumber

port number

-> IO SMTPConnection

connecting SMTP server with the specified name and port number.

connectSMTP

Arguments

:: String

name of the server

-> IO SMTPConnection

connecting SMTP server with the specified name and port 25.

connectStream :: BSStream -> IO SMTPConnection

create SMTPConnection from already connected Stream

Operation to a Connection

sendCommand :: SMTPConnection -> Command -> IO (ReplyCode, ByteString)

send a method to a server

closeSMTP :: SMTPConnection -> IO ()

close the connection. This function send the QUIT method, so you do not have to QUIT method explicitly.

Other Useful Operations

authenticate :: AuthType -> UserName -> Password -> SMTPConnection -> IO Bool

This function will return True if the authentication succeeds. Here's an example of sending a mail with a server that requires authentication:

   authSucceed <- authenticate PLAIN "username" "password" conn
   if authSucceed
       then sendPlainTextMail "[e-mail]" "[e-mail]" "subject" (T.pack "Hello!") conn
       else print "Authentication failed."

sendMail

Arguments

:: String

sender mail

-> [String]

receivers

-> ByteString

data

-> SMTPConnection

-> IO ()

sending a mail to a server. This is achieved by sendMessage. If something is wrong, it raises an IOexception.

doSMTPPort :: String -> PortNumber -> (SMTPConnection -> IO a) -> IO a

doSMTPPort open a connection, and do an IO action with the connection, and then close it.

doSMTP :: String -> (SMTPConnection -> IO a) -> IO a

doSMTP is similar to doSMTPPort, except that it does not require port number but connects to the server with port 25.

doSMTPStream :: BSStream -> (SMTPConnection -> IO a) -> IO a

doSMTPStream is similar to doSMTPPort, except that its argument is a Stream data instead of hostname and port number.

sendPlainTextMail

Arguments

:: String

receiver

-> String

sender

-> String

subject

-> Text

body

-> SMTPConnection

the connection

-> IO ()

Send a plain text mail.

sendMimeMail

Arguments

:: String

receiver

-> String

sender

-> String

subject

-> Text

plain text body

-> Text

html body

-> [(Text, FilePath)]

attachments: [(content_type, path)]

-> SMTPConnection

-> IO ()

Send a mime mail. The attachments are included with the file path.

sendMimeMail'

Arguments

:: String

receiver

-> String

sender

-> String

subject

-> Text

plain text body

-> Text

html body

-> [(Text, Text, ByteString)]

attachments: [(content_type, file_name, content)]

-> SMTPConnection

-> IO ()

Send a mime mail. The attachments are included with in-memory ByteString.

sendMimeMail2 :: Mail -> SMTPConnection -> IO ()