Class DkimSigner

constructor

• new DkimSigner(
      key: DkimPrivateKeySource,
      domain: string,
      selector: string,
      algorithm?: DkimSignatureAlgorithm,
  ): DkimSigner

  Initialize a new instance of the DKIM signer.

  Parameters

  • key: DkimPrivateKeySource

    The private key (an AsymmetricKey, PEM string, PEM bytes, or a stream containing a PEM private key).

  • domain: string

    The domain that the signer represents.

  • selector: string

    The selector subdividing the domain.

  • algorithm: DkimSignatureAlgorithm = DkimSignatureAlgorithm.RsaSha256

    The signature algorithm.

  Returns DkimSigner

agentOrUserIdentifier

queryMethod

sign

• sign(
      options: FormatOptions,
      message: MimeMessage,
      headers: readonly string[] | readonly HeaderId[],
  ): Promise<void>

  Digitally sign the message using a DKIM signature.

  Parameters

  • options: FormatOptions
  • message: MimeMessage
  • headers: readonly string[] | readonly HeaderId[]

  Returns Promise<void>

  Throws

  A required argument is null, or the header list is invalid.

• sign(
      message: MimeMessage,
      headers: readonly string[] | readonly HeaderId[],
  ): Promise<void>

  Digitally sign the message using a DKIM signature.

  Parameters

  • message: MimeMessage
  • headers: readonly string[] | readonly HeaderId[]

  Returns Promise<void>

  Throws

  A required argument is null, or the header list is invalid.