Email Adapter API

Email Adapter API /email

REST API

POST	`/`	Create a new email input adapter
POST	`/default`	Create a new email input adapter with some default configurations

POST/

Create a new email input adapter.

Parameter:
body required - email adapter config JSON object that defines the parameters of the adapter (see below)
interval optional (default is 1000) - defines the time offset in milliseconds between two consecutive pulls
delete optional (default is true) - defines if the adapter should be deleted after receiving a message

Respond:
200 adapter successfully created - Id is in the body of the response

POST/default

Create a new email input adapter with some default configuration (e.g., using the default email address of SmartCom). Further details can be specified using query parameters.

Parameter (query parameters):
subject required - defines the subject of the email message
type required - defines the type of the message created by this adapter upon receiving an email
subtype required - defines the subtype of the message created by this adapter upon receiving an email
interval optional (default is 1000) - defines the time offset in milliseconds between two consecutive pulls
delete optional (default is true) - defines if the adapter should be deleted after receiving a message

Respond:
200 adapter successfully created - Id is in the body of the response

Email Adapter Configuration JSON

{
    "subject": "SmartCom Message",
    "host": "{HOST}",
    "username": "{EMAIL_ADDRESS}",
    "password": "{PASSWORD}",
    "port": "{PORT}"
    "authentication": "true",
    "type": "NEGOTIATION",
    "subtype": "RESPONSE",
    "deleteMessage": true
}