Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DKIMSignOptions

This represents the options used to perform DKIM Signature signing action.

See: https://tools.ietf.org/html/rfc6376

Hierarchy

  • DKIMSignOptions

Index

Constructors

Methods

Constructors

constructor

Methods

addCopiedHeader

  • Sets the copied headers used in DKIM.

    Parameters

    • copiedHeaders: string

    Returns DKIMSignOptions

addSignedHeader

  • Sets the email signedHeaders used to sign.

    Parameters

    • signedHeaders: string

    Returns DKIMSignOptions

getAuid

  • getAuid(): string

  • Sets the Agent or User Identifier(AUID)

    Returns string

getBodyCanonAlgo

  • Sets the canonicalization algorithm for mail body.

    Returns CanonicalizationAlgorithm

getBodyLimit

  • getBodyLimit(): number

  • Sets the body limit to sign.

    Returns number

getCopiedHeaders

  • getCopiedHeaders(): string[]

  • Sets the copied headers used in DKIM.

    Returns string[]

getExpireTime

  • getExpireTime(): number

  • Sets the expire time in seconds when the signature sign will be expired.

    Success call of this method indicates that the signature sign timestamp is enabled.

    Returns number

getHeaderCanonAlgo

  • Sets the canonicalization algorithm for signed headers.

    Returns CanonicalizationAlgorithm

getPrivateKey

  • getPrivateKey(): string

  • Sets the PKCS#8 format private key used to sign the email.

    Returns string

getPrivateKeyPath

  • getPrivateKeyPath(): string

  • Sets the PKCS#8 format private key file path.

    Returns string

getSdid

  • getSdid(): string

  • Sets the Singing Domain Identifier(SDID).

    Returns string

getSelector

  • getSelector(): string

  • Sets the selector used to query the public key.

    Returns string

getSignAlgo

  • Sets the signing algorithm.

    Returns DKIMSignAlgorithm

getSignedHeaders

  • getSignedHeaders(): string[]

  • Sets the email signedHeaders used to sign.

    Returns string[]

isSignatureTimestamp

  • isSignatureTimestamp(): boolean

  • Sets to enable or disable signature sign timestmap. Default is disabled.

    Returns boolean

setAuid

  • Sets the Agent or User Identifier(AUID)

    Parameters

    • auid: string

    Returns DKIMSignOptions

setBodyCanonAlgo

setBodyLimit

  • Sets the body limit to sign.

    Parameters

    • bodyLimit: number

    Returns DKIMSignOptions

setCopiedHeaders

  • Sets the copied headers used in DKIM.

    Parameters

    • copiedHeaders: string[]

    Returns DKIMSignOptions

setExpireTime

  • Sets the expire time in seconds when the signature sign will be expired.

    Success call of this method indicates that the signature sign timestamp is enabled.

    Parameters

    • expireTime: number

    Returns DKIMSignOptions

setHeaderCanonAlgo

  • Sets the canonicalization algorithm for signed headers.

    Parameters

    Returns DKIMSignOptions

setPrivateKey

  • Sets the PKCS#8 format private key used to sign the email.

    Parameters

    • privateKey: string

    Returns DKIMSignOptions

setPrivateKeyPath

  • Sets the PKCS#8 format private key file path.

    Parameters

    • privateKeyPath: string

    Returns DKIMSignOptions

setSdid

  • Sets the Singing Domain Identifier(SDID).

    Parameters

    • sdid: string

    Returns DKIMSignOptions

setSelector

  • Sets the selector used to query the public key.

    Parameters

    • selector: string

    Returns DKIMSignOptions

setSignAlgo

setSignatureTimestamp

  • Sets to enable or disable signature sign timestmap. Default is disabled.

    Parameters

    • signatureTimestamp: boolean

    Returns DKIMSignOptions

setSignedHeaders

  • Sets the email signedHeaders used to sign.

    Parameters

    • signedHeaders: string[]

    Returns DKIMSignOptions

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc