Class MailingListService

constructor

• new MailingListService(): MailingListService

  Returns MailingListService

ReadonlymailingListBaseRoute

attachTo

• attachTo(): void

  Attaches the service to the Zibri application.

  Returns void

confirmSubscribeToList

• confirmSubscribeToList(confirmationTokenValue: string): Promise<void>

  Confirms that a new subscriber is added to the mailing list.

  Parameters

  • confirmationTokenValue: string

  Returns Promise<void>

queueEmailForList

• queueEmailForList<T extends BaseMailingListEmailTemplateData>(
      listId: string,
      data: MailingListQueueEmailData<T>,
  ): Promise<void>

  Queues a new email for the mailing list with the provided id.

  Type Parameters

  • T extends BaseMailingListEmailTemplateData

  Parameters

  • listId: string
  • data: MailingListQueueEmailData<T>

  Returns Promise<void>

requestSubscribeToList

• requestSubscribeToList<T extends BaseMailingListEmailTemplateData>(
      listId: string,
      subscriber: MailingListSubscriberCreateData,
      emailData: MailingListQueueEmailData<T>,
  ): Promise<void>

  Requests for a new subscriber to the be added to the mailing list with the provided id. This should initialize a two step process required by the GDPR.

  Type Parameters

  • T extends BaseMailingListEmailTemplateData

  Parameters

  • listId: string
  • subscriber: MailingListSubscriberCreateData
  • emailData: MailingListQueueEmailData<T>

  Returns Promise<void>

unsubscribeFromList

• unsubscribeFromList(listId: string, subscriberId: string): Promise<void>

  Removes a subscriber with the given id from the mailing list with the provided id.

  Parameters

  • listId: string
  • subscriberId: string

  Returns Promise<void>