# Email

## Return list of recipients

> \*\*API Key Scope\*\*: recipients / index

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"email_recipients_index":{"description":"List of recipient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_recipient_collection"}}}}},"schemas":{"email_recipient_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"recipients":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/email_recipient"}}}},"email_recipient":{"type":"object","properties":{"email_id":{"type":"string"},"activation":{"type":"integer"},"email_address":{"type":"string"},"severity_low":{"type":"integer"},"severity_high":{"type":"integer"}}}}},"paths":{"/email/recipients":{"get":{"operationId":"index_recipients","summary":"Return list of recipients","description":"**API Key Scope**: recipients / index","tags":["email"],"responses":{"200":{"$ref":"#/components/responses/email_recipients_index"}}}}}}
```

## Creates a new recipient.

> \*\*API Key Scope\*\*: recipients / create

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"email_recipients_show":{"description":"A specific recipient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_recipient"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"email_recipient":{"type":"object","properties":{"email_id":{"type":"string"},"activation":{"type":"integer"},"email_address":{"type":"string"},"severity_low":{"type":"integer"},"severity_high":{"type":"integer"}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}},"requestBodies":{"email_recipient_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_recipient"}}},"required":true}}},"paths":{"/email/recipients":{"post":{"summary":"Creates a new recipient.","operationId":"create_recipient","description":"**API Key Scope**: recipients / create","tags":["email"],"responses":{"201":{"$ref":"#/components/responses/email_recipients_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/email_recipient_body"}}}}}
```

## Displays a specific recipient.

> \*\*API Key Scope\*\*: recipients / show

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"email_recipients_show":{"description":"A specific recipient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_recipient"}}}}},"schemas":{"email_recipient":{"type":"object","properties":{"email_id":{"type":"string"},"activation":{"type":"integer"},"email_address":{"type":"string"},"severity_low":{"type":"integer"},"severity_high":{"type":"integer"}}}}},"paths":{"/email/recipients/{email_id}":{"get":{"summary":"Displays a specific recipient.","operationId":"show_recipient","description":"**API Key Scope**: recipients / show","tags":["email"],"responses":{"200":{"$ref":"#/components/responses/email_recipients_show"}}}}}}
```

## Updates a specific recipient with his relations.

> \*\*API Key Scope\*\*: recipients / update

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"email_recipients_show":{"description":"A specific recipient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_recipient"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"email_recipient":{"type":"object","properties":{"email_id":{"type":"string"},"activation":{"type":"integer"},"email_address":{"type":"string"},"severity_low":{"type":"integer"},"severity_high":{"type":"integer"}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}},"requestBodies":{"email_recipient_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_recipient"}}},"required":true}}},"paths":{"/email/recipients/{email_id}":{"put":{"summary":"Updates a specific recipient with his relations.","operationId":"update_recipient","description":"**API Key Scope**: recipients / update","tags":["email"],"responses":{"200":{"$ref":"#/components/responses/email_recipients_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/email_recipient_body"}}}}}
```

## Destroys a specific recipient.

> \*\*API Key Scope\*\*: recipients / destroy

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/email/recipients/{email_id}":{"delete":{"summary":"Destroys a specific recipient.","operationId":"destroy_recipient","description":"**API Key Scope**: recipients / destroy","tags":["email"],"responses":{"204":{"description":"Recipient destroyed."}}}}}}
```

## Return relay server infos

> \*\*API Key Scope\*\*: relay\_server / show

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"email_relay_server_show":{"description":"relay server infos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_relay_server"}}}}},"schemas":{"email_relay_server":{"type":"object","properties":{"server":{"type":"string"},"sender":{"type":"string"},"user":{"type":"string"},"password":{"type":"string"}}}}},"paths":{"/email/relay_server":{"get":{"operationId":"show_relay_server","summary":"Return relay server infos","description":"**API Key Scope**: relay_server / show","tags":["email"],"responses":{"200":{"$ref":"#/components/responses/email_relay_server_show"}}}}}}
```

## Updates relay server infos.

> \*\*API Key Scope\*\*: relay\_server / update

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"email_relay_server_show":{"description":"relay server infos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_relay_server"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"email_relay_server":{"type":"object","properties":{"server":{"type":"string"},"sender":{"type":"string"},"user":{"type":"string"},"password":{"type":"string"}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}},"requestBodies":{"email_relay_server_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email_relay_server"}}},"required":true}}},"paths":{"/email/relay_server":{"put":{"summary":"Updates relay server infos.","operationId":"update_relay_server","description":"**API Key Scope**: relay_server / update","tags":["email"],"responses":{"200":{"$ref":"#/components/responses/email_relay_server_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/email_relay_server_body"}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.nodeum.io/data-archiving/api-developers/api-reference-nodeum-data-archiving/email.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.