メールアカウントの更新情報を取得する
固定リンクがコピーされました
メールアカウントのIDをリクエストのパラメーターとして受け取り、メールアカウントの更新情報をレスポンスとして返すAPIです。APIを実行するユーザー以外のユーザーの更新情報は取得できません。
MailGetAccountVersions
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
例
1
2
3
|
<parameters>
<account_item xmlns="" id="1" version="1282892143"></account_item>
</parameters>
|
例
1
2
3
4
|
<returns>
<account_item id="1" version="1282895173" operation="add" />
<account_item id="2" version="1282895392" operation="add" />
</returns>
|
メールアカウントを取得する
固定リンクがコピーされました
メールアカウントIDをリクエストのパラメーターとして受け取り、メールアカウントの詳細情報をレスポンスとして返すAPIです。APIを実行するユーザー以外のユーザーのアカウントの詳細は取得できません。
MailGetAccountsById
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
パラメーター名 |
型 |
パラメーター数 |
説明 |
account_id/text() |
base:IDType |
1~ 無制限 |
詳細情報を取得するメールアカウントID |
例
1
2
3
|
<parameters>
<account_id xmlns="">1</account_id>
</parameters>
|
例
1
2
3
4
5
6
7
8
9
10
11
12
13
|
<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です。
MailCreateUserAccount
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.5以降
例
1
2
3
4
5
6
7
8
9
|
<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>
|
例
1
2
3
4
5
6
7
|
<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です。
MailEditUserAccount
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.5以降
例
1
2
3
4
5
6
7
8
9
|
<parameters>
<edit_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>
</edit_user_accounts>
</parameters>
|
例
1
2
3
4
5
6
7
|
<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を実行しメールアカウントの設定画面で、設定し直なおす必要があります。
手順の詳細は、メールアカウントを変更する(
クラウド版
|
パッケージ版
)を参照してください。
メールアカウントを削除する
固定リンクがコピーされました
メールアカウントを削除するAPIです。
MailDeleteUserAccount
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.5以降
例
1
2
3
|
<parameters></parameters>
<delete_user_accounts xmlns="" account_id="2"></delete_user_accounts>
</parameters>
|
なし
エラー番号 |
説明 |
GRN_MAIL_24104 |
指定したアカウントIDが存在しない場合 |