Text.Parsec.Rfc2821

This module exports parser combinators for the grammar described in RFC2821, "Simple Mail Transfer Protocol", http://www.faqs.org/rfcs/rfc2821.html.

Data Types for ESMTP Commands

data EsmtpCmd

The smtpCmd parser will create this data type from a string. Note that all command parsers expect their input to be terminated with crlf.

Constructors

Helo String

Ehlo String

MailFrom Mailbox

Might be nullPath.

RcptTo Mailbox

Might be postmaster.

Data

Rset

Send Mailbox

Soml Mailbox

Saml Mailbox

Vrfy String

Expn String

Help String

Might be [].

Noop

Optional argument ignored.

Quit

Turn

WrongArg String ParseError

When a valid command has been recognized, but the argument parser fails, then this type will be returned. The String contains the name of the command (in all upper-case) and the ParseError is, obviously, the error description.

Instances

Show EsmtpCmd

Defined in Text.Parsec.Rfc2821

Methods

showsPrec :: Int -> EsmtpCmd -> ShowS

show :: EsmtpCmd -> String

showList :: [EsmtpCmd] -> ShowS

data Mailbox

The most general e-mail address has the form: <[@route,...:]user@domain>. This type, too, supports show and read. Note that a "shown" address is always enclosed in angular brackets. When comparing two mailboxes for equality, the hostname is case-insensitive.

Constructors

Mailbox [String] String String

Instances

Eq Mailbox

Defined in Text.Parsec.Rfc2821

Methods

(==) :: Mailbox -> Mailbox -> Bool

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

Read Mailbox

Defined in Text.Parsec.Rfc2821

Methods

readsPrec :: Int -> ReadS Mailbox

readList :: ReadS [Mailbox]

readPrec :: ReadPrec Mailbox

readListPrec :: ReadPrec [Mailbox]

Show Mailbox

Defined in Text.Parsec.Rfc2821

Methods

showsPrec :: Int -> Mailbox -> ShowS

show :: Mailbox -> String

showList :: [Mailbox] -> ShowS

nullPath :: Mailbox

nullPath = Mailbox [] "" "" = "<>"

postmaster :: Mailbox

postmaster = Mailbox [] "postmaster" "" = "<postmaster>"

Data Types for ESMTP Replies

data EsmtpReply

An ESMTP reply is a three-digit return code plus some waste of bandwidth called "comments". This is what the list of strings is for; one string per line in the reply. show will append an "\r\n" end-of-line marker to each entry in that list, so that the resulting string is ready to be sent back to the peer. For example:

>>> show $ Reply (Code Success MailSystem 0) ["worked", "like", "a charm" ]
"250-worked\r\n250-like\r\n250 a charm\r\n"

If the message is an empty list [], a default text will be constructed:

>>> show $ Reply (Code Success MailSystem 0) []
"250 Success in category MailSystem\r\n"

Constructors

Reply EsmtpCode [String]

Instances

Show EsmtpReply

Defined in Text.Parsec.Rfc2821

Methods

showsPrec :: Int -> EsmtpReply -> ShowS

show :: EsmtpReply -> String

showList :: [EsmtpReply] -> ShowS

data EsmtpCode

Constructors

Code SuccessCode Category Int

Instances

Show EsmtpCode

Defined in Text.Parsec.Rfc2821

Methods

showsPrec :: Int -> EsmtpCode -> ShowS

show :: EsmtpCode -> String

showList :: [EsmtpCode] -> ShowS

data SuccessCode

Constructors

Unused0

PreliminarySuccess

Success

IntermediateSuccess

TransientFailure

PermanentFailure

Instances

Bounded SuccessCode

Defined in Text.Parsec.Rfc2821

Methods

minBound :: SuccessCode

maxBound :: SuccessCode

Enum SuccessCode

Defined in Text.Parsec.Rfc2821

Methods

succ :: SuccessCode -> SuccessCode

pred :: SuccessCode -> SuccessCode

toEnum :: Int -> SuccessCode

fromEnum :: SuccessCode -> Int

enumFrom :: SuccessCode -> [SuccessCode]

enumFromThen :: SuccessCode -> SuccessCode -> [SuccessCode]

enumFromTo :: SuccessCode -> SuccessCode -> [SuccessCode]

enumFromThenTo :: SuccessCode -> SuccessCode -> SuccessCode -> [SuccessCode]

Eq SuccessCode

Defined in Text.Parsec.Rfc2821

Methods

(==) :: SuccessCode -> SuccessCode -> Bool

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

Ord SuccessCode

Defined in Text.Parsec.Rfc2821

Methods

compare :: SuccessCode -> SuccessCode -> Ordering

(<) :: SuccessCode -> SuccessCode -> Bool

(<=) :: SuccessCode -> SuccessCode -> Bool

(>) :: SuccessCode -> SuccessCode -> Bool

(>=) :: SuccessCode -> SuccessCode -> Bool

max :: SuccessCode -> SuccessCode -> SuccessCode

min :: SuccessCode -> SuccessCode -> SuccessCode

Show SuccessCode

Defined in Text.Parsec.Rfc2821

Methods

showsPrec :: Int -> SuccessCode -> ShowS

show :: SuccessCode -> String

showList :: [SuccessCode] -> ShowS

data Category

Constructors

