emailaddress-0.2.0.0: Wrapper around email-validate library adding instances for common type classes.

Copyright(c) Dennis Gosnell 2016
LicenseBSD3
Safe HaskellNone
LanguageHaskell2010

Text.EmailAddress

Contents

Description

This module is a wrapper around Text.Email.Validate from email-validate.

This module exports EmailAddress, a newtype wrapper around Text.Email.Validate.EmailAddress. Additional instances are defined for our new EmailAddress, including ToJSON and FromJSON. This is done so that no orphan instances need to be used.

If you would like additional instances to be defined, please send a pull request. Additional instances will be accepted for any typeclass from any package available on stackage.

Synopsis

Data Type

newtype EmailAddress #

Type to represent an email address. Newtype wrapper around EmailAddress with additional typeclass instances.

Constructors

EmailAddress 

Fields

Instances

Eq EmailAddress # 
Data EmailAddress # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EmailAddress -> c EmailAddress #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EmailAddress #

toConstr :: EmailAddress -> Constr #

dataTypeOf :: EmailAddress -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EmailAddress) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EmailAddress) #

gmapT :: (forall b. Data b => b -> b) -> EmailAddress -> EmailAddress #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EmailAddress -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EmailAddress -> r #

gmapQ :: (forall d. Data d => d -> u) -> EmailAddress -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EmailAddress -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EmailAddress -> m EmailAddress #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EmailAddress -> m EmailAddress #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EmailAddress -> m EmailAddress #

Ord EmailAddress # 
Read EmailAddress #
>>> toText $ read "\"foo@gmail.com\""
"foo@gmail.com"
Show EmailAddress #
>>> show $ unsafeEmailAddress "foo" "gmail.com"
"\"foo@gmail.com\""
Generic EmailAddress # 

Associated Types

type Rep EmailAddress :: * -> * #

Methods

from :: EmailAddress -> Rep EmailAddress x #

to :: Rep EmailAddress x -> EmailAddress #

ToJSON EmailAddress #

Turn EmailAddress into JSON.

>>> toJSON $ unsafeEmailAddress "foo" "gmail.com"
String "foo@gmail.com"
FromJSON EmailAddress #

Parse EmailAddress from JSON.

>>> import Data.Aeson (decode)
>>> fmap (fmap toText) (decode "[ \"foo@gmail.com \" ]" :: Maybe [EmailAddress])
Just ["foo@gmail.com"]
>>> decode "[ \"not an email address\" ]" :: Maybe [EmailAddress]
Nothing
ToHttpApiData EmailAddress #

This instance assumes EmailAddress is UTF8-encoded. See toText.

>>> toUrlPiece $ unsafeEmailAddress "foo" "gmail.com"
"foo@gmail.com"
FromHttpApiData EmailAddress #

This instance assumes EmailAddress is UTF8-encoded. See validateFromText.

>>> import Data.Either (isLeft)
>>> fmap toText $ parseUrlPiece "foo@gmail.com"
Right "foo@gmail.com"
>>> isLeft $ (parseUrlPiece "not an email address" :: Either Text EmailAddress)
True
FromField EmailAddress # 
PathPiece EmailAddress #

See emailAddressFromText and toText.

>>> fmap toText $ fromPathPiece "foo@gmail.com"
Just "foo@gmail.com"
>>> fmap toText $ fromPathPiece "this is not an email address"
Nothing
>>> toPathPiece $ unsafeEmailAddress "foo" "gmail.com"
"foo@gmail.com"
PersistFieldSql EmailAddress #

Treat EmailAddress just like a Text value.

>>> sqlType (Proxy :: Proxy EmailAddress)
SqlString
PersistField EmailAddress #

Treat EmailAddress just like a Text value.

>>> import Data.Either (isLeft)
>>> import Database.Persist.Types (PersistValue(PersistBool, PersistText))
>>> toPersistValue $ unsafeEmailAddress "foo" "gmail.com"
PersistText "foo@gmail.com"
>>> fmap toText $ fromPersistValue (PersistText "foo@gmail.com")
Right "foo@gmail.com"
>>> isLeft (fromPersistValue (PersistText "not an email address") :: Either Text EmailAddress)
True
>>> isLeft (fromPersistValue (PersistBool False) :: Either Text EmailAddress)
True
QueryRunnerColumnDefault PGText EmailAddress # 
Default Constant EmailAddress (Column PGText) # 
type Rep EmailAddress # 
type Rep EmailAddress = D1 (MetaData "EmailAddress" "Text.EmailAddress.Internal" "emailaddress-0.2.0.0-BO9O0BucFmV70tKDa7E2Nb" True) (C1 (MetaCons "EmailAddress" PrefixI True) (S1 (MetaSel (Just Symbol "unEmailAddress") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 EmailAddress)))

Create EmailAddress

emailAddress :: ByteString -> Maybe EmailAddress #

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

validate :: ByteString -> Either String EmailAddress #

Wrapper around validate.

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

emailAddressFromText :: Text -> Maybe EmailAddress #

Create an EmailAddress from a Text value. See emailAddress.

validateFromText :: Text -> Either String EmailAddress #

Create an EmailAddress from a Text value. See validate.

emailAddressFromString :: String -> Maybe EmailAddress #

Create an EmailAddress from a String value. See emailAddress.

validateFromString :: String -> Either String EmailAddress #

Create an EmailAddress from a String value. See validate.

Check validity

isValid :: ByteString -> Bool #

Validates whether a particular string is an email address according to RFC5322.

Convert to Text

toText :: EmailAddress -> Text #

Convert an email address to Text.

This assumes the EmailAddress is UTF8-encoded.

>>> let email = unsafeEmailAddress "foo" "gmail.com"
>>> email
"foo@gmail.com"
>>> toText email
"foo@gmail.com"

Convert back to ByteString

toByteString :: EmailAddress -> ByteString #

Wrapper around toByteString.

>>> let email = unsafeEmailAddress "foo" "gmail.com"
>>> email
"foo@gmail.com"
>>> toByteString email
"foo@gmail.com"

localPart :: EmailAddress -> ByteString #

Wrapper around localPart.

Extracts the local part from an email address.

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

>>> let email = unsafeEmailAddress "foo" "gmail.com"
>>> email
"foo@gmail.com"
>>> localPart email
"foo"

domainPart :: EmailAddress -> ByteString #

Wrapper around domainPart.

Extracts the domain part from an email address.

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

>>> let email = unsafeEmailAddress "foo" "gmail.com"
>>> email
"foo@gmail.com"
>>> domainPart email
"gmail.com"

Helper functions

canonicalizeEmail :: ByteString -> Maybe ByteString #

Checks that an email is valid and returns a version of it where comments and whitespace have been removed.

Example: >>> canonicalizeEmail "spaces. are. allowedexample.com" Just "spaces.are.allowedexample.com"

Unsafe creation

unsafeEmailAddress #

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"