mailclient

This configuration is required when using the plugins:

  • Data_Protection

  • Subscriptions

  • Documentation

  • YAML Format

  • XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.
<configuration
>
required
<email
<senderAddress
>
optionalmax. 1
string
</senderAddress>
>
optionalmax. 1

Technical sender of the email (e.g., reports@company.net). Note: This setting can be overridden by other configurations, such as the configuration of the subscription function.

</email>
<outgoingServer
<host
>
requiredmax. 1
string

Hostname of the mail server.

</host>
<port
>
requiredmax. 1
string

Port number used to establish the connection to the mail server.

</port>
<encryption
xsd:string
NONE
TLS
STARTTLS
>
optionalmax. 1

Encryption method of the mail server.

</encryption>
<authorization
Choice: Choose only ONE of the following
<none
>
required

Login without credentials.

</none>
<plain
<user
>
required
string
</user>
<password
>
required
string
</password>
>
required

Credentials without password ecoding. Database user (username) to be used for connecting to the database, and password (password) of the database user. Environment variables, system properties, and Cadenza variables can be used.

</plain>
<login
<user
>
required
string
</user>
<password
>
required
string
</password>
>
required

Credentials with encoded password. Technical user ("username") to be used for connecting to the database, and encoded password ("password") of the technical user (see also Secrets in Configuration).

</login>
Choice End
>
requiredmax. 1

Authorization scheme of the mail server.

</authorization>
>
requiredmax. 1

Connection of the mail server.

</outgoingServer>
</configuration>
This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not.
cadenzaconfig:
  settings:
    mailclient:
      email:
        senderAddress: "text"
      outgoingServer:
        host: "text"
        port: "text"
        encryption: "NONE"
        authorization:
          none: {}
          plain:
            user: "text"
            password: "text"
          login:
            user: "text"
            password: "text"

Filename: mailclient-config.xml

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configuration>
  <email>
    <senderAddress>text</senderAddress>
  </email>
  <outgoingServer>
    <host>text</host>
    <port>text</port>
    <encryption>NONE</encryption>
    <authorization>
      <none/>
      <plain>
        <user>text</user>
        <password>text</password>
      </plain>
      <login>
        <user>text</user>
        <password>text</password>
      </login>
    </authorization>
  </outgoingServer>
</configuration>