邮件服务器配置 API

邮件服务器API 允许用户在Applications Manager中查看邮件服务器详细信息和配置邮件服务器参数。这些API允许管理员用户将邮件服务器配置为在发生告警时将电子邮件发送给指定的人。该API旨在支持GET和POST请求。

  • GET Request- 查看/列出邮件服务器详细信息。
  • POST请求 -添加或更新邮件服务器详细信息。

GET请求

每当通过GET方法发送请求时，都会列出与API对应的数据。

示例请求

http://[host]:[port]/AppManager/xml/MailServer?apikey=[apikey]

POST请求

通过POST方法发送请求时，将添加/更新相应的数据。

示例请求

http://[host]:[port]/AppManager/xml/MailServer?apikey=[apikey]

请求参数

API请求中涉及的参数如下所述：

对于主服务器：

字段 描述
smtpServer 运行SMTP服务器的主机的服务器IP或主机名。
smtpPort SMTP端口号。
smtpEmail 该SMTP服务器中可用的电子邮件地址。
smtpUserName 认证用户名
smtpPassword 认证密码
prmTlsAuth 主Tls身份验证。该值可以为true或false。
prmSslAuth 主SSL身份验证。该值可以为true或false。

对于辅助服务器：

字段 描述
secSmtpServer 运行SMTP服务器的主机的服务器IP或主机名。
secSmtpPort SMTP端口号。
secSmtpEmail 该SMTP服务器中可用的电子邮件地址。
secSmtpUserName 认证用户名。
secSmtpPassword 认证密码。
secTlsAuth 辅助Tls身份验证。该值可以为true或false。
secSslAuth 辅助SSL身份验证。该值可以为true或false。

示例

http://app-windows:9091/AppManager/xml/MailServer?apikey=7b5fde68148fa2419bc2f1a1ab87e75

语法

对于XML响应:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/MailServer?apikey=[ API Key ]&smtpPort=[ Port ]&prmTlsAuth=true&prmSslAuth=[ True/False ]&secSslAuth=[ True/False ]&fromAdminServer=[ True/False ]&smtpUserName=[ Username]&smtpPassword=[ Password ]&secTlsAuth=[ True/False ]&smtpServer=[ Server Name ]&secSmtpPort=[ Secondary Port ]&secSmtpEmail=[ Email Address ]&secSmtpUserName=[ user Name ]&smtpEmail=[ Email Address ]&secSmtpServer=[ Secondary Server Name ]&secSmtpPassword=[ Password ]

对于JSON响应:

http://[ APM Host ]:[ APM Port ]/AppManager/json/MailServer?apikey=[ API Key ]&smtpPort=[ Port ]&prmTlsAuth=true&prmSslAuth=[ True/False ]&secSslAuth=[ True/False ]&fromAdminServer=[ True/False ]&smtpUserName=[ Username]&smtpPassword=[ Password ]&secTlsAuth=[ True/False ]&smtpServer=[ Server Name ]&secSmtpPort=[ Secondary Port ]&secSmtpEmail=[ Email Address ]&secSmtpUserName=[ user Name ]&smtpEmail=[ Email Address ]&secSmtpServer=[ Secondary Server Name ]&secSmtpPassword=[ Password ]

示例

http://app-windows:59090/AppManager/xml/MailServer?apikey=09eebdd6893db4d20e16b84dff6664f1&smtpPort=25&prmTlsAuth=true&prmSslAuth=true&secSslAuth=true&fromAdminServer=true&smtpUserName=primary&smtpPassword=f6JO6Wdbo&secTlsAuth=true&smtpServer=smtp&secSmtpPort=25&secSmtpEmail=JohnDoe@yahoo.com&secSmtpUserName=secondary&smtpEmail=JohnDoe@appmanager.com&secSmtpServer=smtp&secSmtpPassword=f6JO5sMs6n7