メールサーバーを追加、更新、または削除する

Garoon APIドキュメント

メールサーバーを追加、更新、または削除する

固定リンクがコピーされました

メールサーバーを追加する

固定リンクがコピーされました

メールサーバー情報をGaroonに追加するAPIです。
クラウド版GaroonではPOP before SMTPによる認証を有効にできません。

API名

固定リンクがコピーされました

MailAddMailServers

使用可能なGaroonのバージョン

固定リンクがコピーされました

クラウド版Garoon
パッケージ版Garoon 3.5以降

リクエスト

固定リンクがコピーされました

パラメーター名	型	パラメーター数	説明
server	mail:MailServerInfoType	1～無制限	追加するメールサーバー情報

例

1
2
3
4
5
6
7
8


<parameters>
  <server xmlns="" id="dummy" server_code="test-mail-server" server_name="test-mail-server">
    <outgoing server_name="smtp-mail-server" port_number="25">
    </outgoing>
    <incoming receive_protocol="POP3" server_name="pop3-mail-server" port_number="110">
    </incoming>
  </server>
</parameters>

レスポンス

固定リンクがコピーされました

パラメーター名	型	パラメーター数	説明
server	mail:MailServerInfoType	1～無制限	追加されたメールサーバー情報

例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


<returns>
  <server id="2" server_code="test-mail-server" server_name="test-mail-server">
    <outgoing   server_name="smtp-mail-server"
     port_number="25"
     use_ssl="false"
     smtp_auth="NONE"
     pop_before_smtp="false"
     pop_before_smtp_wait_time="0"
     timeout="10"
     xmlns="http://schemas.cybozu.co.jp/mail/2008" />
    <incoming   receive_protocol="POP3"
     server_name="pop3-mail-server"
     port_number="110"
     use_ssl="false"
     apop_auth_for_pop3="false"
     timeout="10"
     xmlns="http://schemas.cybozu.co.jp/mail/2008" />
  </server>
</returns>

エラー

固定リンクがコピーされました

エラー番号	説明
GRN_MAIL_24025	すでに存在しているサーバーコードを指定した場合
GRN_MAIL_24151	送信メールサーバーとの接続に失敗した場合
GRN_MAIL_24201	受信メールサーバーとの接続に失敗した場合

メールサーバーを更新する

固定リンクがコピーされました

Garoonに登録されたメールサーバー情報を更新するAPIです。
クラウド版GaroonではPOP before SMTPによる認証を有効にできません。

API名

固定リンクがコピーされました

MailModifyMailServers

使用可能なGaroonのバージョン

固定リンクがコピーされました

クラウド版Garoon
パッケージ版Garoon 3.5以降

リクエスト

固定リンクがコピーされました

パラメーター名	型	パラメーター数	説明
server	mail:MailServerInfoType	1～無制限	更新するメールサーバー情報

例

1
2
3
4
5
6
7
8


<parameters>
  <server xmlns="" id="2" server_code="test-mail-server" server_name="test-mail-server">
    <outgoing server_name="smtp-mail-server" port_number="25">
    </outgoing>
    <incoming receive_protocol="POP3" server_name="pop3-mail-server" port_number="110">
    </incoming>
  </server>
</parameters>

レスポンス

固定リンクがコピーされました

パラメーター名	型	パラメーター数	説明
server	mail:MailServerInfoType	1～無制限	更新したメールサーバー情報

例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21


<returns>
  <server id="2"
   server_code="test-mail-server"
   server_name="test-mail-server">
    <outgoing   server_name="smtp-mail-server"
     port_number="25"
     use_ssl="false"
     smtp_auth="NONE"
     pop_before_smtp="false"
     pop_before_smtp_wait_time="0"
     timeout="10"
     xmlns="http://schemas.cybozu.co.jp/mail/2008" />
    <incoming   receive_protocol="POP3"
     server_name="pop3-mail-server"
     port_number="110"
     use_ssl="false"
     apop_auth_for_pop3="false"
     timeout="10"
     xmlns="http://schemas.cybozu.co.jp/mail/2008" />
  </server>
</returns>

エラー

固定リンクがコピーされました

エラー番号	説明
GRN_MAIL_24151	送信メールサーバーとの接続に失敗した場合
GRN_MAIL_24201	受信メールサーバーとの接続に失敗した場合

メールサーバーを削除する

固定リンクがコピーされました

Garoonに登録されたメールサーバー情報を削除するAPIです。

API名

固定リンクがコピーされました

MailRemoveMailServers

使用可能なGaroonのバージョン

固定リンクがコピーされました

クラウド版Garoon
パッケージ版Garoon 3.0以降

リクエスト

固定リンクがコピーされました

パラメーター名	型	パラメーター数	説明
server_id	base:IDType	1～無制限	削除するメールサーバーID

例

1
2
3


<parameters>
  <server_id xmlns="">2</server_id>
</parameters>

レスポンス

固定リンクがコピーされました

なし

エラー

固定リンクがコピーされました

エラー番号	説明
GRN_MAIL_24024	指定したメールサーバーが存在しない場合

Garoon APIドキュメント