IM
JA
ドキュメントホーム
メニュー
ガイド

IMAP 同期メールボックスとメッセージ

IMAP 同期ジョブをキューに入れ、検索および読み取りフローのメッセージ メタデータを保持します。

inbox-manager client-flow

IMAP メールボックスとメッセージを同期する

目的: IMAP 同期ジョブをキューに入れ、検索および読み取りフローのメッセージ メタデータを保持します。

UI フロー

  1. ユーザーが認証情報とフォルダーを選択します。
  2. UI はメールボックス同期またはメッセージ同期をキューに入れます。
  3. UI はジョブ/タスクの終了状態をポーリングします。
  4. UI が更新されます /api/accounts/:account_id/emails

クライアント ライブラリ フロー

const mailboxTask = await api.provider.imap.syncMailboxes(accountId, {
  credential_id: imapCredentialId,
});
const messageTask = await api.provider.imap.syncMessages(accountId, {
  credential_id: imapCredentialId,
  folder: "INBOX",
});
await api.jobs.waitForTask(accountId, messageTask.data.task_id);
const emails = await api.emails.list(accountId, { limit: 20, offset: 0 });

HTTP/カールフロー

API_BASE_URL="https://api.inbox-manager.com"

curl -sS -X POST "${API_BASE_URL}/api/accounts/${ACCOUNT_ID}/imap/sync-mailboxes" \
  -H "authorization: Bearer ${BEARER_TOKEN}" \
  -H "content-type: application/json" \
  --data "{\"credential_id\":\"${IMAP_CREDENTIAL_ID}\"}"

curl -sS -X POST "${API_BASE_URL}/api/accounts/${ACCOUNT_ID}/imap/sync-messages" \
  -H "authorization: Bearer ${BEARER_TOKEN}" \
  -H "content-type: application/json" \
  --data "{\"credential_id\":\"${IMAP_CREDENTIAL_ID}\",\"folder\":\"INBOX\"}"

curl -sS "${API_BASE_URL}/api/accounts/${ACCOUNT_ID}/jobs?limit=20" \
  -H "authorization: Bearer ${BEARER_TOKEN}"

curl -sS "${API_BASE_URL}/api/accounts/${ACCOUNT_ID}/emails?limit=20&offset=0" \
  -H "authorization: Bearer ${BEARER_TOKEN}"

検証スクリプト

  • scripts/provider_job_flow.sh