io.quarkus.mailer.runtime.DkimSignOptionsConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-mailer Show documentation

Send emails

There is a newer version: 3.17.5

package io.quarkus.mailer.runtime;

import java.util.List;
import java.util.Optional;
import java.util.OptionalInt;
import java.util.OptionalLong;

import io.quarkus.runtime.annotations.ConfigGroup;
import io.quarkus.runtime.annotations.ConfigItem;

@ConfigGroup
public class DkimSignOptionsConfig {

    /**
     * Enables DKIM signing.
     */
    @ConfigItem(defaultValue = "false")
    public boolean enabled;

    /**
     * Configures the PKCS#8 format private key used to sign the email.
     */
    @ConfigItem
    public Optional privateKey = Optional.empty();

    /**
     * Configures the PKCS#8 format private key file path.
     */
    @ConfigItem
    public Optional privateKeyPath = Optional.empty();

    /**
     * Configures the Agent or User Identifier (AUID).
     */
    @ConfigItem
    public Optional auid = Optional.empty();

    /**
     * Configures the selector used to query the public key.
     */
    @ConfigItem
    public Optional selector = Optional.empty();

    /**
     * Configures the Signing Domain Identifier (SDID).
     */
    @ConfigItem
    public Optional sdid = Optional.empty();

    /**
     * Configures the canonicalization algorithm for signed headers.
     */
    @ConfigItem
    public Optional headerCanonAlgo = Optional.empty();

    /**
     * Configures the canonicalization algorithm for mail body.
     */
    @ConfigItem
    public Optional bodyCanonAlgo = Optional.empty();

    /**
     * Configures the body limit to sign.
     *
     * Must be greater than zero.
     */
    @ConfigItem
    public OptionalInt bodyLimit = OptionalInt.empty();

    /**
     * Configures to enable or disable signature sign timestamp.
     */
    @ConfigItem
    public Optional signatureTimestamp = Optional.empty();

    /**
     * Configures the expire time in seconds when the signature sign will be expired.
     *
     * Must be greater than zero.
     */
    @ConfigItem
    public OptionalLong expireTime = OptionalLong.empty();

    /**
     * Configures the signed headers in DKIM, separated by commas.
     *
     * The order in the list matters.
     */
    @ConfigItem
    public Optional> signedHeaders = Optional.empty();

    public enum CanonicalizationAlgorithmOption {
        SIMPLE,
        RELAXED
    }
}