API - Corsair

Every mailtrap.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.

Account

getBillingUsage

account.getBillingUsage Get billing usage against the account’s testing/sending/marketing plan limits Risk: read

await corsair.mailtrap.api.account.getBillingUsage({});

Input: empty object Output

Name	Type	Required	Description
`billing`	`object`	No	—
`testing`	`object`	No	—
`sending`	`object`	No	—
`marketing`	`object`	No	—

billing full type

{
  cycle_start?: string | null,
  cycle_end?: string | null
}

testing full type

{
  plan?: {
    name?: string | null
  } | null,
  usage?: {
    sent_messages_count?: {
      current?: number | null,
      limit?: number | null
    } | null,
    forwarded_messages_count?: {
      current?: number | null,
      limit?: number | null
    } | null
  } | null
}

sending full type

{
  plan?: {
    name?: string | null
  } | null,
  usage?: {
    sent_messages_count?: {
      current?: number | null,
      limit?: number | null
    } | null
  } | null
}

marketing full type

{
  plan?: {
    name?: string | null
  } | null,
  usage?: {
    sent_messages_count?: {
      current?: number | null,
      limit?: number | null
    } | null
  } | null
}

getPermissionResources

account.getPermissionResources Get every resource (inboxes, projects, domains, billing, account) the token has admin access to, nested by hierarchy Risk: read

await corsair.mailtrap.api.account.getPermissionResources({});

Input: empty object Output: lazy[]

listAccounts

account.listAccounts List Mailtrap accounts the token can access Risk: read

await corsair.mailtrap.api.account.listAccounts({});

Input: empty object Output: object[]

Output full type

{
  id: number,
  name?: string | null,
  access_levels?: number[] | null
}[]

Contact Fields

create

contactFields.create Create a custom contact field Risk: write

await corsair.mailtrap.api.contactFields.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`merge_tag`	`string`	Yes	—
`data_type`	`text \| number \| boolean \| date`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`merge_tag`	`string`	No	—
`data_type`	`text \| number \| boolean \| date`	No	—
`created_at`	`number`	No	—
`updated_at`	`number`	No	—

delete

contactFields.delete Permanently delete a custom contact field, dropping its stored values off every contact [DESTRUCTIVE] Risk: destructive

await corsair.mailtrap.api.contactFields.delete({});

Input

Name	Type	Required	Description
`field_id`	`number`	Yes	—

Output: empty object

get

contactFields.get Get a custom contact field by id Risk: read

await corsair.mailtrap.api.contactFields.get({});

Input

Name	Type	Required	Description
`field_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`merge_tag`	`string`	No	—
`data_type`	`text \| number \| boolean \| date`	No	—
`created_at`	`number`	No	—
`updated_at`	`number`	No	—

list

contactFields.list List custom contact fields Risk: read

await corsair.mailtrap.api.contactFields.list({});

Input: empty object Output: object[]

Output full type

{
  id: number,
  name: string,
  merge_tag?: string | null,
  data_type?: text | number | boolean | date | null,
  created_at?: number | null,
  updated_at?: number | null
}[]

update

contactFields.update Update a custom contact field Risk: write

await corsair.mailtrap.api.contactFields.update({});

Input

Name	Type	Required	Description
`field_id`	`number`	Yes	—
`name`	`string`	No	—
`merge_tag`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`merge_tag`	`string`	No	—
`data_type`	`text \| number \| boolean \| date`	No	—
`created_at`	`number`	No	—
`updated_at`	`number`	No	—

Contact Lists

create

contactLists.create Create a contact list Risk: write

await corsair.mailtrap.api.contactLists.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—

delete

contactLists.delete Permanently delete a contact list [DESTRUCTIVE] Risk: destructive

await corsair.mailtrap.api.contactLists.delete({});

Input

Name	Type	Required	Description
`list_id`	`number`	Yes	—

Output: empty object

get

contactLists.get Get a contact list by id Risk: read

await corsair.mailtrap.api.contactLists.get({});

Input

Name	Type	Required	Description
`list_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—

list

contactLists.list List contact lists Risk: read

