API

Every agentmail.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Messages

get

messages.get Retrieve the complete details of an AgentMail message Risk: read

await corsair.agentmail.api.messages.get({});

Input

Name	Type	Required	Description
`inbox_id`	`string`	Yes	—
`message_id`	`string`	Yes	—

Output

Name	Type	Required	Description
`inbox_id`	`string`	Yes	—
`thread_id`	`string`	Yes	—
`message_id`	`string`	Yes	—
`labels`	`string[]`	Yes	—
`timestamp`	`string`	Yes	—
`from`	`string`	Yes	—
`to`	`string[]`	Yes	—
`size`	`number`	Yes	—
`updated_at`	`string`	Yes	—
`created_at`	`string`	Yes	—
`cc`	`string[]`	No	—
`bcc`	`string[]`	No	—
`subject`	`string`	No	—
`preview`	`string`	No	—
`attachments`	`object[]`	No	—
`in_reply_to`	`string`	No	—
`references`	`string[]`	No	—
`headers`	`object`	No	—
`reply_to`	`string[]`	No	—
`text`	`string`	No	—
`html`	`string`	No	—
`extracted_text`	`string`	No	—
`extracted_html`	`string`	No	—

attachments full type

{
  attachment_id: string,
  size: number,
  filename?: string,
  content_type?: string,
  content_disposition?: string,
  content_id?: string
}[]

headers full type

{
}

list

messages.list List messages from an AgentMail inbox Risk: read

await corsair.agentmail.api.messages.list({});

Input

Name	Type	Required	Description
`inbox_id`	`string`	Yes	—
`limit`	`number`	No	—
`page_token`	`string`	No	—
`labels`	`string[]`	No	—
`before`	`string`	No	—
`after`	`string`	No	—
`ascending`	`boolean`	No	—
`include_spam`	`boolean`	No	—
`include_blocked`	`boolean`	No	—
`include_unauthenticated`	`boolean`	No	—
`include_trash`	`boolean`	No	—
`from`	`string[]`	No	—
`to`	`string[]`	No	—
`subject`	`string[]`	No	—

Output

Name	Type	Required	Description
`count`	`number`	Yes	—
`messages`	`object[]`	Yes	—
`limit`	`number`	Yes	—
`next_page_token`	`string`	No	—

messages full type

{
  inbox_id: string,
  thread_id: string,
  message_id: string,
  labels: string[],
  timestamp: string,
  from: string,
  to: string[],
  size: number,
  updated_at: string,
  created_at: string,
  cc?: string[],
  bcc?: string[],
  subject?: string,
  preview?: string,
  attachments?: {
    attachment_id: string,
    size: number,
    filename?: string,
    content_type?: string,
    content_disposition?: string,
    content_id?: string
  }[],
  in_reply_to?: string,
  references?: string[],
  headers?: {
  }
}[]

send

messages.send Send an email using AgentMail Risk: write

await corsair.agentmail.api.messages.send({});

Input

Name	Type	Required	Description
`inbox_id`	`string`	Yes	—
`labels`	`string[]`	No	—
`reply_to`	`string \| string[]`	No	—
`to`	`string \| string[]`	No	—
`cc`	`string \| string[]`	No	—
`bcc`	`string \| string[]`	No	—
`subject`	`string`	No	—
`text`	`string`	No	—
`html`	`string`	No	—
`headers`	`object`	No	—

headers full type

{
}

Output

Name	Type	Required	Description
`message_id`	`string`	Yes	—
`thread_id`	`string`	Yes	—

Overview

Plugins

Messages

get

list

send

​Messages

​get

​list

​send

Messages

get

list

send