| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Data.Mail.DMARC.Reports
Contents
Description
Utilities for parsing a DMARC aggregated report, following RFC 7489. These functions also handle decompression (gzip or pkzip)
Synopsis
- dmarcFeedbackFromStrict :: ByteString -> Maybe Feedback
- dmarcFeedbackFromLazy :: ByteString -> Maybe Feedback
- dmarcFeedbackFromStream :: (MonadFail m, MonadIO m) => ByteStream m r -> m (Maybe Feedback)
- dmarcFeedbackFromXml :: Element -> Maybe Feedback
- data Feedback = Feedback {}
- data ReportMetadata = ReportMetadata {}
- data Record = Record {}
- data Row = Row {}
- data PolicyPublished = PolicyPublished {}
- data PolicyEvaluated = PolicyEvaluated {}
- data DkimAuth = DkimAuth {
- daResult :: AuthResult
- daDomain :: Text
- daSelector :: Text
- data SpfAuth = SpfAuth {
- saResult :: AuthResult
- saDomain :: Text
- data AuthResult
- type IpAddress = String
- data AlignmentMode
- data PolicyAction
- = NoPolicy
- | Quarantine
- | Reject
- uncompressStream :: (MonadFail m, MonadIO m) => ByteStream m r -> ByteStream m ()
Parsers
dmarcFeedbackFromStrict :: ByteString -> Maybe Feedback Source #
Parse a DMARC report from a strict ByteString
dmarcFeedbackFromLazy :: ByteString -> Maybe Feedback Source #
Parse a DMARC report from a lazy ByteString
dmarcFeedbackFromStream :: (MonadFail m, MonadIO m) => ByteStream m r -> m (Maybe Feedback) Source #
Parse a DMARC report from a ByteStream
Data types
Constructors
| Feedback | |
Fields | |
data ReportMetadata Source #
Constructors
| ReportMetadata | |
Instances
| Eq ReportMetadata Source # | |
Defined in Data.Mail.DMARC.Reports Methods (==) :: ReportMetadata -> ReportMetadata -> Bool # (/=) :: ReportMetadata -> ReportMetadata -> Bool # | |
| Read ReportMetadata Source # | |
Defined in Data.Mail.DMARC.Reports Methods readsPrec :: Int -> ReadS ReportMetadata # readList :: ReadS [ReportMetadata] # | |
| Show ReportMetadata Source # | |
Defined in Data.Mail.DMARC.Reports Methods showsPrec :: Int -> ReportMetadata -> ShowS # show :: ReportMetadata -> String # showList :: [ReportMetadata] -> ShowS # | |
data PolicyPublished Source #
Constructors
| PolicyPublished | |
Fields | |
Instances
| Eq PolicyPublished Source # | |
Defined in Data.Mail.DMARC.Reports Methods (==) :: PolicyPublished -> PolicyPublished -> Bool # (/=) :: PolicyPublished -> PolicyPublished -> Bool # | |
| Read PolicyPublished Source # | |
Defined in Data.Mail.DMARC.Reports Methods readsPrec :: Int -> ReadS PolicyPublished # readList :: ReadS [PolicyPublished] # | |
| Show PolicyPublished Source # | |
Defined in Data.Mail.DMARC.Reports Methods showsPrec :: Int -> PolicyPublished -> ShowS # show :: PolicyPublished -> String # showList :: [PolicyPublished] -> ShowS # | |
data PolicyEvaluated Source #
Constructors
| PolicyEvaluated | |
Fields | |
Instances
| Eq PolicyEvaluated Source # | |
Defined in Data.Mail.DMARC.Reports Methods (==) :: PolicyEvaluated -> PolicyEvaluated -> Bool # (/=) :: PolicyEvaluated -> PolicyEvaluated -> Bool # | |
| Read PolicyEvaluated Source # | |
Defined in Data.Mail.DMARC.Reports Methods readsPrec :: Int -> ReadS PolicyEvaluated # readList :: ReadS [PolicyEvaluated] # | |
| Show PolicyEvaluated Source # | |
Defined in Data.Mail.DMARC.Reports Methods showsPrec :: Int -> PolicyEvaluated -> ShowS # show :: PolicyEvaluated -> String # showList :: [PolicyEvaluated] -> ShowS # | |
Constructors
| DkimAuth | |
Fields
| |
Constructors
| SpfAuth | |
Fields
| |
data AuthResult Source #
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 Source # | |
Defined in Data.Mail.DMARC.Reports | |
| Read AuthResult Source # | |
Defined in Data.Mail.DMARC.Reports Methods readsPrec :: Int -> ReadS AuthResult # readList :: ReadS [AuthResult] # readPrec :: ReadPrec AuthResult # readListPrec :: ReadPrec [AuthResult] # | |
| Show AuthResult Source # | |
Defined in Data.Mail.DMARC.Reports Methods showsPrec :: Int -> AuthResult -> ShowS # show :: AuthResult -> String # showList :: [AuthResult] -> ShowS # | |
data AlignmentMode Source #
Instances
| Eq AlignmentMode Source # | |
Defined in Data.Mail.DMARC.Reports Methods (==) :: AlignmentMode -> AlignmentMode -> Bool # (/=) :: AlignmentMode -> AlignmentMode -> Bool # | |
| Read AlignmentMode Source # | |
Defined in Data.Mail.DMARC.Reports Methods readsPrec :: Int -> ReadS AlignmentMode # readList :: ReadS [AlignmentMode] # | |
| Show AlignmentMode Source # | |
Defined in Data.Mail.DMARC.Reports Methods showsPrec :: Int -> AlignmentMode -> ShowS # show :: AlignmentMode -> String # showList :: [AlignmentMode] -> ShowS # | |
data PolicyAction Source #
Constructors
| NoPolicy | |
| Quarantine | |
| Reject |
Instances
| Eq PolicyAction Source # | |
Defined in Data.Mail.DMARC.Reports | |
| Read PolicyAction Source # | |
Defined in Data.Mail.DMARC.Reports Methods readsPrec :: Int -> ReadS PolicyAction # readList :: ReadS [PolicyAction] # | |
| Show PolicyAction Source # | |
Defined in Data.Mail.DMARC.Reports Methods showsPrec :: Int -> PolicyAction -> ShowS # show :: PolicyAction -> String # showList :: [PolicyAction] -> ShowS # | |
Utility
uncompressStream :: (MonadFail m, MonadIO m) => ByteStream m r -> ByteStream m () Source #
Uncompress gzip or pkzip stream. If it is neither gzipped or pkzipped, return the stream unmodified.