Database - Corsair

The Mailtrap plugin syncs data locally. Use corsair.mailtrap.db.<entity>.search({ data, limit?, offset? }) with the filters listed per entity.

New to Corsair? See database operations, data synchronization, and multi-tenancy.

Contact Fields

Path: mailtrap.db.contactFields.search

const rows = await corsair.mailtrap.db.contactFields.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`number`	equals, gt, gte, lt, lte, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`merge_tag`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Contact Lists

Path: mailtrap.db.contactLists.search

const rows = await corsair.mailtrap.db.contactLists.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`number`	equals, gt, gte, lt, lte, in
`name`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Contacts

Path: mailtrap.db.contacts.search

const rows = await corsair.mailtrap.db.contacts.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`email`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`date`	equals, before, after, between
`updated_at`	`date`	equals, before, after, between

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Email Templates

Path: mailtrap.db.emailTemplates.search

const rows = await corsair.mailtrap.db.emailTemplates.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`number`	equals, gt, gte, lt, lte, in
`uuid`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`subject`	`string`	equals, contains, startsWith, endsWith, in
`category`	`string`	equals, contains, startsWith, endsWith, in
`body_html`	`string`	equals, contains, startsWith, endsWith, in
`body_text`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`date`	equals, before, after, between
`updated_at`	`date`	equals, before, after, between

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Inboxes

Path: mailtrap.db.inboxes.search

const rows = await corsair.mailtrap.db.inboxes.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`number`	equals, gt, gte, lt, lte, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`status`	`string`	equals, contains, startsWith, endsWith, in
`email_username`	`string`	equals, contains, startsWith, endsWith, in
`project_id`	`number`	equals, gt, gte, lt, lte, in
`domain`	`string`	equals, contains, startsWith, endsWith, in
`sent_messages_count`	`number`	equals, gt, gte, lt, lte, in
`emails_count`	`number`	equals, gt, gte, lt, lte, in
`emails_unread_count`	`number`	equals, gt, gte, lt, lte, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Projects

Path: mailtrap.db.projects.search

const rows = await corsair.mailtrap.db.projects.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`number`	equals, gt, gte, lt, lte, in
`name`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Sending Domains

Path: mailtrap.db.sendingDomains.search

const rows = await corsair.mailtrap.db.sendingDomains.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`number`	equals, gt, gte, lt, lte, in
`domain_name`	`string`	equals, contains, startsWith, endsWith, in
`demo`	`boolean`	equals
`inbound_enabled`	`boolean`	equals
`inbound_verified`	`boolean`	equals
`open_tracking_enabled`	`boolean`	equals
`click_tracking_enabled`	`boolean`	equals

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.