SMTP Connections API

SMTP Connections API#

Before you start, make sure that the igz_mgmt package is installed and that you are logged in to the system with the igz_mgmt.Client API. If not, see Control plane API.

import igz_mgmt

client = igz_mgmt.Client(access_key="some-access-id")

Note: To access the SMTP connection, you must provide the user’s access key with the IT Admin policy.

For more information, refer to the predefined management policies

List SMTP connection#

smtp_connections = igz_mgmt.SmtpConnection.list(client)

Get SMTP connection by ID#

smtp_connection = igz_mgmt.SmtpConnection.get(client, "99999999-1234-5555-1234-999999999999")

Update SMTP connection#

smtp_connection = igz_mgmt.SmtpConnection.get(client, "99999999-1234-5555-1234-999999999999")
smtp_connection.sender_address = "smtp.gmail.com"
smtp_connection.update(client)
Contents