vertx / io.vertx.kotlin.ext.mail / dkimSignOptionsOf

dkimSignOptionsOf

fun dkimSignOptionsOf(auid: String? = null, bodyCanonAlgo: CanonicalizationAlgorithm? = null, bodyLimit: Int? = null, copiedHeaders: Iterable<String>? = null, expireTime: Long? = null, headerCanonAlgo: CanonicalizationAlgorithm? = null, privateKey: String? = null, privateKeyPath: String? = null, sdid: String? = null, selector: String? = null, signAlgo: DKIMSignAlgorithm? = null, signatureTimestamp: Boolean? = null, signedHeaders: Iterable<String>? = null): DKIMSignOptions

A function providing a DSL for building io.vertx.ext.mail.DKIMSignOptions objects.

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

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

Parameters

auid - Sets the Agent or User Identifier(AUID)

bodyCanonAlgo - Sets the canonicalization algorithm for mail body.

bodyLimit - Sets the body limit to sign.

copiedHeaders - Sets the copied headers used in DKIM.

expireTime - 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.

headerCanonAlgo - Sets the canonicalization algorithm for signed headers.

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

privateKeyPath - Sets the PKCS#8 format private key file path.

sdid - Sets the Singing Domain Identifier(SDID).

selector - Sets the selector used to query the public key.

signAlgo - Sets the signing algorithm.

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

signedHeaders - Sets the email signedHeaders used to sign.