Email Agents

GET email_notification_agents

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a list of all Email agents configurations in the system.

Resource URL

http://{host}/api/2.0/email_notification_agents/.format

Example Request

GET

http://44.235.52.211/api/2.0/email_notification_agents/.json

[
    {
        "EmailNotificationAgent": {
            "id": 1,
            "title": "Default",
            "from": "mcm9000",
            "host": "smtp.gmail.com",
            "port": 587,
            "ssl": "1",
            "username": "test@gmail.com",
            "password": "example",
            "recipients": "test@example.com",
            "min_email_interval": 60,
            "errors_queue_size": 100,
            "send_clear_notification": 1,
            "modified": "1611142282208",
            "created": "1611142282208"
        }
    },
    {
        "EmailNotificationAgent": {
            "id": 2,
            "title": "new_Email",
            "from": "R",
            "host": "192.168.0.120",
            "port": 514,
            "ssl": "1",
            "username": "",
            "password": "",
            "recipients": "ramya@test.com",
            "min_email_interval": 60,
            "errors_queue_size": 100,
            "send_clear_notification": 0,
            "modified": "1611142282208",
            "created": "1611142282208"
        }
    }
]

GET email_notification_agents/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Returns a single Email Notification Agent configuration data.

Resource URL

http://{host}/api/2.0/email_notification_agents/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired agent.

Example Request

GET

http://44.235.52.211/api/2.0/email_notification_agents/1/.json

{
    "EmailNotificationAgent": {
        "id": 1,
        "title": "Default",
        "from": "mcm9000",
        "host": "smtp.gmail.com",
        "port": 587,
        "ssl": "1",
        "username": "test@gmail.com",
        "password": "example",
        "recipients": "test@example.com",
        "min_email_interval": 60,
        "errors_queue_size": 100,
        "send_clear_notification": 1,
        "modified": "1618225794112",
        "created": "1618225794112"
    }
}

POST email_notification_agents

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Adds a new Email Notification Agent.

Resource URL

http://{host}/api/2.0/email_notification_agents/.format

Example Request

POST

http://44.235.52.211/api/2.0/email_notification_agents/.json

{
  "EmailNotificationAgent": { 
    "from": "mcm9000",
    "host": "smtp.gmail.com",
    "min_email_interval": 60,
    "port": 587,
    "recipients": "rec1@hostnmame.com; rec2@hostname.com",
    "title": "NEW_emailAgent",
    "ssl":"1",
    "username": "sender@gmail.com"
  }
}

POST email_notification_agents/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	POST

Copies an existing agent configuration into a new one.

Resource URL

http://{host}/api/2.0/email_notification_agents/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the agent to be copied.

Example Request

POST

http://44.235.52.211/api/2.0/email_notification_agents/1/.json

PUT email_notification_agents/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	PUT

Updates an agent configuration data.

Resource URL

http://{host}/api/2.0/email_notification_agents/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired agent to be updated.

Example Request

PUT

http://44.235.52.211/api/2.0/email_notification_agents/1/.json

DELETE email_notification_agents/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	DELETE

Deletes an existing agent and all its references.

Resource URL

http://{host}/api/2.0/email_notification_agents/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired agent to be deleted.

Example Request

DELETE

http://44.235.52.211/api/2.0/email_notification_agents/1/.json

GET email_notification_agents/command/test/{id}

Resource Information

Requires Authentication?	Yes
Response Formats	json
HTTP Methods	GET

Sends test email for an existing agent.

Resource URL

http://{host}/api/2.0/email_notification_agents/command/test/{id}/.format

Parameters

Parameter	Data Type	Description
id (required)	integer	The ID of the desired agent to send email notification.

Example Request

GET

http://44.235.52.211/api/2.0/email_notification_agents/command/test/1/.json