--- title: OTPEmailSender description: Resource path: component: pingam version: 7.5 page_id: pingam:entity-reference:sec-amster-entity-otpemailsender canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-otpemailsender.html llms_txt: https://docs.pingidentity.com/pingam/llms.txt docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md superseded_by: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-otpemailsender.html section_ids: sec-amster-entity-otpemailsender-realm-ops: Realm Operations sec-amster-entity-otpemailsender-realm-ops-create: create sec-amster-entity-otpemailsender-realm-ops-delete: delete sec-amster-entity-otpemailsender-realm-ops-getalltypes: getAllTypes sec-amster-entity-otpemailsender-realm-ops-getcreatabletypes: getCreatableTypes sec-amster-entity-otpemailsender-realm-ops-listoutcomes: listOutcomes sec-amster-entity-otpemailsender-realm-ops-nextdescendents: nextdescendents sec-amster-entity-otpemailsender-realm-ops-query: query sec-amster-entity-otpemailsender-realm-ops-read: read sec-amster-entity-otpemailsender-realm-ops-update: update --- # OTPEmailSender ## Realm Operations Resource path: ``` /realm-config/authentication/authenticationtrees/nodes/OneTimePasswordSmtpSenderNode ``` Resource version: `2.0` ### create **Usage** ``` am> create OTPEmailSender --realm Realm --id id --body body ``` **Parameters** * *\--id* The unique identifier for the resource. * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "properties" : { "username" : { "title" : "Mail Server Authentication Username", "description" : "The username to use when the mail server is using SMTP authentication.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "smsGatewayImplementationClass" : { "title" : "Gateway Implementation Class", "description" : "The OTP Email Sender node uses this class to send email messages.

