設定情報を取得または設定する

Garoon APIドキュメント

設定情報を取得または設定する

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

署名を取得する

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

署名を取得するメールアカウントIDをリクエストのパラメーターとして受け取り、署名をレスポンスとして返すAPIです。

API名

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

MailGetSignatures

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

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

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

リクエスト

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

パラメーター名	型	パラメーター数	説明
account_id/text()	base:IDType	1	署名を取得するメールアカウントID

例

1
2


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

レスポンス

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

パラメーター名	型	パラメーター数	説明
signature	mail:MailSignatureType	0 ~ 無制限	取得した署名

例

1
2
3


<returns>
  <signature account_id="1" name="test signature" content="signature-content" />
</returns>

振り分け設定を取得する

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

メールアカウントIDをリクエストのパラメーターとして受け取り、指定したメールアカウントIDで設定されている振り分け設定をレスポンスとして返すAPIです。

API名

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

MailGetFilters

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

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

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

リクエスト

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

パラメーター名	型	パラメーター数	説明
account_id/text()	base:IDType	1	振り分け設定を取得するメールアカウントID

例

1
2


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

レスポンス

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

パラメーター名	型	パラメーター数	説明
filter	mail:FilterType	0 ~ 無制限	取得した振り分け設定

例

1
2
3
4
5
6


<returns>
  <filter name="test-filter" folder="folder-modified"
   operation="AND" status="（未設定）">
    <expr target="Subject" content="cybozu" method="Including" xmlns="http://schemas.cybozu.co.jp/mail/2008" />
  </filter>
</returns>

設定情報を取得する

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

APIを実行するユーザーのメールに関するプロファイル（各種設定）を取得するAPIです。

API名

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

MailGetProfiles

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

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

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

リクエスト

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

パラメーター名	型	パラメーター数	説明
@include_system_profile	xsd:boolean	1	システム設定情報の取得 true：取得する false：取得しない

例

1
2


<parameters include_system_profile="true">
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
personal_profile	mail:MailPersonalProfileType	1	取得した個人設定情報
system_profile	mail:MailSystemProfileType	0～1	取得したシステム設定情報

例

1
2
3
4
5
6
7
8
9


<returns>
  <personal_profile show_preview="true"
   send_charset="JIS" use_trash="true"
   use_status="true" use_message_disposition_notification="true"
   reply_message_disposition_notification="ShowConfirmMessage">
    <from_name account_id="1" name="" />
    <from_name account_id="2" name="" />
  </personal_profile>
</returns>

設定情報を設定する

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

APIを実行するユーザーのメールに関する個人プロファイル（各種設定）を設定するAPIです。

API名

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

MailSetProfiles

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

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

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

リクエスト

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

パラメーター名	型	パラメーター数	説明
personal_profile	mail:MailPersonalProfileType	1	設定する個人設定情報

例

1
2
3
4
5
6
7
8
9


<parameters>
  <personal_profile xmlns=""
   show_preview="true" send_charset="JIS" use_trash="true"
   send_vcard="true" wrap="true" linewidth="70"
   use_message_disposition_notification="false"
   use_status="true" use_history="false"
   reply_message_disposition_notification="ShowConfirmMessage">
  </personal_profile>
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
personal_profile	mail:MailPersonalProfileType	1	設定した個人設定情報

例

1
2
3
4
5
6
7


<returns>
  <personal_profile show_preview="true"
   send_charset="JIS" use_trash="true"
   use_status="true" use_message_disposition_notification="false"
   reply_message_disposition_notification="ShowConfirmMessage">
  </personal_profile>
</returns>

Garoon APIドキュメント