MailApi
Class: MailApi
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:28
Provides API methods for the inter-agent mail system.
The mail system enables structured, asynchronous communication between agents through threads, messages, and inboxes. It also supports resource reservations to coordinate concurrent access to shared resources across agents.
Constructors
Constructor
new MailApi(http: HttpClient): MailApi;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:29
Parameters
| Parameter | Type |
|---|---|
http | HttpClient |
Returns
MailApi
Methods
acknowledgeMessage()
acknowledgeMessage(messageId: string): Promise<void>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:69
Parameters
| Parameter | Type |
|---|---|
messageId | string |
Returns
Promise<void>
checkReservationConflicts()
checkReservationConflicts(data: CheckReservationConflictsRequest): Promise<{
hasConflict: boolean;
}>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:125
Parameters
| Parameter | Type |
|---|---|
data | CheckReservationConflictsRequest |
Returns
Promise<{
hasConflict: boolean;
}>
createAgent()
createAgent(data: CreateMailAgentRequest): Promise<MailAgent>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:95
Parameters
| Parameter | Type |
|---|---|
data | CreateMailAgentRequest |
Returns
Promise<MailAgent>
createReservation()
createReservation(data: CreateReservationRequest): Promise<MailReservation>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:109
Parameters
| Parameter | Type |
|---|---|
data | CreateReservationRequest |
Returns
Promise<MailReservation>
createThread()
createThread(data: CreateMailThreadRequest): Promise<MailThread>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:37
Parameters
| Parameter | Type |
|---|---|
data | CreateMailThreadRequest |
Returns
Promise<MailThread>
createThreadMessage()
createThreadMessage(threadId: string, data: SendMailMessageRequest): Promise<MailMessage>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:59
Parameters
| Parameter | Type |
|---|---|
threadId | string |
data | SendMailMessageRequest |
Returns
Promise<MailMessage>
deleteThread()
deleteThread(threadId: string): Promise<void>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:49
Parameters
| Parameter | Type |
|---|---|
threadId | string |
Returns
Promise<void>
forceReservation()
forceReservation(data: ForceReservationRequest): Promise<void>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:117
Parameters
| Parameter | Type |
|---|---|
data | ForceReservationRequest |
Returns
Promise<void>
getAgent()
getAgent(agentId: string): Promise<MailAgent>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:99
Parameters
| Parameter | Type |
|---|---|
agentId | string |
Returns
Promise<MailAgent>
getAgentInbox()
getAgentInbox(agentId: string): Promise<MailMessage[]>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:103
Parameters
| Parameter | Type |
|---|---|
agentId | string |
Returns
Promise<MailMessage[]>
getAgents()
getAgents(): Promise<MailAgent[]>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:91
Returns
Promise<MailAgent[]>
getReservations()
getReservations(params?: Record<string, unknown>): Promise<MailReservation[]>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:121
Parameters
| Parameter | Type |
|---|---|
params? | Record<string, unknown> |
Returns
Promise<MailReservation[]>
getThread()
getThread(threadId: string): Promise<MailThread>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:41
Parameters
| Parameter | Type |
|---|---|
threadId | string |
Returns
Promise<MailThread>
getThreadMessages()
getThreadMessages(threadId: string): Promise<MailMessage[]>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:55
Parameters
| Parameter | Type |
|---|---|
threadId | string |
Returns
Promise<MailMessage[]>
getThreads()
getThreads(params?: MailThreadListParams): Promise<MailThread[]>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:33
Parameters
| Parameter | Type |
|---|---|
params? | MailThreadListParams |
Returns
Promise<MailThread[]>
markMessageRead()
markMessageRead(messageId: string): Promise<void>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:65
Parameters
| Parameter | Type |
|---|---|
messageId | string |
Returns
Promise<void>
releaseReservation()
releaseReservation(data: ReleaseReservationRequest): Promise<void>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:113
Parameters
| Parameter | Type |
|---|---|
data | ReleaseReservationRequest |
Returns
Promise<void>
replyToMessage()
replyToMessage(data: ReplyToMessageRequest): Promise<MailMessage>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:73
Parameters
| Parameter | Type |
|---|---|
data | ReplyToMessageRequest |
Returns
Promise<MailMessage>
searchMessages()
searchMessages(params?: MailSearchParams): Promise<MailMessage[]>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:81
Parameters
| Parameter | Type |
|---|---|
params? | MailSearchParams |
Returns
Promise<MailMessage[]>
send()
send(data: SendMailMessageRequest): Promise<MailMessage>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:77
Parameters
| Parameter | Type |
|---|---|
data | SendMailMessageRequest |
Returns
Promise<MailMessage>
summarizeThread()
summarizeThread(threadId: string): Promise<MailThreadSummary>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:85
Parameters
| Parameter | Type |
|---|---|
threadId | string |
Returns
Promise<MailThreadSummary>
updateThread()
updateThread(threadId: string, data: UpdateMailThreadRequest): Promise<MailThread>;
Defined in: CodeBolt/packages/pluginSdk/src/api/mail.api.ts:45
Parameters
| Parameter | Type |
|---|---|
threadId | string |
data | UpdateMailThreadRequest |
Returns
Promise<MailThread>