Class MailingListService

constructor

• new MailingListService(
      emailService: EmailServiceInterface,
      assetService: AssetServiceInterface,
      mailingListSubscriptionConfirmationTokenExpiresInMs: number,
      mailingListRepository: Repository<MailingList>,
      subscriberRepository: Repository<
          MailingListSubscriber,
          MailingListSubscriberCreateData,
      >,
      confirmationTokenRepository: Repository<
          MailingListSubscriptionConfirmationToken,
          MailingListSubscriptionConfirmationTokenCreateData,
      >,
      MailingListSubscribeConfirmationEmail: MailingListSubscribeConfirmationEmailTemplate,
      MailingListBaseEmail: MailingListBaseEmailTemplate,
  ): MailingListService

  Parameters

  • emailService: EmailServiceInterface
  • assetService: AssetServiceInterface
  • mailingListSubscriptionConfirmationTokenExpiresInMs: number
  • mailingListRepository: Repository<MailingList>
  • subscriberRepository: Repository<MailingListSubscriber, MailingListSubscriberCreateData>
  • confirmationTokenRepository: Repository<
        MailingListSubscriptionConfirmationToken,
        MailingListSubscriptionConfirmationTokenCreateData,
    >
  • MailingListSubscribeConfirmationEmail: MailingListSubscribeConfirmationEmailTemplate
  • MailingListBaseEmail: MailingListBaseEmailTemplate

  Returns MailingListService

ReadonlymailingListBaseRoute

confirmSubscribeToList

• confirmSubscribeToList(
      confirmationTokenValue: string,
  ): Promise<MailingListSubscriber>

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

  Parameters

  • confirmationTokenValue: string

  Returns Promise<MailingListSubscriber>

getManagePreferencesLink

• getManagePreferencesLink(subscriberId: string): string

  Gets the link to the manage preferences page for the subscriber with the given id.

  Parameters

  • subscriberId: string

  Returns string

getSubscribeConfirmationLink

• getSubscribeConfirmationLink(listId: string, confirmationToken: string): string

  Gets the subscribe confirmation link for the list with the given id and the confirmationToken.

  Parameters

  • listId: string
  • confirmationToken: string

  Returns string

getUnsubscribeLink

• getUnsubscribeLink(listId: string, subscriberId: string): string

  Gets the unsubscribe link for the list with the given id and the subscriber with the given id.

  Parameters

  • listId: string
  • subscriberId: string

  Returns string

onAppInit

• onAppInit(): void

  Runs when the app initializes.

  Returns void

queueEmailForList

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

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

  Type Parameters

  • T

  Parameters

  • listId: string
  • data: MailingListQueueEmailData<T>

  Returns Promise<void>

requestSubscribeToList

• requestSubscribeToList<T>(
      listId: string,
      subscriber: MailingListSubscriberCreateData,
      emailData: OmitStrict<MailingListQueueEmailData<T>, "template" | "compile">,
  ): 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

  Parameters

  • listId: string
  • subscriber: MailingListSubscriberCreateData
  • emailData: OmitStrict<MailingListQueueEmailData<T>, "template" | "compile">

  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>