Safe Haskell	Safe
Language	Haskell2010

EmailAddress

Contents

Data Type
Create EmailAddress
validation
Unsafe creation

Description

Adapted from Text.EmailAddress by Dennis Gosnell (see https://hackage.haskell.org/package/emailaddress) but without all the dependencies (like postgresql-simple ...). Uses the email-validate package, instead.

Synopsis

Data Type

newtype EmailAddress Source #

wrapper around our implementation - EmailAddress.

Constructors

EmailAddress
Fields unEmailAddress :: EmailAddress

Instances

Eq EmailAddress Source #
Methods (==) :: EmailAddress -> EmailAddress -> Bool # (/=) :: EmailAddress -> EmailAddress -> Bool #
Ord EmailAddress Source #
Methods compare :: EmailAddress -> EmailAddress -> Ordering # (<) :: EmailAddress -> EmailAddress -> Bool # (<=) :: EmailAddress -> EmailAddress -> Bool # (>) :: EmailAddress -> EmailAddress -> Bool # (>=) :: EmailAddress -> EmailAddress -> Bool # max :: EmailAddress -> EmailAddress -> EmailAddress # min :: EmailAddress -> EmailAddress -> EmailAddress #
Read EmailAddress Source #	`>>>` `(read "\"foo@gmail.com\"") :: EmailAddress`"foo@gmail.com"
Methods readsPrec :: Int -> ReadS EmailAddress # readList :: ReadS [EmailAddress] # readPrec :: ReadPrec EmailAddress # readListPrec :: ReadPrec [EmailAddress] #
Show EmailAddress Source #	`>>>` `import qualified Data.ByteString.Char8 as BS``>>>` `:set -XOverloadedStrings``>>>` `show $ unsafeEmailAddress "foo" "gmail.com"`"\"foo@gmail.com\""
Methods showsPrec :: Int -> EmailAddress -> ShowS # show :: EmailAddress -> String # showList :: [EmailAddress] -> ShowS #

Create EmailAddress

emailAddress :: ByteString -> Maybe EmailAddress Source #

Wrapper around emailAddress.

Similar to validate, but returns Nothing if the email address fails to parse.

>>> emailAddress "foo@gmail.com"
Just "foo@gmail.com"
>>> emailAddress "not an email address"
Nothing

emailAddressFromText :: Text -> Maybe EmailAddress Source #

Create an EmailAddress from a Text value. See emailAddress.

emailAddressFromString :: String -> Maybe EmailAddress Source #

Create an EmailAddress from a String value. See emailAddress.

validation

validate :: ByteString -> Either String EmailAddress Source #

Wrapper around validate.

>>> validate "foo@gmail.com"
Right "foo@gmail.com"
>>> import Data.Either (isLeft)
>>> isLeft $ validate "not an email address"
True

validateFromText :: Text -> Either String EmailAddress Source #

Create an EmailAddress from a Text value. See validate.

validateFromString :: String -> Either String EmailAddress Source #

Create an EmailAddress from a String value. See validate.

Unsafe creation

unsafeEmailAddress Source #

Arguments

:: ByteString	Local part
-> ByteString	Domain part
-> EmailAddress

Wrapper around unsafeEmailAddress.

Unsafely create an EmailAddress from a local part and a domain part. The first argument is the local part, and the second argument is the domain part.

For example, in the email address foo@gmail.com, the local part is foo and the domain part is gmail.com.

>>> unsafeEmailAddress "foo" "gmail.com"
"foo@gmail.com"