Addy.Internal.Types

The module exports internal types along with their constructors.

The rendering code relies on the newtype wrappers around Text to keep out invalid characters. Prefer to use the official interface if possible.

Documentation

data Error

Potential validation errors.

Since: 0.1.0.0

Constructors

InvalidPrefixError Text

A component of an email address may not start with the recorded prefix text.

InvalidSuffixError Text

A component of an email address may not end with the recorded suffix text.

InvalidCharactersError Text

A component of an email address contains invalid characters.

InvalidLengthError Int Int Int

A component of an email address does not meet the set length requirements. The values in this constructor are min, max, and actual.

ParserFailedError Text

The input to the address decoder was not a valid email address and produced the recorded error message.

Instances

Eq Error

Defined in Addy.Internal.Types

Methods

(==) :: Error -> Error -> Bool

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

Show Error

Defined in Addy.Internal.Types

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

data EmailAddr

The representation of a complete email address.

The parser preserves optional components such as the display name and comments. The rendering code can optionally include these optional elements when turning the address back into Text.

Since: 0.1.0.0

Constructors

EmailAddr

Fields

• _displayName :: Maybe DisplayName
• _localPart :: LocalPart
• _domain :: Domain
• _comments :: [Comment]

Instances

Show EmailAddr

Defined in Addy.Internal.Render

Methods

showsPrec :: Int -> EmailAddr -> ShowS

show :: EmailAddr -> String

showList :: [EmailAddr] -> ShowS

displayName :: Lens' EmailAddr (Maybe DisplayName)

Optional display name. Addresses in the name-addr format from RFC 5322 allow descriptive text to precede the address. This is commonly used in email messages to list the name of the address' owner.

Since: 0.1.0.0

localPart :: Lens' EmailAddr LocalPart

The LocalPart of an email address usually references the destination mailbox on the Domain server. However, the content of the LocalPart can only be understood by the receiving Domain.

Since: 0.1.0.0

domain :: Lens' EmailAddr Domain

The Domain refers to the fully-qualified domain name that accepts mail for the associated LocalPart. See the documentation for the Domain type for more details.

Since: 0.1.0.0

comments :: Lens' EmailAddr [Comment]

Addresses in both the name-addr and addr-spec formats support comments.

Since: 0.1.0.0

newtype DisplayName

Optional display name. Usually this is the name of the person who receives email at the associated address.

Display Name <[e-mail]>

Since: 0.1.0.0

Constructors

DP

Fields

• displayNameText :: Text

Instances

Eq DisplayName

Defined in Addy.Internal.Types

Methods

(==) :: DisplayName -> DisplayName -> Bool

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

Show DisplayName

Defined in Addy.Internal.Types

Methods

showsPrec :: Int -> DisplayName -> ShowS

show :: DisplayName -> String

showList :: [DisplayName] -> ShowS

Semigroup DisplayName

Defined in Addy.Internal.Types

Methods

(<>) :: DisplayName -> DisplayName -> DisplayName

sconcat :: NonEmpty DisplayName -> DisplayName

stimes :: Integral b => b -> DisplayName -> DisplayName

newtype LocalPart

The name of the mailbox on the associated Domain.

Since: 0.1.0.0

Constructors

LP

Fields

• localPartText :: Text

Instances

Eq LocalPart

Defined in Addy.Internal.Types

Methods

(==) :: LocalPart -> LocalPart -> Bool

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

Show LocalPart

Defined in Addy.Internal.Types

Methods

showsPrec :: Int -> LocalPart -> ShowS

show :: LocalPart -> String

showList :: [LocalPart] -> ShowS

Semigroup LocalPart

Defined in Addy.Internal.Types

Methods

(<>) :: LocalPart -> LocalPart -> LocalPart

sconcat :: NonEmpty LocalPart -> LocalPart

stimes :: Integral b => b -> LocalPart -> LocalPart

data Domain

A fully-qualified domain name or an address literal.

