MailApi API

The mailApi module of the @codebolt/plugin-sdk.

import plugin from '@codebolt/plugin-sdk';

Quick Reference

Method	Description
acknowledgeMessage
checkReservationConflicts
createAgent
createReservation
createThread
createThreadMessage
deleteThread
forceReservation
getAgent
getAgentInbox
getAgents
getReservations
getThread
getThreadMessages
getThreads
markMessageRead
releaseReservation
replyToMessage
searchMessages
send
summarizeThread
updateThread

Methods

---

acknowledgeMessage

plugin.mailApi.acknowledgeMessage(messageId: string): Promise<void>

Parameter	Type	Required	Description
messageId	string	Yes

Returns: Promise<void>

Full reference →

---

checkReservationConflicts

plugin.mailApi.checkReservationConflicts(data: CheckReservationConflictsRequest): Promise<object>

Parameter	Type	Required	Description
data	CheckReservationConflictsRequest	Yes

Returns: Promise<object>

Full reference →

---

createAgent

plugin.mailApi.createAgent(data: CreateMailAgentRequest): Promise<MailAgent>

Parameter	Type	Required	Description
data	CreateMailAgentRequest	Yes

Returns: Promise<MailAgent>

Full reference →

---

createReservation

plugin.mailApi.createReservation(data: CreateReservationRequest): Promise<MailReservation>

Parameter	Type	Required	Description
data	CreateReservationRequest	Yes

Returns: Promise<MailReservation>

Full reference →

---

createThread

plugin.mailApi.createThread(data: CreateMailThreadRequest): Promise<MailThread>

Parameter	Type	Required	Description
data	CreateMailThreadRequest	Yes

Returns: Promise<MailThread>

Full reference →

---

createThreadMessage

plugin.mailApi.createThreadMessage(threadId: string, data: SendMailMessageRequest): Promise<MailMessage>

Parameter	Type	Required	Description
threadId	string	Yes
data	SendMailMessageRequest	Yes

Returns: Promise<MailMessage>

Full reference →

---

deleteThread

plugin.mailApi.deleteThread(threadId: string): Promise<void>

Parameter	Type	Required	Description
threadId	string	Yes

Returns: Promise<void>

Full reference →

---

forceReservation

plugin.mailApi.forceReservation(data: ForceReservationRequest): Promise<void>

Parameter	Type	Required	Description
data	ForceReservationRequest	Yes

Returns: Promise<void>

Full reference →

---

getAgent

plugin.mailApi.getAgent(agentId: string): Promise<MailAgent>

Parameter	Type	Required	Description
agentId	string	Yes

Returns: Promise<MailAgent>

Full reference →

---

getAgentInbox

plugin.mailApi.getAgentInbox(agentId: string): Promise<MailMessage[]>

Parameter	Type	Required	Description
agentId	string	Yes

Returns: Promise<MailMessage[]>

Full reference →

---

getAgents

plugin.mailApi.getAgents(): Promise<MailAgent[]>

No parameters.

Returns: Promise<MailAgent[]>

Full reference →

---

getReservations

plugin.mailApi.getReservations(params?: Record<string, unknown>): Promise<MailReservation[]>

Parameter	Type	Required	Description
params	Record<string, unknown>	No

Returns: Promise<MailReservation[]>

Full reference →

---

getThread

plugin.mailApi.getThread(threadId: string): Promise<MailThread>

Parameter	Type	Required	Description
threadId	string	Yes

Returns: Promise<MailThread>

Full reference →

---

getThreadMessages

plugin.mailApi.getThreadMessages(threadId: string): Promise<MailMessage[]>

Parameter	Type	Required	Description
threadId	string	Yes

Returns: Promise<MailMessage[]>

Full reference →

---

getThreads

plugin.mailApi.getThreads(params?: MailThreadListParams): Promise<MailThread[]>

Parameter	Type	Required	Description
params	MailThreadListParams	No

Returns: Promise<MailThread[]>

Full reference →

---

markMessageRead

plugin.mailApi.markMessageRead(messageId: string): Promise<void>

Parameter	Type	Required	Description
messageId	string	Yes

Returns: Promise<void>

Full reference →

---

releaseReservation

plugin.mailApi.releaseReservation(data: ReleaseReservationRequest): Promise<void>

Parameter	Type	Required	Description
data	ReleaseReservationRequest	Yes

Returns: Promise<void>

Full reference →

---

replyToMessage

plugin.mailApi.replyToMessage(data: ReplyToMessageRequest): Promise<MailMessage>

Parameter	Type	Required	Description
data	ReplyToMessageRequest	Yes

Returns: Promise<MailMessage>

Full reference →

---

searchMessages

plugin.mailApi.searchMessages(params?: MailSearchParams): Promise<MailMessage[]>

Parameter	Type	Required	Description
params	MailSearchParams	No

Returns: Promise<MailMessage[]>

Full reference →

---

send

plugin.mailApi.send(data: SendMailMessageRequest): Promise<MailMessage>

Parameter	Type	Required	Description
data	SendMailMessageRequest	Yes

Returns: Promise<MailMessage>

Full reference →

---

summarizeThread

plugin.mailApi.summarizeThread(threadId: string): Promise<MailThreadSummary>

Parameter	Type	Required	Description
threadId	string	Yes

Returns: Promise<MailThreadSummary>

Full reference →

---

updateThread

plugin.mailApi.updateThread(threadId: string, data: UpdateMailThreadRequest): Promise<MailThread>

Parameter	Type	Required	Description
threadId	string	Yes
data	UpdateMailThreadRequest	Yes

Returns: Promise<MailThread>

Full reference →