Config smtp servers endpoint RFC

From Koha Wiki

Jump to: navigation, search
Home
Koha > Technical > Development > RFCs

Actions and routes

The following table presents the proposed implementation. Work is done on Bug 22343

Description Action Proposed
List SMTP servers
 GET
 /config/smtp_servers
Add an SMTP server
 POST
 /config/smtp_servers
Get an SMTP server
 GET
 /config/smtp_servers/{smtp_server_id}
Overwrite an SMTP server
 PUT
 /config/smtp_servers/{smtp_server_id}
Delete an SMTP server
 DELETE
 /config/smtp_servers/{smtp_server_id}
Partially update an SMTP server
 PATCH
 /config/smtp_servers/{smtp_server_id}

Object definition

DB schema API Description
id smtp_server_id Internal smtp server identifier
name name Name of the SMTP server
library_id library_id Internal identifier for the library the SMTP server is defined for
host host The SMTP host name
port port The SMTP port
timeout timeout Configured timeout (in seconds) for SMTP connections
ssl ssl If SSL/TLS should be used (boolean)
user_name user_name User name for login
password password Password to be used for login
Personal tools