Most email addresses use a domain name. However, it's perfectly legal to use an AddressLiteral instead.

Since: 0.1.0.0

Constructors

Domain DomainName

DomainLiteral AddressLiteral

Instances

Eq Domain

Defined in Addy.Internal.Types

Methods

(==) :: Domain -> Domain -> Bool

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

Show Domain

Defined in Addy.Internal.Types

Methods

showsPrec :: Int -> Domain -> ShowS

show :: Domain -> String

showList :: [Domain] -> ShowS

_Domain :: Prism' Domain DomainName

Prism for working with domain names.

Since: 0.1.0.0

_DomainLiteral :: Prism' Domain AddressLiteral

Prism for working with domain literals.

Since: 0.1.0.0

newtype DomainName

A fully-qualified domain name which is made up of a list of host names (labels) separated by dots.

Since: 0.1.0.0

Constructors

DN

Fields

• domainNameText :: Text

Instances

Eq DomainName

Defined in Addy.Internal.Types

Methods

(==) :: DomainName -> DomainName -> Bool

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

Show DomainName

Defined in Addy.Internal.Types

Methods

showsPrec :: Int -> DomainName -> ShowS

show :: DomainName -> String

showList :: [DomainName] -> ShowS

Semigroup DomainName

Defined in Addy.Internal.Types

Methods

(<>) :: DomainName -> DomainName -> DomainName

sconcat :: NonEmpty DomainName -> DomainName

stimes :: Integral b => b -> DomainName -> DomainName

newtype HostName

The name of one host component of a domain name.

Since: 0.1.0.0

Constructors

HN

Fields

• hostNameText :: Text

Instances

Eq HostName

Defined in Addy.Internal.Types

Methods

(==) :: HostName -> HostName -> Bool

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

Show HostName

Defined in Addy.Internal.Types

Methods

showsPrec :: Int -> HostName -> ShowS

show :: HostName -> String

showList :: [HostName] -> ShowS

Semigroup HostName

Defined in Addy.Internal.Types

Methods

(<>) :: HostName -> HostName -> HostName

sconcat :: NonEmpty HostName -> HostName

stimes :: Integral b => b -> HostName -> HostName

_HostNames :: Iso' DomainName [HostName]

Iso for converting between domain names and a list of host names.

>>> "gmail.uk.co" ^. _DomainName._HostNames & map (review _HostName)
["gmail","uk","co"]

Since: 0.1.0.0

data AddressLiteral

Address literals can be used instead of a domain name to direct mail to a specific IP address or other tagged address type.

Example email addresses with address literals:

example@[127.0.0.1]
example@[IPv6:1111:2222:3333:4444:5555:6666:7777]
example@[Just-some-text]

Since: 0.1.0.0

Constructors

IpAddressLiteral IP

A literal IP address as defined in RFC 5321 §4.1.3. The address can be in many formats so it is presented here in its parsed form.

TaggedAddressLiteral AddressTag Literal

RFC 5321 also defines a general address literal where a standardized tag precedes the address itself. The only information provided about the standardized tag is:

Standardized-tag MUST be specified in a
Standards-Track RFC and registered with IANA

AddressLiteral Literal

RFC 5322 defines a domain-literal as (roughly) a span of characters that are allowed in a domain name. The interpretation of those characters is left to "separate documents" such as RFC 5321.

If an address literal cannot be parsed in one of the proceeding formats it is encoded as a Literal value.

Instances

Eq AddressLiteral

Defined in Addy.Internal.Types

Methods

(==) :: AddressLiteral -> AddressLiteral -> Bool

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

Show AddressLiteral

Defined in Addy.Internal.Types

Methods

showsPrec :: Int -> AddressLiteral -> ShowS

show :: AddressLiteral -> String

showList :: [AddressLiteral] -> ShowS

_IpAddressLiteral :: Prism' AddressLiteral IP

Prism for working with IP address literals.

Since: 0.1.0.0

_TaggedAddressLiteral :: Prism' AddressLiteral (AddressTag, Literal)

