Network.Mail.Newsletter.Web

Documentation

class HasApiRoot m where

Associated Types

type ApiRoot m

Methods

apiRoot :: m (Proxy (ApiRoot m))

apiBase :: m URI

class DedupSubscriptions m where

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

Methods

recentlySubscribed :: Address -> m Bool

class HasAllowedOrigins t where

Methods

allowedOrigins :: Lens' t [URIAuth]

class HasClientSessionKey k where

Methods

clientSessionKey :: Lens' k Key

Instances

HasClientSessionKey Key

Defined in Network.Mail.Newsletter.Web.API

Methods

clientSessionKey :: Lens' Key Key

data NewsletterTimeouts

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

Defined in Network.Mail.Newsletter.Web.API

Methods

showsPrec :: Int -> NewsletterTimeouts -> ShowS

show :: NewsletterTimeouts -> String

showList :: [NewsletterTimeouts] -> ShowS

HasNewsletterTimeouts NewsletterTimeouts

Defined in Network.Mail.Newsletter.Web.API

Methods

newsletterTimeouts :: Lens' NewsletterTimeouts NewsletterTimeouts

nltGrace :: Lens' NewsletterTimeouts Integer

nltSubTimeout :: Lens' NewsletterTimeouts Integer

class HasNewsletterTimeouts c where

Minimal complete definition

newsletterTimeouts

Methods

newsletterTimeouts :: Lens' c NewsletterTimeouts

nltGrace :: Lens' c Integer

nltSubTimeout :: Lens' c Integer

Instances

HasNewsletterTimeouts NewsletterTimeouts

Defined in Network.Mail.Newsletter.Web.API

Methods

newsletterTimeouts :: Lens' NewsletterTimeouts NewsletterTimeouts

nltGrace :: Lens' NewsletterTimeouts Integer

nltSubTimeout :: Lens' NewsletterTimeouts Integer

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

newsletterApi :: Proxy NewsletterAPI

class HasNlTemplates c m | c -> m where

Minimal complete definition

nlTemplates

Methods

nlTemplates :: Lens' c (NlTemplates m)

confirmConfirmed :: HasApiRoot m => Getter c (Address -> m Html)

confirmStart :: HasApiRoot m => Getter c (Address -> m Html)

optInEmail :: HasApiRoot m => Getter c (Address -> m (Address -> Mail))

subStartPage :: HasApiRoot m => Getter c (Text -> Text -> Text -> Text -> m Html)

subStartSubmitted :: HasApiRoot m => Getter c (Address -> m Html)

unsubConfirmTempl :: HasApiRoot m => Getter c (Address -> m Html)

unsubTempl :: HasApiRoot m => Getter c (Address -> m Html)

Instances

HasNlTemplates (NlTemplates m) m

Defined in Network.Mail.Newsletter.Web.Templates

Methods

nlTemplates :: Lens' (NlTemplates m) (NlTemplates m)

confirmConfirmed :: Getter (NlTemplates m) (Address -> m Html)

confirmStart :: Getter (NlTemplates m) (Address -> m Html)

optInEmail :: Getter (NlTemplates m) (Address -> m (Address -> Mail))

subStartPage :: Getter (NlTemplates m) (Text -> Text -> Text -> Text -> m Html)

subStartSubmitted :: Getter (NlTemplates m) (Address -> m Html)

unsubConfirmTempl :: Getter (NlTemplates m) (Address -> m Html)

unsubTempl :: Getter (NlTemplates m) (Address -> m Html)

data NlTemplates m

Constructors

NlTemplates

Fields

• _subStartPage :: HasApiRoot m => Text -> Text -> Text -> Text -> m Html

  The sign up start form page.

• _subStartSubmitted :: HasApiRoot m => Address -> m Html

  The page the sign up form lands at.

• _optInEmail :: HasApiRoot m => Address -> m (Address -> Mail)

  Given the potential new subsriber, generate the opt-in email to them.

• _confirmStart :: HasApiRoot m => Address -> m Html

  The page people land on from the email to confirm they want to subscribe.

• _confirmConfirmed :: HasApiRoot m => Address -> m Html

  The page that confirms they have completed subscribing.

• _unsubConfirmTempl :: HasApiRoot m => Address -> m Html

  A page with an unsubscribe button for a given user. The URI is the form POST destination, the Address is the addres of the unsubscribing user.

• _unsubTempl :: HasApiRoot m => Address -> m Html

  The page notifying you of sucessful unsubscription.

Instances

HasNlTemplates (NlTemplates m) m

Defined in Network.Mail.Newsletter.Web.Templates

Methods

nlTemplates :: Lens' (NlTemplates m) (NlTemplates m)

confirmConfirmed :: Getter (NlTemplates m) (Address -> m Html)

confirmStart :: Getter (NlTemplates m) (Address -> m Html)

optInEmail :: Getter (NlTemplates m) (Address -> m (Address -> Mail))

subStartPage :: Getter (NlTemplates m) (Text -> Text -> Text -> Text -> m Html)

subStartSubmitted :: Getter (NlTemplates m) (Address -> m Html)

unsubConfirmTempl :: Getter (NlTemplates m) (Address -> m Html)

unsubTempl :: Getter (NlTemplates m) (Address -> m Html)

defTemplates :: (HasClientSessionKey k, HasApiRoot m, MonadReader k m, MonadIO m, IsElem NewsletterSubConfirmGet (ApiRoot m)) => NlTemplates m

serveNewsletter :: (HasClientSessionKey r, HasApiRoot m, HasNlTemplates r m, IsElem NewsletterUnsubGet (ApiRoot m), MonadReader r m, MonadError ServantErr m, Newsletter m, DedupSubscriptions m, HasNewsletterTimeouts r, HasAllowedOrigins r, MonadIO m) => ServerT NewsletterAPI m

module Network.Mail.Newsletter.Web.Dedup.InMem