---
title: EmailService
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-emailservice
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-emailservice.html
section_ids:
  sec-amster-entity-emailservice-realm-ops: Realm Operations
  sec-amster-entity-emailservice-realm-ops-create: create
  sec-amster-entity-emailservice-realm-ops-delete: delete
  sec-amster-entity-emailservice-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-emailservice-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-emailservice-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-emailservice-realm-ops-read: read
  sec-amster-entity-emailservice-realm-ops-update: update
  sec-amster-entity-emailservice-global-ops: Global Operations
  sec-amster-entity-emailservice-global-ops-getalltypes: getAllTypes
  sec-amster-entity-emailservice-global-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-emailservice-global-ops-nextdescendents: nextdescendents
  sec-amster-entity-emailservice-global-ops-read: read
  sec-amster-entity-emailservice-global-ops-update: update
---

# EmailService

## Realm Operations

Resource path:

```
/realm-config/services/email
```

Resource version: `0.0`

### create

**Usage**

```
am> create EmailService --realm Realm --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "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" : ""
      },
      "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" : 1100,
        "required" : false,
        "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" : 1200,
        "required" : true,
        "type" : "integer",
        "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"
      },
      "transportType" : {
        "title" : "Transport Type",
        "description" : "The mail server transport type to use by default",
        "propertyOrder" : 1300,
        "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" : ""
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete EmailService --realm Realm
```

### 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
```

### read

**Usage**

```
am> read EmailService --realm Realm
```

### update

**Usage**

```
am> update EmailService --realm Realm --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "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" : ""
      },
      "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" : 1100,
        "required" : false,
        "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" : 1200,
        "required" : true,
        "type" : "integer",
        "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"
      },
      "transportType" : {
        "title" : "Transport Type",
        "description" : "The mail server transport type to use by default",
        "propertyOrder" : 1300,
        "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" : ""
      }
    }
  }
  ```

## 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
```

### read

**Usage**

```
am> read EmailService --global
```

### update

**Usage**

```
am> update EmailService --global --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "defaults" : {
        "properties" : {
          "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" : ""
          },
          "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"
          },
          "emailRateLimitSeconds" : {
            "title" : "Email Rate Limit",
            "description" : "Specifies the minimum number of seconds which must elapse between sending emails to an individual user.",
            "propertyOrder" : 1200,
            "required" : true,
            "type" : "integer",
            "exampleValue" : ""
          },
          "transportType" : {
            "title" : "Transport Type",
            "description" : "The mail server transport type to use by default",
            "propertyOrder" : 1300,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          },
          "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" : ""
          },
          "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" : 1100,
            "required" : false,
            "type" : "string",
            "exampleValue" : ""
          }
        },
        "type" : "object",
        "title" : "Realm Defaults"
      }
    }
  }
  ```