Skip to main content

deleteThread

client.mail.deleteThread(threadId: string): Promise<void>

Permanently deletes a mail thread and all its messages.

Removes the thread and its entire message history. This action cannot be undone. Consider archiving threads instead if you may need to reference them later.

Parameters

ParameterTypeRequiredDescription
threadIdstringYesThe unique identifier of the thread to delete

Returns

Promise<void> — A promise that resolves when the thread has been deleted

Example

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

const client = new CodeBoltClient();

const result = await client.mail.deleteThread('threadId');
console.log(result);