Syntax

Information

Connection

Unspecified3

Unspecified4

MailSystem

Instances

Bounded Category

Defined in Text.Parsec.Rfc2821

Methods

minBound :: Category

maxBound :: Category

Enum Category

Defined in Text.Parsec.Rfc2821

Methods

succ :: Category -> Category

pred :: Category -> Category

toEnum :: Int -> Category

fromEnum :: Category -> Int

enumFrom :: Category -> [Category]

enumFromThen :: Category -> Category -> [Category]

enumFromTo :: Category -> Category -> [Category]

enumFromThenTo :: Category -> Category -> Category -> [Category]

Eq Category

Defined in Text.Parsec.Rfc2821

Methods

(==) :: Category -> Category -> Bool

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

Ord Category

Defined in Text.Parsec.Rfc2821

Methods

compare :: Category -> Category -> Ordering

(<) :: Category -> Category -> Bool

(<=) :: Category -> Category -> Bool

(>) :: Category -> Category -> Bool

(>=) :: Category -> Category -> Bool

max :: Category -> Category -> Category

min :: Category -> Category -> Category

Show Category

Defined in Text.Parsec.Rfc2821

Methods

showsPrec :: Int -> Category -> ShowS

show :: Category -> String

showList :: [Category] -> ShowS

reply :: Int -> Int -> Int -> [String] -> EsmtpReply

Construct a EsmtpReply. Fails assert if invalid numbers are given.

isSuccess :: EsmtpReply -> Bool

A reply constitutes "success" if the status code is any of PreliminarySuccess, Success, or IntermediateSuccess.

isFailure :: EsmtpReply -> Bool

A reply constitutes "failure" if the status code is either PermanentFailure or TransientFailure.

isShutdown :: EsmtpReply -> Bool

The replies 221 and 421 signify Shutdown.

Command Parsers

smtpCmd :: Stream s m Char => ParsecT s u m EsmtpCmd

This parser recognizes any of the ESMTP commands defined below. Note that all command parsers expect their input to be terminated with crlf.

smtpData :: Stream s m Char => ParsecT s u m EsmtpCmd

The parser name "data" was taken.

rset :: Stream s m Char => ParsecT s u m EsmtpCmd

quit :: Stream s m Char => ParsecT s u m EsmtpCmd

turn :: Stream s m Char => ParsecT s u m EsmtpCmd

helo :: Stream s m Char => ParsecT s u m EsmtpCmd

ehlo :: Stream s m Char => ParsecT s u m EsmtpCmd

mail :: Stream s m Char => ParsecT s u m EsmtpCmd

rcpt :: Stream s m Char => ParsecT s u m EsmtpCmd

send :: Stream s m Char => ParsecT s u m EsmtpCmd

soml :: Stream s m Char => ParsecT s u m EsmtpCmd

saml :: Stream s m Char => ParsecT s u m EsmtpCmd

vrfy :: Stream s m Char => ParsecT s u m EsmtpCmd

expn :: Stream s m Char => ParsecT s u m EsmtpCmd

help :: Stream s m Char => ParsecT s u m EsmtpCmd

noop :: Stream s m Char => ParsecT s u m EsmtpCmd

May have an optional word argument, but it is ignored.

Argument Parsers

from_path :: Stream s m Char => ParsecT s u m Mailbox

to_path :: Stream s m Char => ParsecT s u m Mailbox

path :: Stream s m Char => ParsecT s u m Mailbox

mailbox :: Stream s m Char => ParsecT s u m Mailbox

local_part :: Stream s m Char => ParsecT s u m String

domain :: Stream s m Char => ParsecT s u m String

a_d_l :: Stream s m Char => ParsecT s u m [String]

at_domain :: Stream s m Char => ParsecT s u m String

address_literal :: Stream s m Char => ParsecT s u m String

TODO: Add IPv6 address and general literals

ipv4_literal :: Stream s m Char => ParsecT s u m String

ipv4addr :: Stream s m Char => ParsecT s u m String

subdomain :: Stream s m Char => ParsecT s u m String

dot_string :: Stream s m Char => ParsecT s u m String

atom :: Stream s m Char => ParsecT s u m String

snum :: Stream s m Char => ParsecT s u m String

number :: Stream s m Char => ParsecT s u m String

word :: Stream s m Char => ParsecT s u m String

This is a useful addition: The parser accepts an atom or a quoted_string.

Helper Functions

fixCRLF :: String -> String

Make the string crlf terminated no matter what. '\n' is expanded, otherwise crlf is appended. Note that if the string was terminated incorrectly before, it still is. This function is useful when reading input with hGetLine which removes the end-of-line delimiter.

mkCmd0 :: Stream s m Char => String -> a -> ParsecT s u m a

Construct a parser for a command without arguments. Expects crlf!

mkCmd1 :: Stream s m Char => String -> (a -> EsmtpCmd) -> ParsecT s u m a -> ParsecT s u m EsmtpCmd

Construct a parser for a command with an argument, which the given parser will handle. The result of the argument parser will be applied to the type constructor before it is returned. Expects crlf!

tokenList :: Stream s m Char => ParsecT s u m String -> Char -> ParsecT s u m String

tokenList p . will parse a token of the form "p.p", or "p.p.p", and so on. Used in domain and dot_string, for example.