await corsair.mailtrap.api.contactLists.list({});

Input

Name	Type	Required	Description
`search`	`string`	No	—

Output: object[]

Output full type

{
  id: number,
  name: string
}[]

update

contactLists.update Rename a contact list Risk: write

await corsair.mailtrap.api.contactLists.update({});

Input

Name	Type	Required	Description
`list_id`	`number`	Yes	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—

Contacts

create

contacts.create Create a contact Risk: write

await corsair.mailtrap.api.contacts.create({});

Input

Name	Type	Required	Description
`email`	`string`	Yes	—
`fields`	`object`	No	—
`list_ids`	`number[]`	No	—
`unsubscribed`	`boolean`	No	—

fields full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`email`	`string`	Yes	—
`created_at`	`number`	No	—
`updated_at`	`number`	No	—
`list_ids`	`number[]`	No	—
`status`	`subscribed \| unsubscribed`	No	—
`fields`	`object`	No	—

fields full type

{
}

createEvent

contacts.createEvent Record a custom event against a contact Risk: write

await corsair.mailtrap.api.contacts.createEvent({});

Input

Name	Type	Required	Description
`identifier`	`string`	Yes	—
`name`	`string`	Yes	—
`params`	`object`	No	—

params full type

{
}

Output

Name	Type	Required	Description
`contact_id`	`string`	No	—
`contact_email`	`string`	No	—
`name`	`string`	No	—
`params`	`object`	No	—

params full type

{
}

createExport

contacts.createExport Start an async export of contacts matching a filter Risk: write

await corsair.mailtrap.api.contacts.createExport({});

Input

Name	Type	Required	Description
`filters`	`object[]`	Yes	—

filters full type

{
  name: string,
  operator: equal | not_equal | contains | not_contains | is_empty | is_not_empty,
  value: string | number | boolean | string[] | number[]
}[]

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`status`	`started \| created \| finished`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—
`url`	`string`	No	—

delete

contacts.delete Permanently delete a contact [DESTRUCTIVE] Risk: destructive

await corsair.mailtrap.api.contacts.delete({});

Input

Name	Type	Required	Description
`identifier`	`string`	Yes	—

Output: empty object

get

contacts.get Get a contact by id or email Risk: read

await corsair.mailtrap.api.contacts.get({});

Input

Name	Type	Required	Description
`identifier`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`email`	`string`	Yes	—
`created_at`	`number`	No	—
`updated_at`	`number`	No	—
`list_ids`	`number[]`	No	—
`status`	`subscribed \| unsubscribed`	No	—
`fields`	`object`	No	—

fields full type

{
}

getExport

contacts.getExport Get the status/download URL of a contact export job Risk: read

await corsair.mailtrap.api.contacts.getExport({});

Input

Name	Type	Required	Description
`export_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`status`	`started \| created \| finished`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—
`url`	`string`	No	—

getImport

contacts.getImport Get the status of a contact import job Risk: read

await corsair.mailtrap.api.contacts.getImport({});

Input

Name	Type	Required	Description
`import_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`status`	`created \| started \| finished \| failed`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—
`created_contacts_count`	`number`	No	—
`updated_contacts_count`	`number`	No	—
`contacts_over_limit_count`	`number`	No	—

import

contacts.import Bulk-import contacts, upserting by email Risk: write

await corsair.mailtrap.api.contacts.import({});

Input

Name	Type	Required	Description
`contacts`	`object[]`	Yes	—

contacts full type

{
  email: string,
  fields?: {
  },
  list_ids_included?: number[],
  list_ids_excluded?: number[]
}[]

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`status`	`created \| started \| finished \| failed`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—
`created_contacts_count`	`number`	No	—
`updated_contacts_count`	`number`	No	—
`contacts_over_limit_count`	`number`	No	—

update

contacts.update Update a contact by id or email Risk: write

await corsair.mailtrap.api.contacts.update({});

Input

Name	Type	Required	Description
`identifier`	`string`	Yes	—
`email`	`string`	No	—
`fields`	`object`	No	—
`list_ids`	`number[]`	No	—
`unsubscribed`	`boolean`	No	—
`list_ids_included`	`number[]`	No	—
`list_ids_excluded`	`number[]`	No	—

