newsletter-0: A basic newsletter implimentation, using various backends.

Safe Haskell	None
Language	Haskell2010

Network.Mail.Newsletter.Web.API

Synopsis

class HasApiRoot m where
- type ApiRoot m
- apiRoot :: m (Proxy (ApiRoot m))
- apiBase :: m URI
class DedupSubscriptions m where
- recentlySubscribed :: Address -> m Bool
class HasClientSessionKey k where
- clientSessionKey :: Lens' k Key
class HasAllowedOrigins t where
- allowedOrigins :: Lens' t [URIAuth]
data NewsletterTimeouts = NewsletterTimeouts {
- _nltSubTimeout :: Integer
- _nltGrace :: Integer
}
class HasNewsletterTimeouts c where
- newsletterTimeouts :: Lens' c NewsletterTimeouts
- nltGrace :: Lens' c Integer
- nltSubTimeout :: Lens' c Integer
data RefPolicy
- = NoRef
- | SameOrigin
- | StrictOrigin
- | StrictOriginCross
type NewsletterAPI = NewsletterUnsub :<|> (NewsletterSub :<|> NewsletterSubConfirm)
newsletterApi :: Proxy NewsletterAPI
genUnsubLink :: (HasClientSessionKey k, MonadIO m, MonadReader k m, HasApiRoot m, IsElem NewsletterUnsubGet (ApiRoot m)) => Address -> m URI
genSubConfirmLink :: (HasClientSessionKey k, MonadIO m, MonadReader k m, HasApiRoot m, IsElem NewsletterSubConfirmGet (ApiRoot m)) => Address -> m URI
type NewsletterUnsub = NewsletterUnsubGet :<|> NewsletterUnsubPost
type NewsletterUnsubGet = "unsubscribe" :> (Capture "unsub" Text :> Get '[HTML] (Headers '[Header "Referrer-Policy" RefPolicy] Html))
type NewsletterUnsubPost = "unsubscribe" :> (Capture "unsub" Text :> Post '[HTML] (Headers '[Header "Referrer-Policy" RefPolicy] Html))
type NewsletterSub = NewsletterSubGet :<|> NewsletterSubPost
type NewsletterSubGet = Get '[HTML] Html
type NewsletterSubPost = Header "Origin" String :> (Header "Referer" String :> (ReqBody '[FormUrlEncoded] Form :> Post '[HTML] Html))
type NewsletterSubConfirm = NewsletterSubConfirmGet :<|> NewsletterSubConfirmPost
type NewsletterSubConfirmGet = "confirm" :> (Capture "sub" Text :> Get '[HTML] (Headers '[Header "Referrer-Policy" RefPolicy] Html))
type NewsletterSubConfirmPost = "confirm" :> (Capture "sub" Text :> Post '[HTML] (Headers '[Header "Referrer-Policy" RefPolicy] Html))
decodeCS :: (HasClientSessionKey k, MonadReader k m) => (ByteString -> Maybe b) -> Text -> m (Maybe b)
data SignupReq = SignupReq {
- _signupTime :: Day
- _signupAddress :: Text
}
encSignup :: (HasClientSessionKey k, MonadIO m, MonadReader k m) => SignupReq -> m Text
decSignup :: (HasClientSessionKey k, MonadReader k m) => Text -> m (Maybe SignupReq)

Documentation

class HasApiRoot m where Source #

Associated Types

type ApiRoot m Source #

Methods

apiRoot :: m (Proxy (ApiRoot m)) Source #

apiBase :: m URI Source #

class DedupSubscriptions m where Source #

A class to avoid repeated emailing someone even if they sign up multiple times.

Methods

recentlySubscribed :: Address -> m Bool Source #

class HasClientSessionKey k where Source #

Methods

clientSessionKey :: Lens' k Key Source #

Instances

HasClientSessionKey Key Source #
Instance details Defined in Network.Mail.Newsletter.Web.API Methods clientSessionKey :: Lens' Key Key Source #

class HasAllowedOrigins t where Source #

Methods

allowedOrigins :: Lens' t [URIAuth] Source #

data NewsletterTimeouts Source #

Constructors

NewsletterTimeouts
Fields _nltSubTimeout :: Integer How long subsription confirmation links are valid for _nltGrace :: Integer How much extra time they have to POST the confirmation

Instances

Show NewsletterTimeouts Source #
Instance details Defined in Network.Mail.Newsletter.Web.API Methods showsPrec :: Int -> NewsletterTimeouts -> ShowS # show :: NewsletterTimeouts -> String # showList :: [NewsletterTimeouts] -> ShowS #
HasNewsletterTimeouts NewsletterTimeouts Source #
Instance details Defined in Network.Mail.Newsletter.Web.API Methods newsletterTimeouts :: Lens' NewsletterTimeouts NewsletterTimeouts Source # nltGrace :: Lens' NewsletterTimeouts Integer Source # nltSubTimeout :: Lens' NewsletterTimeouts Integer Source #

