メールアカウントを取得、追加、更新、または削除する

フォローする

Index

メールアカウントの更新情報を取得する

メールアカウントの IDをリクエストのパラメーターとして受け取り、メールアカウントの更新情報をレスポンスとして返す API です。 API実行ユーザー以外のユーザーの更新情報を取得することはできません。

API名

MailGetAccountVersions

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

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

リクエスト

パラメーター名 パラメーター数 説明
account_item base:ItemVersionType 0 ~ 無制限 更新情報を取得するメールアカウントのIDとバージョン

<parameters> 
  <account_item xmlns="" id="1" version="1282892143"></account_item> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
account_item base:ItemVersionResultType 0 ~ 無制限 メールアカウントの更新情報

<returns> 
  <account_item id="1" version="1282895173" operation="add" /> 
  <account_item id="2" version="1282895392" operation="add" /> 
</returns>

メールアカウントを取得する

メールアカウント ID をリクエストのパラメーターとして受け取り、メールアカウントの詳細情報をレスポンスとして返す API です。 API 実行ユーザー以外のユーザーのアカウントの詳細を取得することはできません。

API名

MailGetAccountsById

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

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

リクエスト

パラメーター名 パラメーター数 説明
account_id/text() base:IDType 1 ~ 無制限 詳細情報を取得するメールアカウントID

<parameters> 
  <account_id xmlns="">1</account_id> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
account mail:AccountType 0 ~ 無制限 メールアカウントの詳細情報

<returns> 
  <account xmlns:account="http://schemas.cybozu.co.jp/mail/2008"  
   key="1" version="1282895173" server_id="1"  
   email="admin@sample-mail-server" user_id="1"  
   username="admin" password="cybozu" > 
    <account:mailbox account="1"> 
      <account:inbox key="2" subscribe="true" ></account:inbox> 
      <account:sent key="3" subscribe="true" ></account:sent> 
      <account:draft key="4" subscribe="false" ></account:draft> 
      <account:trash key="5" subscribe="false" ></account:trash> 
    </account:mailbox> 
  </account> 
</returns>

エラー

エラー番号 説明
GRN_MAIL_24104 API実行ユーザーのメールアカウントではないメールアカウントのIDを指定した場合

メールアカウントを追加する

メールアカウントを追加するAPIです。

API名

MailCreateUserAccount

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

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

リクエスト

パラメーター名 パラメーター数 説明
mail_user_accounts mail:MailUserAccountType 1 ~ 無制限 追加するアカウント情報

<parameters> 
  <mail_user_accounts xmlns=""> 
    <account_info xmlns="" account_id="dummy" user_id="1" user_acount_code="user1-account1"> 
    </account_info> 
    <mail_setting xmlns="" mail_server_id="1" email="user@test-mail-server"
     acount_name="admin" password="cybozu"> 
    </mail_setting> 
  </mail_user_accounts> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
user_accounts mail:MailUserAccountType 1 ~ 無制限 追加されたアカウント情報

<returns> 
  <user_accounts> 
    <account_info account_id="2" user_id="1" user_acount_code="user1-account1" user_account_name=""/> 
      <mail_setting mail_server_id="1" email="admin@test-mail-server" acount_name="admin"
       leave_server_mail="false" deactivate_user_account="false"/> 
  </user_accounts> 
</returns>

エラー

エラー番号 説明
GRN_MAIL_24105 すでに存在するメールアカウントコードを指定した場合

注意事項

  • 「送信メールアカウント」、「送信メールパスワード」は設定できません。
    メールサーバーにSMTP認証を設定し、「送信用のアカウントとパスワード」を「設定しない」にしている場合、SMTP認証のアカウントとパスワードとして、ユーザーアカウントの「受信メールアカウント」と「受信メールパスワード」が自動的に使用されます。

メールアカウントを更新する

メールアカウントを更新するAPIです。

API名

MailEditUserAccount

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

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

リクエスト

パラメーター名 パラメーター数 説明
edit_user_accounts mail:MailUserAccountType 1 ~ 無制限 更新するアカウント情報

<parameters> 
  <mail_user_accounts xmlns=""> 
    <account_info xmlns="" account_id="dummy" user_id="1" user_acount_code="user1-account1"> 
    </account_info> 
    <mail_setting xmlns="" mail_server_id="1" email="user@test-mail-server"
     acount_name="admin" password="cybozu"> 
    </mail_setting> 
  </mail_user_accounts> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
edit_user_accounts mail:MailUserAccountType 1 ~ 無制限 更新したアカウント情報

<returns> 
  <edit_user_accounts> 
    <account_info account_id="2" user_id="1" user_acount_code="modified-account" user_account_name=""/> 
    <mail_setting mail_server_id="1" email="admin@test-mail-server" acount_name="admin"  
     leave_server_mail="false" deactivate_user_account="false"/> 
  </edit_user_accounts> 
</returns>

エラー

エラー番号 説明
GRN_MAIL_24104 指定したアカウントIDが存在しない場合

メールアカウントを削除する

メールアカウントを削除するAPIです。

API名

MailDeleteUserAccount

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

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

リクエスト

パラメーター名 パラメーター数 説明
delete_user_accounts mail:DeleteUserAccount 1 ~ 無制限 削除するアカウント情報

<parameters> 
  <delete_user_accounts xmlns="" account_id="2"></delete_user_accounts> 
</parameters>

レスポンス

なし

エラー

エラー番号 説明
GRN_MAIL_24104 指定したアカウントIDが存在しない場合

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk