ADM-001-13 pworld_archive_mail_list

← EP-一覧 · 共通前提

概要

メール一覧を、ページ番号・件名検索・受信日範囲で取得する（一覧専用。ジョブ集計は含まない）。

POST パラメータ

フィールド	必須	説明
mail_list_page	任意	1 以上の整数（不正時は 1）
mail_list_subject_search	任意	件名検索（最大長はリポジトリ定数）
mail_list_date_from / mail_list_date_to	任意	Y-m-d

日付・範囲が不正なときはエラー（PWORLD_ARCHIVE_MAIL_LIST_FILTER_DATE_INVALID 等）。

メール一覧のページングと recent の件数

• 1 ページあたり件数（mail_list_per_page）
  レスポンスに含まれる。値はサーバー側定数 PworldArchiveAdminPage::MAIL_LIST_PER_PAGE（20）であり、クライアントがリクエストで指定する項目はない（現状、画面から任意の件数を渡して変更する API はない）。
• recent（一覧行）の要素数
  現在の mail_list_page に対応する行が入る。要素数は 最大 mail_list_per_page 件で、最終ページでは総件数の都合により それ未満になる場合がある。表示範囲は mail_list_showing_from / mail_list_showing_to でも確認できる。

pworld_mail_archiveテーブルからデータ取得

カラム名	where	検索値
subject	○	mail_list_subject_search
received_date	○	mail_list_date_from, mail_list_date_to
created_at

成功時 data

ADM-001-2 のジョブ完了時一覧ペイロードにおける recent / mail_list_* と同一キー（一覧専用エンドポイントのため、ジョブ集計キーは含まない）。

論理名	物理名	型
一覧行データ	recent	object の配列
一覧総件数	mail_list_total	int
一覧ページ番号	mail_list_page	int
1 ページあたり件数	mail_list_per_page	int（20）
一覧総ページ数	mail_list_total_pages	int
表示範囲（開始）	mail_list_showing_from	int
表示範囲（終了）	mail_list_showing_to	int
フィルタ有効	mail_list_filter_active	bool
件名検索（エコー）	mail_list_subject_search	string
受信日 From（エコー）	mail_list_date_from	string
受信日 To（エコー）	mail_list_date_to	string