class HasNewsletterTimeouts c where Source #

Minimal complete definition

newsletterTimeouts

Methods

newsletterTimeouts :: Lens' c NewsletterTimeouts Source #

nltGrace :: Lens' c Integer Source #

nltSubTimeout :: Lens' c Integer Source #

Instances

HasNewsletterTimeouts NewsletterTimeouts Source #
Instance details Defined in Network.Mail.Newsletter.Web.API Methods newsletterTimeouts :: Lens' NewsletterTimeouts NewsletterTimeouts Source # nltGrace :: Lens' NewsletterTimeouts Integer Source # nltSubTimeout :: Lens' NewsletterTimeouts Integer Source #

data RefPolicy Source #

Constructors

NoRef
SameOrigin
StrictOrigin
StrictOriginCross

Instances

Show RefPolicy Source #
Instance details Defined in Network.Mail.Newsletter.Web.API Methods showsPrec :: Int -> RefPolicy -> ShowS # show :: RefPolicy -> String # showList :: [RefPolicy] -> ShowS #
ToHttpApiData RefPolicy Source #
Instance details Defined in Network.Mail.Newsletter.Web.API Methods toUrlPiece :: RefPolicy -> Text # toEncodedUrlPiece :: RefPolicy -> Builder # toHeader :: RefPolicy -> ByteString # toQueryParam :: RefPolicy -> Text #

type NewsletterAPI = NewsletterUnsub :<|> (NewsletterSub :<|> NewsletterSubConfirm) Source #

newsletterApi :: Proxy NewsletterAPI Source #

genUnsubLink :: (HasClientSessionKey k, MonadIO m, MonadReader k m, HasApiRoot m, IsElem NewsletterUnsubGet (ApiRoot m)) => Address -> m URI Source #

genSubConfirmLink :: (HasClientSessionKey k, MonadIO m, MonadReader k m, HasApiRoot m, IsElem NewsletterSubConfirmGet (ApiRoot m)) => Address -> m URI Source #

type NewsletterUnsub = NewsletterUnsubGet :<|> NewsletterUnsubPost Source #

type NewsletterUnsubGet = "unsubscribe" :> (Capture "unsub" Text :> Get '[HTML] (Headers '[Header "Referrer-Policy" RefPolicy] Html)) Source #

type NewsletterUnsubPost = "unsubscribe" :> (Capture "unsub" Text :> Post '[HTML] (Headers '[Header "Referrer-Policy" RefPolicy] Html)) Source #

type NewsletterSub = NewsletterSubGet :<|> NewsletterSubPost Source #

type NewsletterSubGet = Get '[HTML] Html Source #

type NewsletterSubPost = Header "Origin" String :> (Header "Referer" String :> (ReqBody '[FormUrlEncoded] Form :> Post '[HTML] Html)) Source #

type NewsletterSubConfirm = NewsletterSubConfirmGet :<|> NewsletterSubConfirmPost Source #

type NewsletterSubConfirmGet = "confirm" :> (Capture "sub" Text :> Get '[HTML] (Headers '[Header "Referrer-Policy" RefPolicy] Html)) Source #

type NewsletterSubConfirmPost = "confirm" :> (Capture "sub" Text :> Post '[HTML] (Headers '[Header "Referrer-Policy" RefPolicy] Html)) Source #

decodeCS :: (HasClientSessionKey k, MonadReader k m) => (ByteString -> Maybe b) -> Text -> m (Maybe b) Source #

data SignupReq Source #

Constructors

SignupReq
Fields _signupTime :: Day Makes sure a singup isn't value forever _signupAddress :: Text

Instances

Eq SignupReq Source #
Instance details Defined in Network.Mail.Newsletter.Web.API Methods (==) :: SignupReq -> SignupReq -> Bool # (/=) :: SignupReq -> SignupReq -> Bool #
Ord SignupReq Source #
Instance details Defined in Network.Mail.Newsletter.Web.API Methods compare :: SignupReq -> SignupReq -> Ordering # (<) :: SignupReq -> SignupReq -> Bool # (<=) :: SignupReq -> SignupReq -> Bool # (>) :: SignupReq -> SignupReq -> Bool # (>=) :: SignupReq -> SignupReq -> Bool # max :: SignupReq -> SignupReq -> SignupReq # min :: SignupReq -> SignupReq -> SignupReq #
Show SignupReq Source #
Instance details Defined in Network.Mail.Newsletter.Web.API Methods showsPrec :: Int -> SignupReq -> ShowS # show :: SignupReq -> String # showList :: [SignupReq] -> ShowS #

encSignup :: (HasClientSessionKey k, MonadIO m, MonadReader k m) => SignupReq -> m Text Source #

decSignup :: (HasClientSessionKey k, MonadReader k m) => Text -> m (Maybe SignupReq) Source #