5.5. メールの検索¶
特定のフォルダのメールを検索します。検索条件は検索キーワードとオプションで指定します。
5.5.1. 入力値¶
im_iagSearchMessage <object> *
├─ folderCd <string> *
├─ keyword <string>
├─ length <integer>
├─ offset <integer>
├─ options <object>
│ ├─ column <string>
│ ├─ from <date>
│ ├─ order <string>
│ ├─ readStatus <string>
│ ├─ searchAttachmentNames <boolean>
│ ├─ searchCcs <boolean>
│ ├─ searchContents <boolean>
│ ├─ searchCReceivedDate <boolean>
│ ├─ searchSender <boolean>
│ ├─ searchSubFolder <boolean>
│ ├─ searchTitles <boolean>
│ ├─ searchTos <boolean>
│ └─ to <date>
└─ userCd <string>
| 項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
|---|---|---|---|---|
| im_iagSearchMessage | 必須 | object | なし | |
| folderCd | 必須 | string | なし | フォルダコード |
| keyword | 任意 | string | なし | 検索キーワード。前方一致となります。 |
| length | 任意 | integer | なし | 取得件数。未指定の場合は0（全件取得）となります。 |
| offset | 任意 | integer | なし | 取得開始位置。未指定の場合は0となります。 |
| options | 任意 | object | なし | 検索オプション |
| column | 任意 | string | なし | ソートに使用するカラム
指定方法は以下の通りです。
ATTACHMENT：添付ファイル有無
PRIORITY：重要度
RE_FW：返信転送有無
TITLE：タイトル
SENT_DATE：送信日時
SENDER：送信者
SIZE：データサイズ
未指定の場合はSENT_DATEとなります。
|
| from | 任意 | date | なし | 受信日の範囲（開始） |
| order | 任意 | string | なし | ソート方向
指定方法は以下の通りです。
ASC：昇順
DESC：降順
未指定の場合はDESCとなります。
|
| readStatus | 任意 | string | なし | 未既読状況
指定方法は以下の通りです。
READ：未読のみ取得
UNREAD：既読のみ取得
BOTH：未読既読に関わらず取得
未指定の場合はBOTHとなります。
|
| searchAttachmentNames | 任意 | boolean | なし | 検索条件に添付ファイル名を含める場合:true
検索条件に添付ファイル名を含めない場合:false
未指定の場合はfalseとなります。
|
| searchCcs | 任意 | boolean | なし | 検索条件にあて先(CC)を含める場合:true
検索条件にあて先(CC)を含めない場合:false
未指定の場合はfalseとなります。
|
| searchContents | 任意 | boolean | なし | 検索条件に本文を含める場合:true
検索条件に本文を含めない場合:false
未指定の場合はfalseとなります。
|
| searchCReceivedDate | 任意 | boolean | なし | 検索条件に受信日時（送信日時）を含める場合:true
検索条件に受信日時（送信日時）を含めない場合:false
未指定の場合はfalseとなります。
|
| searchSender | 任意 | boolean | なし | 検索条件に差出人(From)を含める場合:true
検索条件に差出人(From)を含めない場合:false
未指定の場合はfalseとなります。
|
| searchSubFolders | 任意 | boolean | なし | 検索条件にサブフォルダを含める場合:true
検索条件にサブフォルダを含めない場合:false
未指定の場合はfalseとなります。
|
| searchTitles | 任意 | boolean | なし | 検索条件にサブジェクトを含める場合:true
検索条件にサブジェクトを含めない場合:false
未指定の場合はfalseとなります。
|
| searchTos | 任意 | boolean | なし | 検索条件にあて先(TO)を含める場合:true
検索条件にあて先(TO)を含めない場合:false
未指定の場合はfalseとなります。
|
| to | 任意 | date | なし | 受信日の範囲（終了） |
| userCd | 任意 | string | なし | この操作の対象ユーザコード。未設定の場合はログインユーザのユーザコードを使用します。ジョブとして実行する場合など、ログインユーザを判断できない状況で実行する場合は必ず指定してください。 |
5.5.2. 出力値¶
im_iagSearchMessage <object>
└─ searchResult <object[]>
├─ fileCount <integer>
├─ forwarded <boolean>
├─ mailId <string>
├─ mailSubId <integer>
├─ priority <string>
├─ read <boolean>
├─ recSendFlag <string>
├─ recipients <object[]>
│ ├─ addressType <string>
│ ├─ companyCd <string>
│ ├─ departmentCd <string>
│ ├─ departmentSetCd <string>
│ ├─ name <string>
│ ├─ privateGroupCd <string>
│ ├─ publicGroupCd <string>
│ ├─ publicGroupSetCd <string>
│ ├─ recipientType <string>
│ └─ userCd <string>
├─ replied <boolean>
├─ sender <object>
│ ├─ addressType <string>
│ ├─ companyCd <string>
│ ├─ departmentCd <string>
│ ├─ departmentSetCd <string>
│ ├─ name <string>
│ ├─ privateGroupCd <string>
│ ├─ publicGroupCd <string>
│ ├─ publicGroupSetCd <string>
│ ├─ recipientType <string>
│ └─ userCd <string>
├─ sentDate <date>
├─ size <long>
└─ title <string>
| 項目名 | 型 | 配列/リスト | 説明 |
|---|---|---|---|
| im_iagSearchMessage | object | なし | |
| searchResult | object[] | リスト | 検索結果 |
| fileCount | integer | なし | ファイル数 |
| forwarded | boolean | なし | 転送フラグ |
| mailId | string | なし | メールID |
| mailSubId | integer | なし | メールサブID |
| priority | string | なし | 優先度
HIGH：高
NORMAL：普通
|
| read | boolean | なし | 既読フラグ |
| recSendFlag | string | なし | 送受信区分
SAVED：下書き保存
SENT：送信済み
RECEIPT：受信済み
REMOVED：削除済み
|
| recipients | object[] | 配列 | 受信者。この情報が送信済みか下書きフォルダの一覧、及びTOの場合のみ設定されます。 |
| addressType | string | なし | アドレス種別 |
| companyCd | string | なし | 会社コード |
| departmentCd | string | なし | 組織コード |
| departmentSetCd | string | なし | 組織セットコード |
| name | string | なし | 表示名 |
| privateGroupCd | string | なし | プライベートグループコード |
| publicGroupCd | string | なし | パブリックグループコード |
| publicGroupSetCd | string | なし | パブリックグループセットコード |
| recipientType | string | なし | 送信区分(FROM/TO) |
| userCd | string | なし | ユーザコード |
| replied | boolean | なし | 返信フラグ |
| sender | object | なし | 送信者 |
| addressType | string | なし | アドレス種別 |
| companyCd | string | なし | 会社コード |
| departmentCd | string | なし | 組織コード |
| departmentSetCd | string | なし | 組織セットコード |
| name | string | なし | 表示名 |
| privateGroupCd | string | なし | プライベートグループコード |
| publicGroupCd | string | なし | パブリックグループコード |
| publicGroupSetCd | string | なし | パブリックグループセットコード |
| recipientType | string | なし | 送信区分(FROM/TO) |
| userCd | string | なし | ユーザコード |
| sentDate | date | なし | 送信日時 |
| size | long | なし | メールサイズ |
| title | string | なし | タイトル |