Skip to main content

getAgents

client.mail.getAgents(): Promise<MailAgent[]>

Lists all registered mail agents in the system.

Returns the complete list of agents that are registered to send and receive mail. Each agent has a unique identity and inbox for receiving messages.

Parameters​

No parameters.

Returns​

Promise<MailAgent[]> — A promise that resolves to an array of mail agent registrations

Example​

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

const client = new CodeBoltClient();

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