The gateway class must implement the following interface:
com.sun.identity.authentication.modules.hotp.SMSGateway", "propertyOrder" : 2200, "type" : "string", "exampleValue" : "" }, "hostName" : { "title" : "Mail Server Host Name", "description" : "The name of the mail server OpenAM will use to send the messages.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "sslOption" : { "title" : "Mail Server Secure Connection", "description" : "This setting controls whether the authentication module communicates with the mail server using SSL/TLS.", "propertyOrder" : 2100, "type" : "string", "exampleValue" : "" }, "secretLabelIdentifier" : { "title" : "Mail Server Secret Label Identifier", "description" : "Label identifier used to create a secret label for mapping to the secret in the secret store.
AM uses this label identifier to create a specific secret label for this node. The secret label takes the form am.authentication.nodes.otp.mail.{{identifier}}.password where {{identifier}} is the value of Mail Server Secret Label Identifier. The identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. If you set a Mail Server Secret Label Identifier and AM finds a matching secret in a secret store, the Mail Server Authentication Password is ignored.", "propertyOrder" : 550, "type" : "string", "exampleValue" : "" }, "emailSubject" : { "title" : "The subject of the email", "description" : "This is the subject of the email that will be sent.", "propertyOrder" : 1300, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "hostPort" : { "title" : "Mail Server Host Port", "description" : "The port of the mail server. The default port for SMTP is 25, if using SSL the default port is 465.", "propertyOrder" : 300, "type" : "integer", "exampleValue" : "" }, "fromEmailAddress" : { "title" : "Email From Address", "description" : "Emails from the OTP Email Sender node will come from this address.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "password" : { "title" : "Mail Server Authentication Password", "description" : "The password to use when the mail server uses SMTP authentication. This property is deprecated. Use the Mail Server Secret Label Identifier instead. The password is ignored if you set a Mail Server Secret Label Identifier.", "propertyOrder" : 500, "type" : "string", "format" : "password", "exampleValue" : "" }, "emailAttribute" : { "title" : "Email Attribute Name", "description" : "This is the attribute name used by the OTP Sender to email the user.", "propertyOrder" : 1100, "type" : "string", "exampleValue" : "" }, "emailContent" : { "title" : "The content of the email", "description" : "This is the content of the email that will be sent. All occurrence of {{OTP}} will be replaced with the One Time Password.", "propertyOrder" : 1400, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" } }, "required" : [ "username", "smsGatewayImplementationClass", "hostName", "sslOption", "emailSubject", "hostPort", "fromEmailAddress", "emailAttribute", "emailContent" ] } ``` ### delete **Usage** ``` am> delete OTPEmailSender --realm Realm --id id ``` **Parameters** * *\--id* The unique identifier for the resource. ### getAllTypes Obtain the collection of all secondary configuration types related to the resource. **Usage** ``` am> action OTPEmailSender --realm Realm --actionName getAllTypes ``` ### getCreatableTypes Obtain the collection of secondary configuration types that have yet to be added to the resource. **Usage** ``` am> action OTPEmailSender --realm Realm --actionName getCreatableTypes ``` ### listOutcomes List the available outcomes for the node type. **Usage** ``` am> action OTPEmailSender --realm Realm --body body --actionName listOutcomes ``` **Parameters** * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "title" : "Some configuration of the node. This does not need to be complete against the configuration schema." } ``` ### nextdescendents Obtain the collection of secondary configuration instances that have been added to the resource. **Usage** ``` am> action OTPEmailSender --realm Realm --actionName nextdescendents ``` ### query Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter. **Usage** ``` am> query OTPEmailSender --realm Realm --filter filter ``` **Parameters** * *\--filter* A CREST formatted query filter, where "true" will query all. ### read **Usage** ``` am> read OTPEmailSender --realm Realm --id id ``` **Parameters** * *\--id* The unique identifier for the resource. ### update **Usage** ``` am> update OTPEmailSender --realm Realm --id id --body body ``` **Parameters** * *\--id* The unique identifier for the resource. * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "properties" : { "username" : { "title" : "Mail Server Authentication Username", "description" : "The username to use when the mail server is using SMTP authentication.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "smsGatewayImplementationClass" : { "title" : "Gateway Implementation Class", "description" : "The OTP Email Sender node uses this class to send email messages.

The gateway class must implement the following interface:
com.sun.identity.authentication.modules.hotp.SMSGateway", "propertyOrder" : 2200, "type" : "string", "exampleValue" : "" }, "hostName" : { "title" : "Mail Server Host Name", "description" : "The name of the mail server OpenAM will use to send the messages.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "sslOption" : { "title" : "Mail Server Secure Connection", "description" : "This setting controls whether the authentication module communicates with the mail server using SSL/TLS.", "propertyOrder" : 2100, "type" : "string", "exampleValue" : "" }, "secretLabelIdentifier" : { "title" : "Mail Server Secret Label Identifier", "description" : "Label identifier used to create a secret label for mapping to the secret in the secret store.
AM uses this label identifier to create a specific secret label for this node. The secret label takes the form am.authentication.nodes.otp.mail.{{identifier}}.password where {{identifier}} is the value of Mail Server Secret Label Identifier. The identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. If you set a Mail Server Secret Label Identifier and AM finds a matching secret in a secret store, the Mail Server Authentication Password is ignored.", "propertyOrder" : 550, "type" : "string", "exampleValue" : "" }, "emailSubject" : { "title" : "The subject of the email", "description" : "This is the subject of the email that will be sent.", "propertyOrder" : 1300, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "hostPort" : { "title" : "Mail Server Host Port", "description" : "The port of the mail server. The default port for SMTP is 25, if using SSL the default port is 465.", "propertyOrder" : 300, "type" : "integer", "exampleValue" : "" }, "fromEmailAddress" : { "title" : "Email From Address", "description" : "Emails from the OTP Email Sender node will come from this address.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "password" : { "title" : "Mail Server Authentication Password", "description" : "The password to use when the mail server uses SMTP authentication. This property is deprecated. Use the Mail Server Secret Label Identifier instead. The password is ignored if you set a Mail Server Secret Label Identifier.", "propertyOrder" : 500, "type" : "string", "format" : "password", "exampleValue" : "" }, "emailAttribute" : { "title" : "Email Attribute Name", "description" : "This is the attribute name used by the OTP Sender to email the user.", "propertyOrder" : 1100, "type" : "string", "exampleValue" : "" }, "emailContent" : { "title" : "The content of the email", "description" : "This is the content of the email that will be sent. All occurrence of {{OTP}} will be replaced with the One Time Password.", "propertyOrder" : 1400, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" } }, "required" : [ "username", "smsGatewayImplementationClass", "hostName", "sslOption", "emailSubject", "hostPort", "fromEmailAddress", "emailAttribute", "emailContent" ] } ```