Email Northbounder Interface Configuration

GETs (reading data)

Email Northbounder GET functions
Resource Description

/config/email-nbi

Gets full content of the configuration.

/config/email-nbi/status

Gets the status of the Email NBI (returns either true or false).

/config/email-nbi/destinations

Gets the name of all the existing destinations.

/config/email-nbi/destinations/{name}

Gets the content of the destination named {name}.

PUT (update defaults)

On a successful request, the Email NBI will be notified about the configuration change.

Email Northbounder PUT function
Resource Description

/config/email-nbi/status?enabled=(true;false)

Sets the status of the Email NBI.

POST (adding data)

POST requires form data using application/x-www-form-urlencoded as a Content-Type.

On a successful request, the Email NBI will be notified about the configuration change.

Email Northbounder POST function
Resource Description

/config/email-nbi/destinations

Adds a new or overrides an existing destination.

PUT (modifying data)

PUT requires form data using application/x-www-form-urlencoded as a Content-Type.

On a successful request, the Email NBI will be notified about the configuration change.

Email Northbounder PUT function
Resource Description

/config/email-nbi/destinations/{name}

Updates the content of the destination named {name}.

DELETE (remove data)

On a successful request, the Email NBI will be notified about the configuration change.

Email Northbounder DELETE function
Resource Description

/config/email-nbi/destinations/{name}

Updates the content of the destination named {name}.