MailServer API
MailServer APIでは、Applications Managerのメール サーバー情報を確認したり、サーバーのパラメーターを設定したりできます。アラート発生時のメール送信先も設定可能です。APIではGETとPOSTでのリクエストをサポートしています。
GETリクエスト
「GET」メソッドでリクエストを行うと、APIがサポートするデータを取得できます。
リクエスト サンプル
http://[host]:[port]/AppManager/xml/MailServer?apikey=[API_KEY]
POSTリクエスト
リクエストを「POST」メソッドで送ると、対応するデータの追加や更新が行われます。
リクエスト サンプル
http://[host]:[port]/AppManager/xml/MailServer?apikey=[API_KEY]
リクエスト パラメーター
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=[USER_NAME]&smtppassword=[PASS_WORD]&secTlsAuth=[true/false]&smtpServer=[SERVER_NAME]&secSmtpPort=[SECONDARY_PORT]&secSmtpEmail=[MAIL_ADDRESS]&secSmtpUserName=[USER_NAME]&smtpEmail=[MAIL_ADDRESS]&secSmtpServer=[SECONDARY_SERVER_NAME]&secSmtppassword=[PASS_WORD]
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=[USER_NAME]&smtppassword=[PASS_WORD]&secTlsAuth=[true/false]&smtpServer=[SERVER_NAME]&secSmtpPort=[SECONDARY_PORT]&secSmtpEmail=[MAIL_ADDRESS]&secSmtpUserName=[USER_NAME]&smtpEmail=[MAIL_ADDRESS]&secSmtpServer=[SECONDARY_SERVER_NAME]&secSmtppassword=[PASS_WORD]
例
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=[USER_NAME]econdary&smtpEmail=JohnDoe@appmanager.com&secSmtpServer=smtp&secSmtpPassword=f6JO5sMs6n7