Skip to main content

Function: createUnsubscribeToken()

createUnsubscribeToken(__namedParameters): string

Defined in: unsubscribe.ts:16

The token in an unsubscribe link: which sender (scope, e.g. a company id) the recipient leaves and which address, signed with HMAC-SHA256 so nobody can unsubscribe someone else by editing the link. It never expires: an opt-out must keep working from an old e-mail.

Format: <scope>.<base64url(email)>.<base64url(signature)>. scope must not contain a dot.

Parameters​

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

Returns​

string