Cloud Storage Gateway V1.1.0 リファレンスガイド

1.2.7 メールサーバ

1.2.7.1 GET /v1/mail/server

機能

メールサーバ設定表示

処理概要

メールサーバの設定情報を表示します。

パラメーター

パラメーター名	説明	指定	形式	タイプ
token	認証トークン	必須	string	query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

• 200

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

• データを格納するキー名: mail_server

• 単一のオブジェクトを返却

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード	キー	説明	表示	形式	列挙型定数
200	port	SMTPサーバのポート番号	Yes	integer
	server_address	SMTPサーバのアドレス	Yes	string
	auth_method	SMTPサーバに接続するための認証方式	Yes	enum	none: 認証を使用せずにSMTPサーバに接続する。 cram-md5: AUTH SMTP 認証を使用してSMTPサーバに接続し、認証方式にCRAM-MD5を使用する。 plain: AUTH SMTP 認証を使用してSMTPサーバに接続し、認証方式にplainを使用する。 login: AUTH SMTP 認証を使用してSMTPサーバに接続し、認証方式にloginを使用する。
	user_name	SMTPサーバに接続するためのユーザーアカウント名	Yes	string
	from_address	システムから送信する電子メールの発信者フィールドの内容	Yes	string

1.2.7.2 PUT /v1/mail/server

機能

メールサーバ設定

処理概要

メールサーバの設定をします。

メールサーバを新規設定する場合は、“token”、“server_address”、“from_address”、“auth_method”パラメーターの指定が必須です。

メールサーバの設定を削除する場合は、“token”、“server_address”、“from_address”パラメーターのみ指定します。このとき、“server_address”と“from_address”パラメーターには空文字列("")を指定する必要があります。

実行ユーザーが“Monitor”ロールの場合は、実行できません。

パラメーター

パラメーター名	説明	指定	形式	タイプ
token	認証トークン	必須	string	query
port	SMTPサーバのポート番号を指定します。 新規設定時に本パラメーターを省略した場合は初期値25が使用されます。 範囲: 1～65535 初期値: 25 [例] 586	任意	integer	query
server_address	SMTPサーバのアドレスを指定します。SMTPサーバのアドレスは最大64 文字でIPv4形式またはFQDN形式で指定します。 最大文字数: 64 [例] smtp.example.com	任意	string	query
auth_method	SMTPサーバに接続するための認証方式を指定します。 選択: [none | cram-md5 | plain | login] [例] none	任意	enum	query
user_name	SMTPサーバに接続するためのユーザーアカウント名を指定します。 文字数: 1～255 認証方式に“none”以外を選択した場合は、本パラメーターの指定が必須です。 [例] user01	任意	string	query
user_pass	SMTPサーバに接続するためのユーザーアカウントのパスワードを指定します。 - 文字数: 1～64 認証方式に“none”以外を選択した場合は、本パラメーターの指定が必須です。 [例] password	任意	string	query
from_address	システムから送信する電子メールの発信者フィールドの内容を指定します。 文字数: 1～63 [例] [e-mail]	任意	string	query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

• 200

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

• データを格納するキー名: mail_server

• 以下の値のうち、パラメーターとして指定された値を単一のオブジェクトとして返却

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード	キー	説明	形式	列挙型定数
200	port	SMTPサーバのポート番号	string
	server_address	SMTPサーバのアドレス	string
	auth_method	SMTPサーバに接続するための認証方式	enum	none: 認証を使用せずにSMTPサーバに接続する。 cram-md5: AUTH SMTP 認証を使用してSMTPサーバに接続し、認証方式にCRAM-MD5を使用する。 plain: AUTH SMTP 認証を使用してSMTPサーバに接続し、認証方式にplainを使用する。 login: AUTH SMTP 認証を使用してSMTPサーバに接続し、認証方式にloginを使用する。
	user_name	SMTPサーバに接続するためのユーザーアカウント名	string
	from_address	システムから送信する電子メールの発信者フィールドの内容	string