config-email-notification
Configures the notification service.
config-email-notification
[-c value | --configuration=value]
[-b value | --bootstrap-config=value]
[-e <true|false> | --enabled=<true|false>]
{-Xkey=value}
[-u value | --from=value]
[-p value | --password=value]
[-n value | --personal-name=value]
[-v <true|false> | --verify-connection=<true|false>]
Overview
Use this command to configure the email connection details for the notifications.
Options
Option | Optional or Required | Default Value | Description |
---|---|---|---|
|
Optional | configuration.xml | The path to the server configuration file. |
|
Optional | none | The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file. |
|
Optional | true | Controls the activation of email notifications, with a default setting of enabled. |
|
Required | none | Outlines the key-value properties for the email connection, such as mail.smtp.host, mail.smtp.port, mail.smtp.ssl.enable, and mail.smtp.auth, with each key value pair separated by "=". Parameters ending in [SENSITIVE] are encrypted in the configuration. This argument can be repeated to specify multiple keys. |
|
Optional | none | Defines the sender of the email, also utilized as the 'username' for authentication with the specified SMTP server. |
|
Optional | none | Sets the password for the email account used for sending notifications. |
|
Optional | none | Designates the personal name of the email sender, as it should appear in outgoing emails. |
|
Optional | true | Activates the verification of the email connection based on the provided configuration details, with verification enabled by default. |
Parent topic: Command-line reference