Data.Mail.DMARC.Reports

Utilities for parsing a DMARC aggregated report, following RFC 7489. These functions also handle decompression (gzip or pkzip)

Parsers

dmarcFeedbackFromStrict :: ByteString -> Maybe Feedback

Parse a DMARC report from a strict ByteString

dmarcFeedbackFromLazy :: ByteString -> Maybe Feedback

Parse a DMARC report from a lazy ByteString

dmarcFeedbackFromXml :: Element -> Maybe Feedback

Parse a DMARC report from an XML document

Data types

data Feedback

Constructors

Feedback

Fields

• fbReportMetadata :: ReportMetadata
• fbPolicyPublished :: PolicyPublished
• fbRecords :: [Record]

Instances

Eq Feedback

Defined in Data.Mail.DMARC.Reports

Methods

(==) :: Feedback -> Feedback -> Bool

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

Read Feedback

Defined in Data.Mail.DMARC.Reports

Methods

readsPrec :: Int -> ReadS Feedback

readList :: ReadS [Feedback]

readPrec :: ReadPrec Feedback

readListPrec :: ReadPrec [Feedback]

Show Feedback

Defined in Data.Mail.DMARC.Reports

Methods

showsPrec :: Int -> Feedback -> ShowS

show :: Feedback -> String

showList :: [Feedback] -> ShowS

data ReportMetadata

Constructors

ReportMetadata

Fields

• rmOrgName :: Maybe Text
• rmEmail :: Maybe Text
• rmExtraContactInfo :: Maybe Text
• rmReportId :: Maybe Integer
• rmDateRange :: Maybe (UTCTime, UTCTime)

Instances

Eq ReportMetadata

Defined in Data.Mail.DMARC.Reports

Methods

(==) :: ReportMetadata -> ReportMetadata -> Bool

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

Read ReportMetadata

Defined in Data.Mail.DMARC.Reports

Methods

readsPrec :: Int -> ReadS ReportMetadata

readList :: ReadS [ReportMetadata]

readPrec :: ReadPrec ReportMetadata

readListPrec :: ReadPrec [ReportMetadata]

Show ReportMetadata

Defined in Data.Mail.DMARC.Reports

Methods

showsPrec :: Int -> ReportMetadata -> ShowS

show :: ReportMetadata -> String

showList :: [ReportMetadata] -> ShowS

data Record

Constructors

Record

Fields

• rcRow :: Row
• rcAuthDkim :: Maybe DkimAuth
• rcAuthSpf :: Maybe SpfAuth

Instances

Eq Record

Defined in Data.Mail.DMARC.Reports

Methods

(==) :: Record -> Record -> Bool

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

Read Record

Defined in Data.Mail.DMARC.Reports

Methods

readsPrec :: Int -> ReadS Record

readList :: ReadS [Record]

readPrec :: ReadPrec Record

readListPrec :: ReadPrec [Record]

Show Record

Defined in Data.Mail.DMARC.Reports

Methods

showsPrec :: Int -> Record -> ShowS

show :: Record -> String

showList :: [Record] -> ShowS

data Row

Constructors

Row

Fields

• rwSourceIp :: IpAddress
• rwCount :: Int
• rwPolicyEvaluated :: PolicyEvaluated

Instances

Eq Row

Defined in Data.Mail.DMARC.Reports

Methods

(==) :: Row -> Row -> Bool

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

Read Row

Defined in Data.Mail.DMARC.Reports

Methods

readsPrec :: Int -> ReadS Row

readList :: ReadS [Row]

readPrec :: ReadPrec Row

readListPrec :: ReadPrec [Row]

Show Row

Defined in Data.Mail.DMARC.Reports

Methods

showsPrec :: Int -> Row -> ShowS

show :: Row -> String

showList :: [Row] -> ShowS

data PolicyPublished

Constructors

PolicyPublished

Fields

• ppDomain :: Text
• ppDkimAlignment :: AlignmentMode
• ppSpfAlignment :: AlignmentMode
• ppPolicy :: PolicyAction
• ppSubdomainPolicy :: PolicyAction
• ppPercent :: Int

Instances

Eq PolicyPublished

Defined in Data.Mail.DMARC.Reports

Methods

(==) :: PolicyPublished -> PolicyPublished -> Bool

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

Read PolicyPublished

Defined in Data.Mail.DMARC.Reports

Methods

readsPrec :: Int -> ReadS PolicyPublished

readList :: ReadS [PolicyPublished]

readPrec :: ReadPrec PolicyPublished

readListPrec :: ReadPrec [PolicyPublished]

Show PolicyPublished

Defined in Data.Mail.DMARC.Reports

Methods

showsPrec :: Int -> PolicyPublished -> ShowS

show :: PolicyPublished -> String

showList :: [PolicyPublished] -> ShowS

data PolicyEvaluated

Constructors

PolicyEvaluated

Fields

• peDisposition :: PolicyAction
• peDkimResult :: AuthResult
• peSpfResult :: AuthResult

Instances

Eq PolicyEvaluated

