Skip to main content

Function: createSuppressionList()

createSuppressionList(__namedParameters): object

Defined in: suppression.ts:105

The rules of the suppression list, over a store you provide.

Parameters​

ParameterType
__namedParametersSuppressionListOptions

Returns​

assertCanResubscribe​

assertCanResubscribe: (args) => Promise<void>

Throws ResubscribeRefusedError unless the address is free or only manually suppressed.

Parameters​

ParameterType
args{ email: string; scope: string; }
args.emailstring
args.scopestring

Returns​

Promise<void>

find​

find: (__namedParameters) => Promise<Suppression | null>

The suppression that decides for this sender: the recipient's own over the sender's checkbox.

Parameters​

ParameterType
__namedParameters{ email: string; scope: string; }
__namedParameters.emailstring
__namedParameters.scopestring

Returns​

Promise<Suppression | null>

isSuppressed​

isSuppressed: (args) => Promise<boolean>

Parameters​

ParameterType
args{ email: string; scope: string; }
args.emailstring
args.scopestring

Returns​

Promise<boolean>

resubscribe​

resubscribe: (__namedParameters) => Promise<void>

Undoes the sender's own (manual) opt-out. Refused for any other reason.

Parameters​

ParameterType
__namedParameters{ email: string; scope: string; }
__namedParameters.emailstring
__namedParameters.scopestring

Returns​

Promise<void>

suppress​

suppress: (__namedParameters) => Promise<boolean>

Stops marketing to the address for one sender, or for every sender with scope: null. Suppressing again keeps the stronger reason. Returns whether anything changed.

Parameters​

ParameterType
__namedParameters{ detail?: string | null; email: string; reason: SuppressionReason; scope: string | null; }
__namedParameters.detail?string | null
__namedParameters.emailstring
__namedParameters.reasonSuppressionReason
__namedParameters.scopestring | null

Returns​

Promise<boolean>

Example​

const suppressions = createSuppressionList({ store });
await suppressions.suppress({ scope: 'company-1', email, reason: 'manual' });
await suppressions.isSuppressed({ scope: 'company-1', email }); // true
await suppressions.resubscribe({ scope: 'company-1', email }); // allowed: it was manual