io.vertx.kotlin.ext.mail.DKIMSignOptions.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-lang-kotlin Show documentation
There is a newer version: 5.0.0.CR1
/*
 * Copyright 2019 Red Hat, Inc.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution.
 *
 * The Eclipse Public License is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * The Apache License v2.0 is available at
 * http://www.opensource.org/licenses/apache2.0.php
 *
 * You may elect to redistribute this code under either of these licenses.
 */
package io.vertx.kotlin.ext.mail

import io.vertx.ext.mail.DKIMSignOptions
import io.vertx.ext.mail.CanonicalizationAlgorithm
import io.vertx.ext.mail.DKIMSignAlgorithm

/**
 * 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
 *
 * @param signAlgo  Sets the signing algorithm.
 * @param privateKey  Sets the PKCS#8 format private key used to sign the email.
 * @param privateKeyPath  Sets the PKCS#8 format private key file path.
 * @param signedHeaders  Sets the email signedHeaders used to sign.
 * @param sdid  Sets the Singing Domain Identifier(SDID).
 * @param selector  Sets the selector used to query the public key.
 * @param headerCanonAlgo  Sets the canonicalization algorithm for signed headers.
 * @param bodyCanonAlgo  Sets the canonicalization algorithm for mail body.
 * @param auid  Sets the Agent or User Identifier(AUID)
 * @param bodyLimit  Sets the body limit to sign.
 * @param signatureTimestamp  Sets to enable or disable signature sign timestmap. Default is disabled.
 * @param 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.
 * @param copiedHeaders  Sets the copied headers used in DKIM.
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.ext.mail.DKIMSignOptions original] using Vert.x codegen.
 */
fun dkimSignOptionsOf(
  signAlgo: DKIMSignAlgorithm? = null,
  privateKey: String? = null,
  privateKeyPath: String? = null,
  signedHeaders: Iterable? = null,
  sdid: String? = null,
  selector: String? = null,
  headerCanonAlgo: CanonicalizationAlgorithm? = null,
  bodyCanonAlgo: CanonicalizationAlgorithm? = null,
  auid: String? = null,
  bodyLimit: Int? = null,
  signatureTimestamp: Boolean? = null,
  expireTime: Long? = null,
  copiedHeaders: Iterable? = null): DKIMSignOptions = io.vertx.ext.mail.DKIMSignOptions().apply {

  if (signAlgo != null) {
    this.setSignAlgo(signAlgo)
  }
  if (privateKey != null) {
    this.setPrivateKey(privateKey)
  }
  if (privateKeyPath != null) {
    this.setPrivateKeyPath(privateKeyPath)
  }
  if (signedHeaders != null) {
    this.setSignedHeaders(signedHeaders.toList())
  }
  if (sdid != null) {
    this.setSdid(sdid)
  }
  if (selector != null) {
    this.setSelector(selector)
  }
  if (headerCanonAlgo != null) {
    this.setHeaderCanonAlgo(headerCanonAlgo)
  }
  if (bodyCanonAlgo != null) {
    this.setBodyCanonAlgo(bodyCanonAlgo)
  }
  if (auid != null) {
    this.setAuid(auid)
  }
  if (bodyLimit != null) {
    this.setBodyLimit(bodyLimit)
  }
  if (signatureTimestamp != null) {
    this.setSignatureTimestamp(signatureTimestamp)
  }
  if (expireTime != null) {
    this.setExpireTime(expireTime)
  }
  if (copiedHeaders != null) {
    this.setCopiedHeaders(copiedHeaders.toList())
  }
}