set-email-notifier-configuration
Configures the settings of the Email notifier.
Synopsis
asadmin [asadmin-options] set-email-notifier-configuration [--help]
[--target target]
[--enabled={false|true}]
[--dynamic={false|true}]
[--filter={INFO|WARNING|SEVERE}]
[--jndiName sessionName]
[--recipient recipient]Description
This command can be used to configure the behaviour of the Email notifier in Payara Server.
|
This command is available as long as the Email notifier’s core module is installed in the server. This notifier’s extension is installed by default on Payara Server Enterprise. |
Options
- asadmin-options
-
Options for the
asadminutility. For information about these options, see theasadminhelp page. --help-?-
Displays the help text for the subcommand.
--target-
This option helps specify the target on which you are configuring the Email notifier. Valid values are:
server-
Applies to the default server instance. This is the default value.
- cluster_name
-
Applies to every server instance in the cluster.
- instance_name
-
Applies to a specified sever instance.
--enabled-
Defaults to
false. Enables or disables the log notifier --dynamic-
Defaults to
false. When set totrue, applies the changes without a server restart.Otherwise, a restart is required.
--filter-
Defaults to
WARNING. The notifier only responds to events at or above this level. (INFO, WARNING, SEVERE) --jndiName-
Defines the JNDI name of the mail session resource used to send email notifications.
--recipient-
The recipient’s email address that will receive the notification events.
Examples
Example 1 Enable the Email notifier and configure it using a mail session
asadmin set-email-notifier-configuration --jndiName=mail/sampleSession --recipient=notifications@example.com --enabled=true --dynamic=true