MailProvider
Defined in: src/provider/types.ts:34
Deliberately thin: one page, one batch. Iteration, batching, retry, and resumability live in shared machinery (paging.ts / batching.ts), so adapters only encode transport quirks.
THE NEVER-DELETE GUARANTEE: this interface has no delete/destroy methods and never will. archive() is the only sanctioned “removal” — it drops the Inbox label and keeps every other label. The worst any bug can do is mislabel or archive mail, never lose it.
Extended by
Section titled “Extended by”Properties
Section titled “Properties”
readonlycaps:ProviderCapabilities
Defined in: src/provider/types.ts:36
readonlykind:"jmap"|"mcp"|"memory"
Defined in: src/provider/types.ts:35
Methods
Section titled “Methods”addLabels()
Section titled “addLabels()”addLabels(
emailIds,labelNames):Promise<void>
Defined in: src/provider/types.ts:51
One batch (caller chunks to <= caps.maxPageSize). Labels by name/path.
Parameters
Section titled “Parameters”emailIds
Section titled “emailIds”string[]
labelNames
Section titled “labelNames”string[]
Returns
Section titled “Returns”Promise<void>
archive()
Section titled “archive()”archive(
emailIds):Promise<void>
Defined in: src/provider/types.ts:53
Remove from Inbox, keep all other labels. Never removeLabels: ['Inbox'].
Parameters
Section titled “Parameters”emailIds
Section titled “emailIds”string[]
Returns
Section titled “Returns”Promise<void>
connect()
Section titled “connect()”connect():
Promise<void>
Defined in: src/provider/types.ts:39
JMAP: session discovery; MCP: initialize handshake. Idempotent.
Returns
Section titled “Returns”Promise<void>
ensureLabels()
Section titled “ensureLabels()”ensureLabels(
names):Promise<Map<string,Label>>
Defined in: src/provider/types.ts:46
Idempotent bulk create of missing labels (names may be ‘Parent/Child’ paths). JMAP: single Mailbox/set with client ids c0,c1,… and modal-parent inference for bare names. Returns name -> Label for every requested name.
Parameters
Section titled “Parameters”string[]
Returns
Section titled “Returns”Promise<Map<string, Label>>
getEmail()
Section titled “getEmail()”getEmail(
id):Promise<EmailMeta>
Defined in: src/provider/types.ts:49
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<EmailMeta>
listLabels()
Section titled “listLabels()”listLabels():
Promise<Label[]>
Defined in: src/provider/types.ts:40
Returns
Section titled “Returns”Promise<Label[]>
searchEmails()
Section titled “searchEmails()”searchEmails(
query,page):Promise<SearchPage>
Defined in: src/provider/types.ts:48
One page. Adapters normalize array-vs-{items} response shapes.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<SearchPage>