メールの更新情報を取得する
取得するメールの日時をリクエストのパラメーターとして受け取り、取得したメールの更新情報をレスポンスとして返す API です。
API名
MailGetMailVersions
使用可能なGaroonのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 3.0 以降
リクエスト
パラメーター名 |
型 |
パラメーター数 |
説明 |
@start |
xsd:dateTime |
1 |
取得するメールの範囲の開始日時 |
@end |
xsd:dateTime |
0 ~ 1 |
取得するメールの範囲の終了日時 |
mail_item |
base:ItemVersionType |
0 ~ 無制限 |
メールのバージョン情報 |
folder_id/text() |
base:IDType |
0 ~ 無制限 |
対象となるフォルダーID |
例
1
2
|
<parameters start="2010-08-25T00:00:00Z">
</parameters>
|
レスポンス
例
1
2
3
4
|
<returns>
<mail_item id="1" version="1282897887" operation="add" />
<mail_item id="4" version="1282897913" operation="add" />
</returns>
|
エラー
エラー番号 |
説明 |
GRN_MAIL_24124 |
指定したフォルダーが存在しない場合 |
メールを取得する
メール ID をリクエストのパラメーターとして受け取り、メールの詳細情報をレスポンスとして返す API です。
API名
MailGetMailsById
使用可能なGaroonのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 3.1 以降
リクエスト
パラメーター名 |
型 |
パラメーター数 |
説明 |
mail_id/text() |
base:IDType |
1 ~ 無制限 |
取得するメールのID |
例
1
2
3
|
<parameters>
<mail_id xmlns="">1</mail_id>
</parameters>
|
レスポンス
例
1
2
3
4
5
6
7
8
9
10
|
<returns>
<mail xmlns:mail="http://schemas.cybozu.co.jp/mail/2008" key="1" version="1282897887"
subject="test mail subject" body="test mail test" folder_key="3"
date="2010-08-27T08:31:27Z" read="2010-08-27T08:31:27Z" size="353"
is_draft="false" is_sent="true">
<mail:from name="Administrator" address="admin@sample-mail-server" />
<mail:to address="admin@sample-mail-server" />
<mail:source id="1" size="353" />
</mail>
</returns>
|
エラー
エラー番号 |
説明 |
GRN_MAIL_24253 |
指定したメールが存在しない場合 |
メールソースをダウンロードする
ソースファイルをダウンロードするメールの ID をリクエストのパラエータとして受け取り、指定したメールのソースファイルのデータを Base64 形式でダウンロードする API です。
API名
MailSourceDownload
使用可能なGaroonのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 3.0 以降
リクエスト
パラメーター名 |
型 |
パラメーター数 |
説明 |
mail_id/text() |
base:IDType |
1 |
取得するメールのID |
例
1
2
|
<parameters mail_id="1">
</parameters>
|
レスポンス
例
1
2
3
4
5
|
<returns>
<source>
<content>RGF0ZkbWluaXN0cmF0b3IgPGFkbWluQHNoby1ho=</content>
</source>
</returns>
|
エラー
エラー番号 |
説明 |
GRN_MAIL_24253 |
指定したメールが存在しない場合 |
新着メールの件数を取得する
新着メールの件数を取得する API です。
API名
MailGetNewArrivingEmail
使用可能なGaroonのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 3.5 以降
リクエスト
なし
レスポンス
例
1
2
3
|
<returns>
<account id="10" name="user1" email="user1@sample-mail-server" new_mails="2" />
</returns>
|