| Safe Haskell | Safe |
|---|---|
| Language | Haskell2010 |
Text.Email.Validate
- isValid :: ByteString -> Bool
- validate :: ByteString -> Either String EmailAddress
- emailAddress :: ByteString -> Maybe EmailAddress
- canonicalizeEmail :: ByteString -> Maybe ByteString
- data EmailAddress
- unsafeEmailAddress :: ByteString -> ByteString -> EmailAddress
- localPart :: EmailAddress -> ByteString
- domainPart :: EmailAddress -> ByteString
- toByteString :: EmailAddress -> ByteString
Documentation
isValid :: ByteString -> Bool Source
Validates whether a particular string is an email address according to RFC5322.
validate :: ByteString -> Either String EmailAddress Source
If you want to find out *why* a particular string is not an email address, use this.
emailAddress :: ByteString -> Maybe EmailAddress Source
Smart constructor for an email address
canonicalizeEmail :: ByteString -> Maybe ByteString Source
Checks that an email is valid and returns a version of it where comments and whitespace have been removed.
data EmailAddress Source
Represents an email address.
unsafeEmailAddress :: ByteString -> ByteString -> EmailAddress Source
Creates an email address without validating it. You should only use this when reading data from somewhere it has already been validated (e.g. a database).
localPart :: EmailAddress -> ByteString Source
Extracts the local part of an email address.
domainPart :: EmailAddress -> ByteString Source
Extracts the domain part of an email address.
toByteString :: EmailAddress -> ByteString Source
Converts an email address back to a ByteString