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

署名を取得する

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

API名

MailGetSignatures

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

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

リクエスト

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

例

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

レスポンス

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

例

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

振り分け設定を取得する

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

API名

MailGetFilters

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

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

リクエスト

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

例

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

レスポンス

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

例

<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 on cybozu.com
• パッケージ版 バージョン 3.0.0以降

リクエスト

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

例

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

レスポンス

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

例

<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 on cybozu.com
• パッケージ版 バージョン 3.0.0以降

リクエスト

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

例

<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	設定した個人設定情報

例

<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>