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

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

メールサーバー情報をガルーンに追加するAPIです。 ※Garoon on cybozuではPOP before SMTPによる認証を有効にすることはできません。

API名

MailAddMailServers

使用可能なガルーンのバージョン

• Garoon on cybozu
• パッケージ版 バージョン 3.5.0以降

リクエスト

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

例

<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 ～ 無制限	追加されたメールサーバー情報

例

<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	受信メールサーバーとの接続に失敗した場合

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

ガルーンに登録されたメールサーバー情報を更新するAPIです。 ※Garoon on cybozuではPOP before SMTPによる認証を有効にすることはできません。

API名

MailModifyMailServers

使用可能なガルーンのバージョン

• Garoon on cybozu
• パッケージ版 バージョン 3.5.0以降

リクエスト

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

例

<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 ～ 無制限	更新したメールサーバー情報

例

<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	受信メールサーバーとの接続に失敗した場合

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

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

API名

MailRemoveMailServers

使用可能なガルーンのバージョン

• Garoon on cybozu
• パッケージ版 バージョン 3.0.0以降

リクエスト

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

例

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

レスポンス

なし

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