Skip to main content

getThreads

client.mail.getThreads(params?: MailThreadListParams): Promise<MailThread[]>

Lists all mail threads with optional filtering and pagination.

Returns conversation threads that group related messages together. Threads can be filtered by participants, status, or other criteria using the params argument.

Parameters​

ParameterTypeRequiredDescription
paramsMailThreadListParamsNoOptional query parameters for filtering and pagination

Returns​

Promise<MailThread[]> — A promise that resolves to an array of mail threads

Example​

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.mail.getThreads();
console.log(result);