Skip to content

SDK method

tools.searchEmails

Search email. Convenience alias for search_emails, forwarding to tinbox.api.emails.search.query.

Signature

ts
searchEmails(input: Parameters<TinboxTools["searchEmails"]>[0]): ReturnType<TinboxTools["searchEmails"]>

Parameters

NameTypeRequiredDescription
querystringyesSearch terms (e.g. 'refund', 'invoice March').
inboxIdstringnoOptional: restrict to one inbox id. Omit to search all accessible inboxes.

Returns

ReturnType<TinboxTools["searchEmails"]>

Example

ts
await tinbox.tools.searchEmails({
  "query": "invoice"
});