ユーザの受信箱中のメッセージスレッドの情報を返します。ユーザがread_mailboxパーミッションを許可している必要があります。
Columns
Indexable | Name | Type | Description |
---|---|---|---|
* | thread_id | int | スレッドID |
* | folder_id | int | クエリ対象のスレッドが属するフォルダのID。IDは、0(受信箱)、1(送信箱)、4(アップデート)のいずれかです。 |
subject | string | スレッドのタイトル | |
recipients | array | スレッド受信者のID | |
updated_time | int | スレッド中で最新のメッセージの作成日時 | |
parent_message_id | string | 該当スレッドの親メッセージのID。親がない場合は0を返します。parent_message_idは、スレッドIDとメッセージIDをアンダーバーで連結した物です。 | |
parent_thread_id | int | 親スレッドのID。親がない場合は0を返します。 | |
message_count | int | スレッド中のメッセージ数 | |
snippet | string | 直近のメッセージの本文を短く切ったもの | |
snippet_author | int | snippetの書き手のID | |
object_id | int | メッセージ送信元のオブジェクト。オブジェクトから送信されていない場合は0を返します。profileテーブルを使うことで、オブジェクトについての詳細を知ることができます。 | |
unread | int | メッセージが既読の場合は0です。スレッド中に未読のメッセージがある場合は、それよりも大きな値となります。 | |
viewer_id | int | 受信箱所有者のID |
Examples
ユーザの受信箱の全スレッドを取得します。
SELECT ... FROM thread WHERE folder_id = 0 LIMIT 20
'hello'という文字列を含むスレッドを検索します。
SELECT ... FROM thread WHERE CONTAINS('hello')
受信箱中の全スレッドを返します。
SELECT ... FROM thread WHERE folder_id = 0 AND unread != 0
Usage Notes
- 受信箱の検索には、今のところ、オブジェクトによって送信されたメッセージは含まれません。
- 始めるにあたり、read_mailboxパーミッションを取得してInbox APIにアクセスし、アプリケーションを開発/テストできます。アプリケーションを全ユーザに公開する時には、こちらからInbox APIのホワイトリストに申請してください。