Skip to content
← Public packages

@kody/agent-mail

AgentMail inboxes for agents: create/list inboxes, messages, threads, and Svix webhook ingress.

src/list-inboxes.ts

39 lines · 1.3 KB · TypeScript
import { agentMailRequest, clean } from './core.ts'

export type ListInboxesInput = {
	limit?: number
	pageToken?: string
	ascending?: boolean
}

/**
 * List AgentMail inboxes for agentmailApiKey.
 * Read-only; uses GET /v0/inboxes.
 *
 * @param input.limit - Max items to return
 * @param input.pageToken - Pagination cursor from a prior response
 * @param input.ascending - Sort ascending by created_at when true
 * @returns Inbox list payload from AgentMail
 *
 * @example
 * import listInboxes from 'kody:@kody/agent-mail/list-inboxes'
 * const { inboxes, count } = await listInboxes({ limit: 10 })
 */
export default async function listInboxes(input: ListInboxesInput = {}) {
	const query: Record<string, unknown> = {}
	if (input.limit !== undefined && input.limit !== null) query.limit = Number(input.limit)
	if (clean(input.pageToken)) query.page_token = clean(input.pageToken)
	if (input.ascending !== undefined) query.ascending = Boolean(input.ascending)

	const result = (await agentMailRequest({
		path: '/v0/inboxes',
		query,
		label: 'AgentMail list inboxes',
	})) as { inboxes?: unknown[]; count?: number; next_page_token?: string }

	return {
		count: result.count ?? (Array.isArray(result.inboxes) ? result.inboxes.length : 0),
		inboxes: Array.isArray(result.inboxes) ? result.inboxes : [],
		nextPageToken: result.next_page_token ?? null,
	}
}