Prism for working with tagged address literals.

Since: 0.1.0.0

_AddressLiteral :: Prism' AddressLiteral Literal

Prism for working with address literals.

Since: 0.1.0.0

newtype AddressTag

A tag that can be used with a TaggedAddressLiteral.

Since: 0.1.0.0

Constructors

AT

Fields

• addressTagText :: Text

Instances

Eq AddressTag

Defined in Addy.Internal.Types

Methods

(==) :: AddressTag -> AddressTag -> Bool

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

Show AddressTag

Defined in Addy.Internal.Types

Methods

showsPrec :: Int -> AddressTag -> ShowS

show :: AddressTag -> String

showList :: [AddressTag] -> ShowS

Semigroup AddressTag

Defined in Addy.Internal.Types

Methods

(<>) :: AddressTag -> AddressTag -> AddressTag

sconcat :: NonEmpty AddressTag -> AddressTag

stimes :: Integral b => b -> AddressTag -> AddressTag

newtype Literal

A literal address that can be used with a TaggedAddressLiteral or AddressLiteral.

Since: 0.1.0.0

Constructors

Lit

Fields

• literalText :: Text

Instances

Eq Literal

Defined in Addy.Internal.Types

Methods

(==) :: Literal -> Literal -> Bool

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

Show Literal

Defined in Addy.Internal.Types

Methods

showsPrec :: Int -> Literal -> ShowS

show :: Literal -> String

showList :: [Literal] -> ShowS

Semigroup Literal

Defined in Addy.Internal.Types

Methods

(<>) :: Literal -> Literal -> Literal

sconcat :: NonEmpty Literal -> Literal

stimes :: Integral b => b -> Literal -> Literal

data Comment

A comment which may appear in an email address in a specific location.

Since: 0.1.0.0

Constructors

Comment CommentLoc CommentContent

Instances

Eq Comment

Defined in Addy.Internal.Types

Methods

(==) :: Comment -> Comment -> Bool

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

Show Comment

Defined in Addy.Internal.Types

Methods

showsPrec :: Int -> Comment -> ShowS

show :: Comment -> String

showList :: [Comment] -> ShowS

_Comment :: Prism' Comment (CommentLoc, CommentContent)

Prism for working with a Comment.

Since: 0.1.0.0

commentLoc :: Lens' Comment CommentLoc

Lens for working with comment locations.

Since: 0.1.0.0

commentContent :: Lens' Comment CommentContent

Lens for working with comment contents.

Since: 0.1.0.0

data CommentLoc

The location where a comment was parsed or where it should be rendered.

Since: 0.1.0.0

Constructors

BeforeDisplayName

Just before the DisplayName.

AfterDisplayName

Just after the DisplayName but before the address.

BeforeLocalPart

Before the LocalPart of the address.

AfterDomain

After the Domain.

AfterAddress

After the complete address.

Instances

Eq CommentLoc

Defined in Addy.Internal.Types

Methods

(==) :: CommentLoc -> CommentLoc -> Bool

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

Show CommentLoc

Defined in Addy.Internal.Types

Methods

showsPrec :: Int -> CommentLoc -> ShowS

show :: CommentLoc -> String

showList :: [CommentLoc] -> ShowS

newtype CommentContent

Text that can appear in a comment.

Since: 0.1.0.0

Constructors

CC

Fields

• commentContentText :: Text

Instances

Eq CommentContent

Defined in Addy.Internal.Types

Methods

(==) :: CommentContent -> CommentContent -> Bool

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

Show CommentContent

Defined in Addy.Internal.Types

Methods

showsPrec :: Int -> CommentContent -> ShowS

show :: CommentContent -> String

showList :: [CommentContent] -> ShowS

Semigroup CommentContent

Defined in Addy.Internal.Types

Methods

(<>) :: CommentContent -> CommentContent -> CommentContent

sconcat :: NonEmpty CommentContent -> CommentContent

stimes :: Integral b => b -> CommentContent -> CommentContent