wire-api-0.1.0
Safe HaskellSafe-Inferred
LanguageGHC2021

Wire.API.Allowlists

Description

docs/reference/user/activation.md {#RefActivationAllowlist}

Email/phone whitelist.

Synopsis

Documentation

data AllowlistEmailDomains Source #

A service providing a whitelist of allowed email addresses and phone numbers

Constructors

AllowlistEmailDomains [Text] 

Instances

Instances details
FromJSON AllowlistEmailDomains Source # 
Instance details

Defined in Wire.API.Allowlists

Methods

parseJSON :: Value -> Parser AllowlistEmailDomains Source #

parseJSONList :: Value -> Parser [AllowlistEmailDomains] Source #

Generic AllowlistEmailDomains Source # 
Instance details

Defined in Wire.API.Allowlists

Associated Types

type Rep AllowlistEmailDomains :: Type -> Type #

Methods

from :: AllowlistEmailDomains -> Rep AllowlistEmailDomains x #

to :: Rep AllowlistEmailDomains x -> AllowlistEmailDomains #

Show AllowlistEmailDomains Source # 
Instance details

Defined in Wire.API.Allowlists

Methods

showsPrec :: Int -> AllowlistEmailDomains -> ShowS #

show :: AllowlistEmailDomains -> String #

showList :: [AllowlistEmailDomains] -> ShowS #

type Rep AllowlistEmailDomains Source # 
Instance details

Defined in Wire.API.Allowlists

type Rep AllowlistEmailDomains = D1 ('MetaData "AllowlistEmailDomains" "Wire.API.Allowlists" "wire-api-0.1.0-EbZS9CKNOfZ8BBy5DRJfXi" 'False) (C1 ('MetaCons "AllowlistEmailDomains" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))

verify :: Maybe AllowlistEmailDomains -> EmailAddress -> Bool Source #

Consult the whitelist settings in brig's config file and verify that the provided email address is whitelisted.