メールを検索する

検索対象をリクエストのパラメーターとして受け取り、メールを検索し、検索対象と一致したメールをレスポンスとして返す API です。

API名

MailSearchMails

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

クラウド版 Garoon
パッケージ版 Garoon バージョン 3.0.0以降

リクエスト

パラメーター名	型	パラメーター数	説明
@text	xsd:string	1	検索文字列
@start	xsd:dateTime	1	検索範囲の開始日時
@end	xsd:dateTime	0 ～ 1	検索範囲の終了日時
@search_all_accounts	xsd:boolean	0 ～ 1	検索対象のメールアカウント true：全て false：@account_idで指定したアカウントのみ
@account_id	base:IDType	0 ～ 1	検索対象のメールアカウント。@search_all_accountsがfalseの場合のみ指定する。
@folder_id	base:IDType	0 ～ 1	検索対象のフォルダID。@search_all_accountsがfalseの場合のみ指定する。
@search_sub_folders	xsd:boolean	0 ～ 1	子フォルダの再帰的検索 true：する false：しない
@title_search	xsd:boolean	1	タイトルを検索対象に true：含める false：含めない
@body_search	xsd:boolean	1	本文を検索対象に true：含める false：含めない
@from_search	xsd:boolean	1	送信者を検索対象に true：含める false：含めない
@to_search	xsd:boolean	1	宛先を検索対象に true：含める false：含めない
@cc_search	xsd:boolean	1	CCを検索対象に true：含める false：含めない
@bcc_search	xsd:boolean	1	BCCを検索対象に true：含める false：含めない

例

<parameters  
 text="test" search_all_accounts="false" account_id="1"  
 folder_id="2" search_sub_folders="true" title_search="true"  
 body_search="true" from_search="true" to_search="true"  
 cc_search="true" bcc_search="true"> 
</parameters>

レスポンス

パラメーター名	型	パラメーター数	説明
mail	mail:MailType	0 ～無制限	検索条件にマッチしたメール

例

<returns> 
  <mail xmlns:mail="http://schemas.cybozu.co.jp/mail/2008" key="4" version="1282897913"  
   subject="test mail subject" body="test mail content" 
   folder_key="2" date="2010-08-27T08:31:27Z" read="2010-08-27T08:37:48Z" 
   size="602" is_draft="false" is_sent="false"> 
    <mail:from name="Administrator" address="admin@sample-mail-server" /> 
    <mail:to  address="admin@sample-mail-server /> 
    <mail:source id="4" size="602" /> 
  </mail> 
</returns>

メールを検索する

API名

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

リクエスト

レスポンス

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