EmailService
Realm Operations
Resource path:
/realm-config/services/email
Resource version: 1.0
create
Usage
am> create EmailService --realm Realm --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "password" : { "title" : "Mail Server Authentication Password", "description" : "Specifies the password for the SMTP user name.", "propertyOrder" : 500, "required" : true, "type" : "string", "format" : "password", "exampleValue" : "" }, "sslState" : { "title" : "Mail Server Secure Connection", "description" : "Specifies whether to connect to the SMTP mail server using SSL.", "propertyOrder" : 600, "required" : true, "type" : "string", "exampleValue" : "" }, "from" : { "title" : "Email From Address", "description" : "Specifies the address from which to send email notifications.", "propertyOrder" : 700, "required" : true, "type" : "string", "exampleValue" : "no-reply@example.com" }, "hostname" : { "title" : "Mail Server Host Name", "description" : "Specifies the fully qualified domain name of the SMTP mail server through which to send email notifications.", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "smtp.example.com" }, "emailImplClassName" : { "title" : "Email Message Implementation Class", "description" : "Specifies the class that sends email notifications, such as those sent for user registration and forgotten passwords.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "port" : { "title" : "Mail Server Host Port", "description" : "Specifies the port number for the SMTP mail server.", "propertyOrder" : 300, "required" : true, "type" : "integer", "exampleValue" : "" }, "message" : { "title" : "Email Content", "description" : "Specifies content for notification messages. If you do not set this, OpenAM includes only the confirmation URL in the mail body.", "propertyOrder" : 1000, "required" : false, "type" : "string", "exampleValue" : "" }, "subject" : { "title" : "Email Subject", "description" : "Specifies a subject for notification messages. If you do not set this, OpenAM does not set the subject for notification messages.", "propertyOrder" : 900, "required" : false, "type" : "string", "exampleValue" : "" }, "username" : { "title" : "Mail Server Authentication Username", "description" : "Specifies the user name for the SMTP mail server.", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "username" }, "emailAddressAttribute" : { "title" : "Email Attribute Name", "description" : "Specifies the profile attribute from which to retrieve the end user's email address.", "propertyOrder" : 800, "required" : true, "type" : "string", "exampleValue" : "" }, "emailRateLimitSeconds" : { "title" : "Email Rate Limit", "description" : "Specifies the minimum number of seconds which must elapse between sending emails to an individual user.", "propertyOrder" : 1100, "required" : true, "type" : "integer", "exampleValue" : "" } } }
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action EmailService --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action EmailService --realm Realm --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action EmailService --realm Realm --actionName nextdescendents
update
Usage
am> update EmailService --realm Realm --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "password" : { "title" : "Mail Server Authentication Password", "description" : "Specifies the password for the SMTP user name.", "propertyOrder" : 500, "required" : true, "type" : "string", "format" : "password", "exampleValue" : "" }, "sslState" : { "title" : "Mail Server Secure Connection", "description" : "Specifies whether to connect to the SMTP mail server using SSL.", "propertyOrder" : 600, "required" : true, "type" : "string", "exampleValue" : "" }, "from" : { "title" : "Email From Address", "description" : "Specifies the address from which to send email notifications.", "propertyOrder" : 700, "required" : true, "type" : "string", "exampleValue" : "no-reply@example.com" }, "hostname" : { "title" : "Mail Server Host Name", "description" : "Specifies the fully qualified domain name of the SMTP mail server through which to send email notifications.", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "smtp.example.com" }, "emailImplClassName" : { "title" : "Email Message Implementation Class", "description" : "Specifies the class that sends email notifications, such as those sent for user registration and forgotten passwords.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "port" : { "title" : "Mail Server Host Port", "description" : "Specifies the port number for the SMTP mail server.", "propertyOrder" : 300, "required" : true, "type" : "integer", "exampleValue" : "" }, "message" : { "title" : "Email Content", "description" : "Specifies content for notification messages. If you do not set this, OpenAM includes only the confirmation URL in the mail body.", "propertyOrder" : 1000, "required" : false, "type" : "string", "exampleValue" : "" }, "subject" : { "title" : "Email Subject", "description" : "Specifies a subject for notification messages. If you do not set this, OpenAM does not set the subject for notification messages.", "propertyOrder" : 900, "required" : false, "type" : "string", "exampleValue" : "" }, "username" : { "title" : "Mail Server Authentication Username", "description" : "Specifies the user name for the SMTP mail server.", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "username" }, "emailAddressAttribute" : { "title" : "Email Attribute Name", "description" : "Specifies the profile attribute from which to retrieve the end user's email address.", "propertyOrder" : 800, "required" : true, "type" : "string", "exampleValue" : "" }, "emailRateLimitSeconds" : { "title" : "Email Rate Limit", "description" : "Specifies the minimum number of seconds which must elapse between sending emails to an individual user.", "propertyOrder" : 1100, "required" : true, "type" : "integer", "exampleValue" : "" } } }
Global Operations
Resource path:
/global-config/services/email
Resource version: 1.0
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action EmailService --global --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action EmailService --global --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action EmailService --global --actionName nextdescendents
update
Usage
am> update EmailService --global --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "defaults" : { "properties" : { "emailAddressAttribute" : { "title" : "Email Attribute Name", "description" : "Specifies the profile attribute from which to retrieve the end user's email address.", "propertyOrder" : 800, "required" : true, "type" : "string", "exampleValue" : "" }, "emailRateLimitSeconds" : { "title" : "Email Rate Limit", "description" : "Specifies the minimum number of seconds which must elapse between sending emails to an individual user.", "propertyOrder" : 1100, "required" : true, "type" : "integer", "exampleValue" : "" }, "hostname" : { "title" : "Mail Server Host Name", "description" : "Specifies the fully qualified domain name of the SMTP mail server through which to send email notifications.", "propertyOrder" : 200, "required" : true, "type" : "string", "exampleValue" : "smtp.example.com" }, "message" : { "title" : "Email Content", "description" : "Specifies content for notification messages. If you do not set this, OpenAM includes only the confirmation URL in the mail body.", "propertyOrder" : 1000, "required" : false, "type" : "string", "exampleValue" : "" }, "password" : { "title" : "Mail Server Authentication Password", "description" : "Specifies the password for the SMTP user name.", "propertyOrder" : 500, "required" : true, "type" : "string", "format" : "password", "exampleValue" : "" }, "username" : { "title" : "Mail Server Authentication Username", "description" : "Specifies the user name for the SMTP mail server.", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "username" }, "from" : { "title" : "Email From Address", "description" : "Specifies the address from which to send email notifications.", "propertyOrder" : 700, "required" : true, "type" : "string", "exampleValue" : "no-reply@example.com" }, "sslState" : { "title" : "Mail Server Secure Connection", "description" : "Specifies whether to connect to the SMTP mail server using SSL.", "propertyOrder" : 600, "required" : true, "type" : "string", "exampleValue" : "" }, "emailImplClassName" : { "title" : "Email Message Implementation Class", "description" : "Specifies the class that sends email notifications, such as those sent for user registration and forgotten passwords.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "" }, "subject" : { "title" : "Email Subject", "description" : "Specifies a subject for notification messages. If you do not set this, OpenAM does not set the subject for notification messages.", "propertyOrder" : 900, "required" : false, "type" : "string", "exampleValue" : "" }, "port" : { "title" : "Mail Server Host Port", "description" : "Specifies the port number for the SMTP mail server.", "propertyOrder" : 300, "required" : true, "type" : "integer", "exampleValue" : "" } }, "type" : "object", "title" : "Realm Defaults" } } }