Defined in Data.Mail.DMARC.Reports

Methods

(==) :: PolicyEvaluated -> PolicyEvaluated -> Bool

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

Read PolicyEvaluated

Defined in Data.Mail.DMARC.Reports

Methods

readsPrec :: Int -> ReadS PolicyEvaluated

readList :: ReadS [PolicyEvaluated]

readPrec :: ReadPrec PolicyEvaluated

readListPrec :: ReadPrec [PolicyEvaluated]

Show PolicyEvaluated

Defined in Data.Mail.DMARC.Reports

Methods

showsPrec :: Int -> PolicyEvaluated -> ShowS

show :: PolicyEvaluated -> String

showList :: [PolicyEvaluated] -> ShowS

data DkimAuth

Constructors

DkimAuth

Fields

• daResult :: AuthResult
• daDomain :: Text
• daSelector :: Text

Instances

Eq DkimAuth

Defined in Data.Mail.DMARC.Reports

Methods

(==) :: DkimAuth -> DkimAuth -> Bool

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

Read DkimAuth

Defined in Data.Mail.DMARC.Reports

Methods

readsPrec :: Int -> ReadS DkimAuth

readList :: ReadS [DkimAuth]

readPrec :: ReadPrec DkimAuth

readListPrec :: ReadPrec [DkimAuth]

Show DkimAuth

Defined in Data.Mail.DMARC.Reports

Methods

showsPrec :: Int -> DkimAuth -> ShowS

show :: DkimAuth -> String

showList :: [DkimAuth] -> ShowS

data SpfAuth

Constructors

SpfAuth

Fields

• saResult :: AuthResult
• saDomain :: Text

Instances

Eq SpfAuth

Defined in Data.Mail.DMARC.Reports

Methods

(==) :: SpfAuth -> SpfAuth -> Bool

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

Read SpfAuth

Defined in Data.Mail.DMARC.Reports

Methods

readsPrec :: Int -> ReadS SpfAuth

readList :: ReadS [SpfAuth]

readPrec :: ReadPrec SpfAuth

readListPrec :: ReadPrec [SpfAuth]

Show SpfAuth

Defined in Data.Mail.DMARC.Reports

Methods

showsPrec :: Int -> SpfAuth -> ShowS

show :: SpfAuth -> String

showList :: [SpfAuth] -> ShowS

data AuthResult

Constructors

NoAuth

no policy published

AuthPass

successful authentication

AuthFail

authentication failed

TempError

temporary error in resolving the policy

PermError

permanent error in resolving the policy

AuthNeutral

??? (DKIM only)

AuthPolicy

??? (DKIM only)

SoftFail

auth failed, but won't reject (SPF only)

Instances

Eq AuthResult

Defined in Data.Mail.DMARC.Reports

Methods

(==) :: AuthResult -> AuthResult -> Bool

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

Read AuthResult

Defined in Data.Mail.DMARC.Reports

Methods

readsPrec :: Int -> ReadS AuthResult

readList :: ReadS [AuthResult]

readPrec :: ReadPrec AuthResult

readListPrec :: ReadPrec [AuthResult]

Show AuthResult

Defined in Data.Mail.DMARC.Reports

Methods

showsPrec :: Int -> AuthResult -> ShowS

show :: AuthResult -> String

showList :: [AuthResult] -> ShowS

type IpAddress = String

data AlignmentMode

Constructors

Strict

Relaxed

Instances

Eq AlignmentMode

Defined in Data.Mail.DMARC.Reports

Methods

(==) :: AlignmentMode -> AlignmentMode -> Bool

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

Read AlignmentMode

Defined in Data.Mail.DMARC.Reports

Methods

readsPrec :: Int -> ReadS AlignmentMode

readList :: ReadS [AlignmentMode]

readPrec :: ReadPrec AlignmentMode

readListPrec :: ReadPrec [AlignmentMode]

Show AlignmentMode

Defined in Data.Mail.DMARC.Reports

Methods

showsPrec :: Int -> AlignmentMode -> ShowS

show :: AlignmentMode -> String

showList :: [AlignmentMode] -> ShowS

data PolicyAction

Constructors

NoPolicy

Quarantine

Reject

Instances

Eq PolicyAction

Defined in Data.Mail.DMARC.Reports

Methods

(==) :: PolicyAction -> PolicyAction -> Bool

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

Read PolicyAction

Defined in Data.Mail.DMARC.Reports

Methods

readsPrec :: Int -> ReadS PolicyAction

readList :: ReadS [PolicyAction]

readPrec :: ReadPrec PolicyAction

readListPrec :: ReadPrec [PolicyAction]

Show PolicyAction

Defined in Data.Mail.DMARC.Reports

Methods

showsPrec :: Int -> PolicyAction -> ShowS

show :: PolicyAction -> String

showList :: [PolicyAction] -> ShowS

Utility

uncompressString :: ByteString -> ByteString

Uncompress gzip or pkzip bytestring. If it is neither gzipped or pkzipped, return the string unmodified.