Skip to main content

getAgent

client.mail.getAgent(agentId: string): Promise<MailAgent>

Retrieves a specific mail agent by its unique identifier.

Returns the agent's registration details including name, capabilities, and configuration metadata.

Parameters

ParameterTypeRequiredDescription
agentIdstringYesThe unique identifier of the agent to retrieve

Returns

Promise<MailAgent> — A promise that resolves to the mail agent details

Example

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

const client = new CodeBoltClient();

const result = await client.mail.getAgent('agentId');
console.log(result);