Home > Configuration > Authentication > addauthenticationemailaction

addauthenticationemailaction

Use this method to adds an email action that is used to send email to end users.

Syntax



Parameters

name

Name for the new email action. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an action is created. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my action').
This is mandatory parameter.

username

Username/Clientid/EmailID to be used to authenticate to the server.
This is mandatory parameter.

password

Password/Clientsecret to use when authenticating to the server.
This is mandatory parameter.

serverurl

Address of the server that delivers the message. It is fully qualified fqdn such as http(s):// or smtp(s):// for http and smtp protocols respectively. For SMTP, the port number is mandatory like smtps://smtp.example.com:25.
This is mandatory parameter.

content

Content to be delivered to the user. "$code" string within the content will be replaced with the actual one-time-code to be sent.

defaultauthenticationgroup

This is the group that is added to user sessions that match current IdP policy. It can be used in policies to identify relying party trust.

type

Type of the email action. Default type is SMTP.
Default value = EMAIL_TYPE_SMTP.

emailaddress

An optional expression that yields user's email. When not configured, user's default mail address would be used. When configured, result of this expression is used as destination email address.

Return Value

Returns simpleResult

See Also