fields full type

{
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`email`	`string`	Yes	—
`created_at`	`number`	No	—
`updated_at`	`number`	No	—
`list_ids`	`number[]`	No	—
`status`	`subscribed \| unsubscribed`	No	—
`fields`	`object`	No	—

fields full type

{
}

Email Templates

create

emailTemplates.create Create an email template Risk: write

await corsair.mailtrap.api.emailTemplates.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`subject`	`string`	Yes	—
`category`	`string`	Yes	—
`body_html`	`string`	Yes	—
`body_text`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`uuid`	`string`	No	—
`name`	`string`	Yes	—
`subject`	`string`	No	—
`category`	`string`	No	—
`body_html`	`string`	No	—
`body_text`	`string`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—

delete

emailTemplates.delete Permanently delete an email template [DESTRUCTIVE] Risk: destructive

await corsair.mailtrap.api.emailTemplates.delete({});

Input

Name	Type	Required	Description
`template_id`	`number`	Yes	—

Output: empty object

get

emailTemplates.get Get an email template by id Risk: read

await corsair.mailtrap.api.emailTemplates.get({});

Input

Name	Type	Required	Description
`template_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`uuid`	`string`	No	—
`name`	`string`	Yes	—
`subject`	`string`	No	—
`category`	`string`	No	—
`body_html`	`string`	No	—
`body_text`	`string`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—

list

emailTemplates.list List email templates Risk: read

await corsair.mailtrap.api.emailTemplates.list({});

Input: empty object Output: object[]

Output full type

{
  id: number,
  uuid?: string | null,
  name: string,
  subject?: string | null,
  category?: string | null,
  body_html?: string | null,
  body_text?: string | null,
  created_at?: string | null,
  updated_at?: string | null
}[]

update

emailTemplates.update Update an email template Risk: write

await corsair.mailtrap.api.emailTemplates.update({});

Input

Name	Type	Required	Description
`template_id`	`number`	Yes	—
`name`	`string`	No	—
`subject`	`string`	No	—
`category`	`string`	No	—
`body_html`	`string`	No	—
`body_text`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`uuid`	`string`	No	—
`name`	`string`	Yes	—
`subject`	`string`	No	—
`category`	`string`	No	—
`body_html`	`string`	No	—
`body_text`	`string`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—

Inboxes

clean

inboxes.clean Delete every message in a sandbox inbox [DESTRUCTIVE] Risk: destructive

await corsair.mailtrap.api.inboxes.clean({});

Input

Name	Type	Required	Description
`inbox_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`username`	`string`	No	—
`password`	`string`	No	—
`max_size`	`number`	No	—
`status`	`string`	No	—
`email_username`	`string`	No	—
`email_username_enabled`	`boolean`	No	—
`sent_messages_count`	`number`	No	—
`forwarded_messages_count`	`number`	No	—
`used`	`boolean`	No	—
`forward_from_email_address`	`string`	No	—
`project_id`	`number`	No	—
`domain`	`string`	No	—
`pop3_domain`	`string`	No	—
`email_domain`	`string`	No	—
`api_domain`	`string`	No	—
`smtp_ports`	`number[]`	No	—
`pop3_ports`	`number[]`	No	—
`emails_count`	`number`	No	—
`emails_unread_count`	`number`	No	—
`last_message_sent_at`	`string`	No	—
`max_message_size`	`number`	No	—
`permissions`	`object`	No	—

permissions full type

{
  can_read?: boolean | null,
  can_update?: boolean | null,
  can_destroy?: boolean | null,
  can_leave?: boolean | null
}

get

inboxes.get Get an inbox’s attributes, including its SMTP credentials Risk: read

await corsair.mailtrap.api.inboxes.get({});

Input

Name	Type	Required	Description
`inbox_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`username`	`string`	No	—
`password`	`string`	No	—
`max_size`	`number`	No	—
`status`	`string`	No	—
`email_username`	`string`	No	—
`email_username_enabled`	`boolean`	No	—
`sent_messages_count`	`number`	No	—
`forwarded_messages_count`	`number`	No	—
`used`	`boolean`	No	—
`forward_from_email_address`	`string`	No	—
`project_id`	`number`	No	—
`domain`	`string`	No	—
`pop3_domain`	`string`	No	—
`email_domain`	`string`	No	—
`api_domain`	`string`	No	—
`smtp_ports`	`number[]`	No	—
`pop3_ports`	`number[]`	No	—
`emails_count`	`number`	No	—
`emails_unread_count`	`number`	No	—
`last_message_sent_at`	`string`	No	—
`max_message_size`	`number`	No	—
`permissions`	`object`	No	—

permissions full type

{
  can_read?: boolean | null,
  can_update?: boolean | null,
  can_destroy?: boolean | null,
  can_leave?: boolean | null
}

list

inboxes.list List sandbox inboxes Risk: read

await corsair.mailtrap.api.inboxes.list({});

Input: empty object Output: object[]

Output full type

{
  id: number,
  name: string,
  username?: string | null,
  password?: string | null,
  max_size?: number | null,
  status?: string | null,
  email_username?: string | null,
  email_username_enabled?: boolean | null,
  sent_messages_count?: number | null,
  forwarded_messages_count?: number | null,
  used?: boolean | null,
  forward_from_email_address?: string | null,
  project_id?: number | null,
  domain?: string | null,
  pop3_domain?: string | null,
  email_domain?: string | null,
  api_domain?: string | null,
  smtp_ports?: number[] | null,
  pop3_ports?: number[] | null,
  emails_count?: number | null,
  emails_unread_count?: number | null,
  last_message_sent_at?: string | null,
  max_message_size?: number | null,
  permissions?: {
    can_read?: boolean | null,
    can_update?: boolean | null,
    can_destroy?: boolean | null,
    can_leave?: boolean | null
  } | null
}[]

markAsRead

inboxes.markAsRead Mark every message in a sandbox inbox as read Risk: write

await corsair.mailtrap.api.inboxes.markAsRead({});

Input

Name	Type	Required	Description
`inbox_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`username`	`string`	No	—
`password`	`string`	No	—
`max_size`	`number`	No	—
`status`	`string`	No	—
`email_username`	`string`	No	—
`email_username_enabled`	`boolean`	No	—
`sent_messages_count`	`number`	No	—
`forwarded_messages_count`	`number`	No	—
`used`	`boolean`	No	—
`forward_from_email_address`	`string`	No	—
`project_id`	`number`	No	—
`domain`	`string`	No	—
`pop3_domain`	`string`	No	—
`email_domain`	`string`	No	—
`api_domain`	`string`	No	—
`smtp_ports`	`number[]`	No	—
`pop3_ports`	`number[]`	No	—
`emails_count`	`number`	No	—
`emails_unread_count`	`number`	No	—
`last_message_sent_at`	`string`	No	—
`max_message_size`	`number`	No	—
`permissions`	`object`	No	—

permissions full type

{
  can_read?: boolean | null,
  can_update?: boolean | null,
  can_destroy?: boolean | null,
  can_leave?: boolean | null
}

resetCredentials

inboxes.resetCredentials Reset an inbox’s SMTP credentials, invalidating the previous ones [DESTRUCTIVE] Risk: destructive

await corsair.mailtrap.api.inboxes.resetCredentials({});

Input

Name	Type	Required	Description
`inbox_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`username`	`string`	No	—
`password`	`string`	No	—
`max_size`	`number`	No	—
`status`	`string`	No	—
`email_username`	`string`	No	—
`email_username_enabled`	`boolean`	No	—
`sent_messages_count`	`number`	No	—
`forwarded_messages_count`	`number`	No	—
`used`	`boolean`	No	—
`forward_from_email_address`	`string`	No	—
`project_id`	`number`	No	—
`domain`	`string`	No	—
`pop3_domain`	`string`	No	—
`email_domain`	`string`	No	—
`api_domain`	`string`	No	—
`smtp_ports`	`number[]`	No	—
`pop3_ports`	`number[]`	No	—
`emails_count`	`number`	No	—
`emails_unread_count`	`number`	No	—
`last_message_sent_at`	`string`	No	—
`max_message_size`	`number`	No	—
`permissions`	`object`	No	—

permissions full type

{
  can_read?: boolean | null,
  can_update?: boolean | null,
  can_destroy?: boolean | null,
  can_leave?: boolean | null
}

update

inboxes.update Update an inbox’s name and/or email username Risk: write

await corsair.mailtrap.api.inboxes.update({});

Input

Name	Type	Required	Description
`inbox_id`	`number`	Yes	—
`name`	`string`	No	—
`email_username`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`username`	`string`	No	—
`password`	`string`	No	—
`max_size`	`number`	No	—
`status`	`string`	No	—
`email_username`	`string`	No	—
`email_username_enabled`	`boolean`	No	—
`sent_messages_count`	`number`	No	—
`forwarded_messages_count`	`number`	No	—
`used`	`boolean`	No	—
`forward_from_email_address`	`string`	No	—
`project_id`	`number`	No	—
`domain`	`string`	No	—
`pop3_domain`	`string`	No	—
`email_domain`	`string`	No	—
`api_domain`	`string`	No	—
`smtp_ports`	`number[]`	No	—
`pop3_ports`	`number[]`	No	—
`emails_count`	`number`	No	—
`emails_unread_count`	`number`	No	—
`last_message_sent_at`	`string`	No	—
`max_message_size`	`number`	No	—
`permissions`	`object`	No	—

permissions full type

{
  can_read?: boolean | null,
  can_update?: boolean | null,
  can_destroy?: boolean | null,
  can_leave?: boolean | null
}

Messages

getHtml

messages.getHtml Get the formatted HTML body of a message Risk: read

await corsair.mailtrap.api.messages.getHtml({});

Input

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

Output

Name	Type	Required	Description
`html`	`string`	Yes	—

list

messages.list List messages in a sandbox inbox Risk: read

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

Input

Name	Type	Required	Description
`inbox_id`	`number`	Yes	—
`last_id`	`number`	No	—
`page`	`number`	No	—
`search`	`string`	No	—

Output: object[]

Output full type

{
  id: number,
  inbox_id?: number | null,
  subject?: string | null,
  sent_at?: string | null,
  from_email?: string | null,
  from_name?: string | null,
  to_email?: string | null,
  to_name?: string | null,
  email_size?: number | null,
  is_read?: boolean | null,
  created_at?: string | null,
  updated_at?: string | null,
  html_body_size?: number | null,
  text_body_size?: number | null,
  human_size?: string | null,
  html_path?: string | null,
  txt_path?: string | null,
  raw_path?: string | null,
  download_path?: string | null,
  html_source_path?: string | null
}[]

Projects

delete

projects.delete Permanently delete a project and every inbox in it [DESTRUCTIVE] Risk: destructive

await corsair.mailtrap.api.projects.delete({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—

get

projects.get Get a project and its inboxes by id Risk: read

await corsair.mailtrap.api.projects.get({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`share_links`	`object`	No	—
`inboxes`	`object[]`	No	—
`permissions`	`object`	No	—

inboxes full type

{
  id: number,
  name: string,
  username?: string | null,
  password?: string | null,
  max_size?: number | null,
  status?: string | null,
  email_username?: string | null,
  email_username_enabled?: boolean | null,
  sent_messages_count?: number | null,
  forwarded_messages_count?: number | null,
  used?: boolean | null,
  forward_from_email_address?: string | null,
  project_id?: number | null,
  domain?: string | null,
  pop3_domain?: string | null,
  email_domain?: string | null,
  api_domain?: string | null,
  smtp_ports?: number[] | null,
  pop3_ports?: number[] | null,
  emails_count?: number | null,
  emails_unread_count?: number | null,
  last_message_sent_at?: string | null,
  max_message_size?: number | null,
  permissions?: {
    can_read?: boolean | null,
    can_update?: boolean | null,
    can_destroy?: boolean | null,
    can_leave?: boolean | null
  } | null
}[]

permissions full type

{
  can_read?: boolean | null,
  can_update?: boolean | null,
  can_destroy?: boolean | null,
  can_leave?: boolean | null
}

list

projects.list List projects and their sandbox inboxes Risk: read

await corsair.mailtrap.api.projects.list({});

Input: empty object Output: object[]

Output full type

{
  id: number,
  name: string,
  share_links?: {
    admin?: string | null,
    viewer?: string | null
  } | null,
  inboxes?: {
    id: number,
    name: string,
    username?: string | null,
    password?: string | null,
    max_size?: number | null,
    status?: string | null,
    email_username?: string | null,
    email_username_enabled?: boolean | null,
    sent_messages_count?: number | null,
    forwarded_messages_count?: number | null,
    used?: boolean | null,
    forward_from_email_address?: string | null,
    project_id?: number | null,
    domain?: string | null,
    pop3_domain?: string | null,
    email_domain?: string | null,
    api_domain?: string | null,
    smtp_ports?: number[] | null,
    pop3_ports?: number[] | null,
    emails_count?: number | null,
    emails_unread_count?: number | null,
    last_message_sent_at?: string | null,
    max_message_size?: number | null,
    permissions?: {
      can_read?: boolean | null,
      can_update?: boolean | null,
      can_destroy?: boolean | null,
      can_leave?: boolean | null
    } | null
  }[] | null,
  permissions?: {
    can_read?: boolean | null,
    can_update?: boolean | null,
    can_destroy?: boolean | null,
    can_leave?: boolean | null
  } | null
}[]

update

projects.update Rename a project Risk: write

await corsair.mailtrap.api.projects.update({});

Input

Name	Type	Required	Description
`project_id`	`number`	Yes	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`share_links`	`object`	No	—
`inboxes`	`object[]`	No	—
`permissions`	`object`	No	—

inboxes full type

{
  id: number,
  name: string,
  username?: string | null,
  password?: string | null,
  max_size?: number | null,
  status?: string | null,
  email_username?: string | null,
  email_username_enabled?: boolean | null,
  sent_messages_count?: number | null,
  forwarded_messages_count?: number | null,
  used?: boolean | null,
  forward_from_email_address?: string | null,
  project_id?: number | null,
  domain?: string | null,
  pop3_domain?: string | null,
  email_domain?: string | null,
  api_domain?: string | null,
  smtp_ports?: number[] | null,
  pop3_ports?: number[] | null,
  emails_count?: number | null,
  emails_unread_count?: number | null,
  last_message_sent_at?: string | null,
  max_message_size?: number | null,
  permissions?: {
    can_read?: boolean | null,
    can_update?: boolean | null,
    can_destroy?: boolean | null,
    can_leave?: boolean | null
  } | null
}[]

permissions full type

{
  can_read?: boolean | null,
  can_update?: boolean | null,
  can_destroy?: boolean | null,
  can_leave?: boolean | null
}

Sending Domains

create

sendingDomains.create Register a sending domain for DNS verification Risk: write

await corsair.mailtrap.api.sendingDomains.create({});

Input

Name	Type	Required	Description
`domain_name`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`domain_name`	`string`	Yes	—
`demo`	`boolean`	No	—
`inbound_enabled`	`boolean`	No	—
`inbound_verified`	`boolean`	No	—
`open_tracking_enabled`	`boolean`	No	—
`click_tracking_enabled`	`boolean`	No	—
`auto_unsubscribe_link_enabled`	`boolean`	No	—
`custom_domain_tracking_enabled`	`boolean`	No	—
`health_alerts_enabled`	`boolean`	No	—
`critical_alerts_enabled`	`boolean`	No	—
`alert_recipient_email`	`string`	No	—
`dns_records`	`object[]`	No	—

dns_records full type

{
  key?: string | null,
  domain?: string | null,
  name?: string | null,
  type?: string | null,
  value?: string | null,
  status?: string | null,
  actual?: string | null
}[]

delete

sendingDomains.delete Permanently remove a sending domain [DESTRUCTIVE] Risk: destructive

await corsair.mailtrap.api.sendingDomains.delete({});

Input

Name	Type	Required	Description
`domain_id`	`number`	Yes	—

Output: empty object

get

sendingDomains.get Get a sending domain by id, including its DNS records Risk: read

await corsair.mailtrap.api.sendingDomains.get({});

Input

Name	Type	Required	Description
`domain_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	Yes	—
`domain_name`	`string`	Yes	—
`demo`	`boolean`	No	—
`inbound_enabled`	`boolean`	No	—
`inbound_verified`	`boolean`	No	—
`open_tracking_enabled`	`boolean`	No	—
`click_tracking_enabled`	`boolean`	No	—
`auto_unsubscribe_link_enabled`	`boolean`	No	—
`custom_domain_tracking_enabled`	`boolean`	No	—
`health_alerts_enabled`	`boolean`	No	—
`critical_alerts_enabled`	`boolean`	No	—
`alert_recipient_email`	`string`	No	—
`dns_records`	`object[]`	No	—

dns_records full type

{
  key?: string | null,
  domain?: string | null,
  name?: string | null,
  type?: string | null,
  value?: string | null,
  status?: string | null,
  actual?: string | null
}[]

list

sendingDomains.list List sending domains Risk: read

await corsair.mailtrap.api.sendingDomains.list({});

Input: empty object Output: object[]

Output full type

{
  id: number,
  domain_name: string,
  demo?: boolean | null,
  inbound_enabled?: boolean | null,
  inbound_verified?: boolean | null,
  open_tracking_enabled?: boolean | null,
  click_tracking_enabled?: boolean | null,
  auto_unsubscribe_link_enabled?: boolean | null,
  custom_domain_tracking_enabled?: boolean | null,
  health_alerts_enabled?: boolean | null,
  critical_alerts_enabled?: boolean | null,
  alert_recipient_email?: string | null,
  dns_records?: {
    key?: string | null,
    domain?: string | null,
    name?: string | null,
    type?: string | null,
    value?: string | null,
    status?: string | null,
    actual?: string | null
  }[] | null
}[]

Stats

byCategories

stats.byCategories Get sending stats broken down by category Risk: read

await corsair.mailtrap.api.stats.byCategories({});

Input

Name	Type	Required	Description
`start_date`	`string`	Yes	—
`end_date`	`string`	Yes	—
`sending_domain_ids`	`number[]`	No	—
`sending_streams`	`string[]`	No	—
`categories`	`string[]`	No	—
`email_service_providers`	`string[]`	No	—

Output: object[]

Output full type

{
  category?: string | null,
  stats: {
    delivery_count?: number | null,
    delivery_rate?: number | null,
    bounce_count?: number | null,
    bounce_rate?: number | null,
    open_count?: number | null,
    open_rate?: number | null,
    click_count?: number | null,
    click_rate?: number | null,
    spam_count?: number | null,
    spam_rate?: number | null
  }
}[]

byDate

stats.byDate Get sending stats broken down by day Risk: read

await corsair.mailtrap.api.stats.byDate({});

Input

Name	Type	Required	Description
`start_date`	`string`	Yes	—
`end_date`	`string`	Yes	—
`sending_domain_ids`	`number[]`	No	—
`sending_streams`	`string[]`	No	—
`categories`	`string[]`	No	—
`email_service_providers`	`string[]`	No	—

Output: object[]

Output full type

{
  date?: string | null,
  stats: {
    delivery_count?: number | null,
    delivery_rate?: number | null,
    bounce_count?: number | null,
    bounce_rate?: number | null,
    open_count?: number | null,
    open_rate?: number | null,
    click_count?: number | null,
    click_rate?: number | null,
    spam_count?: number | null,
    spam_rate?: number | null
  }
}[]

byDomains

stats.byDomains Get sending stats broken down by sending domain Risk: read

await corsair.mailtrap.api.stats.byDomains({});

Input

Name	Type	Required	Description
`start_date`	`string`	Yes	—
`end_date`	`string`	Yes	—
`sending_domain_ids`	`number[]`	No	—
`sending_streams`	`string[]`	No	—
`categories`	`string[]`	No	—
`email_service_providers`	`string[]`	No	—

Output: object[]

Output full type

{
  sending_domain_id?: number | null,
  stats: {
    delivery_count?: number | null,
    delivery_rate?: number | null,
    bounce_count?: number | null,
    bounce_rate?: number | null,
    open_count?: number | null,
    open_rate?: number | null,
    click_count?: number | null,
    click_rate?: number | null,
    spam_count?: number | null,
    spam_rate?: number | null
  }
}[]

byEsp

stats.byEsp Get sending stats broken down by recipient email service provider Risk: read

await corsair.mailtrap.api.stats.byEsp({});

Input

Name	Type	Required	Description
`start_date`	`string`	Yes	—
`end_date`	`string`	Yes	—
`sending_domain_ids`	`number[]`	No	—
`sending_streams`	`string[]`	No	—
`categories`	`string[]`	No	—
`email_service_providers`	`string[]`	No	—

Output: object[]

Output full type

{
  email_service_provider?: string | null,
  stats: {
    delivery_count?: number | null,
    delivery_rate?: number | null,
    bounce_count?: number | null,
    bounce_rate?: number | null,
    open_count?: number | null,
    open_rate?: number | null,
    click_count?: number | null,
    click_rate?: number | null,
    spam_count?: number | null,
    spam_rate?: number | null
  }
}[]

get

stats.get Get aggregated sending stats for a date range Risk: read

await corsair.mailtrap.api.stats.get({});

Input

Name	Type	Required	Description
`start_date`	`string`	Yes	—
`end_date`	`string`	Yes	—
`sending_domain_ids`	`number[]`	No	—
`sending_streams`	`string[]`	No	—
`categories`	`string[]`	No	—
`email_service_providers`	`string[]`	No	—

Output

Name	Type	Required	Description
`delivery_count`	`number`	No	—
`delivery_rate`	`number`	No	—
`bounce_count`	`number`	No	—
`bounce_rate`	`number`	No	—
`open_count`	`number`	No	—
`open_rate`	`number`	No	—
`click_count`	`number`	No	—
`click_rate`	`number`	No	—
`spam_count`	`number`	No	—
`spam_rate`	`number`	No	—

Suppressions

list

suppressions.list List (and optionally search) suppressed email addresses Risk: read

await corsair.mailtrap.api.suppressions.list({});

Input

Name	Type	Required	Description
`email`	`string`	No	—

Output: object[]

Output full type

{
  id: string,
  type?: hard bounce | spam complaint | unsubscription | manual import | null,
  created_at?: string | null,
  email: string,
  sending_stream?: transactional | bulk | null,
  domain_name?: string | null,
  message_bounce_category?: string | null,
  message_category?: string | null,
  message_client_ip?: string | null,
  message_created_at?: string | null,
  message_outgoing_ip?: string | null,
  message_recipient_mx_name?: string | null,
  message_sender_email?: string | null,
  message_subject?: string | null
}[]

​Account

​getBillingUsage

​getPermissionResources

​listAccounts

​Contact Fields

​create

​delete

​get

​list

​update

​Contact Lists

​create

​delete

​get

​list

​update

​Contacts

​create

​createEvent

​createExport

​delete

​get

​getExport

​getImport

​import

​update

​Email Templates

​create

​delete

​get

​list

​update

​Inboxes

​clean

​get

​list

​markAsRead

​resetCredentials

​update

​Messages

​getHtml

​list

​Projects

​delete

​get

​list

​update

​Sending Domains

​create

​delete

​get

​list

​Stats

​byCategories

​byDate

​byDomains

​byEsp

​get

​Suppressions

​list

Account

getBillingUsage

getPermissionResources

listAccounts

Contact Fields

create

delete

get

list

update

Contact Lists

create

delete

get

list

update

Contacts

create

createEvent

createExport

delete

get

getExport

getImport

import

update

Email Templates

create

delete

get

list

update

Inboxes

clean

get

list

markAsRead

resetCredentials

update

Messages

getHtml

list

Projects

delete

get

list

update

Sending Domains

create

delete

get

list

Stats

byCategories

byDate

byDomains

byEsp

get

Suppressions

list