14.1.1.23. SMTP server endpoints

This endpoint is used to create, update, list and delete SMTP server definitions. SMTP server definitions can be used for several purposes like EMail-Token, SMS Token with SMTP gateway, notification like PIN handler and registration.

The code of this module is tested in tests/test_api_smtpserver.py

POST /smtpserver/(identifier)

This call creates or updates an SMTP server definition.

Parameters:

  • identifier – The unique name of the SMTP server definition

  • server – The FQDN or IP of the mail server

  • port – The port of the mail server

  • username – The mail username for authentication at the SMTP server

  • password – The password for authentication at the SMTP server

  • tls – If the server should do TLS

  • description – A description for the definition

GET /smtpserver/

This call gets the list of SMTP server definitions

DELETE /smtpserver/(identifier)

This call deletes the specified SMTP server configuration

Parameters:

  • identifier – The unique name of the SMTP server definition

POST /smtpserver/send_test_email

Test the email configuration :return: