Mail API

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

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

Quick Reference

Method	Description
acknowledge
archiveThread
checkConflicts
createThread
fetchInbox
findOrCreateThread
forceReserveFiles
getAgent
getMessage
getMessages
getThread
listAgents
listReservations
listThreads
markRead
registerAgent
releaseFiles
replyMessage
reserveFiles
search
sendMessage
summarizeThread
updateThreadStatus

Methods

---

acknowledge

plugin.mail.acknowledge(params: IAcknowledgeParams): Promise<IAcknowledgeResponse>

Parameter	Type	Required	Description
params	IAcknowledgeParams	Yes

Returns: Promise<IAcknowledgeResponse>

Full reference →

---

archiveThread

plugin.mail.archiveThread(params: IArchiveThreadParams): Promise<IArchiveThreadResponse>

Parameter	Type	Required	Description
params	IArchiveThreadParams	Yes

Returns: Promise<IArchiveThreadResponse>

Full reference →

---

checkConflicts

plugin.mail.checkConflicts(params: ICheckConflictsParams): Promise<ICheckConflictsResponse>

Parameter	Type	Required	Description
params	ICheckConflictsParams	Yes

Returns: Promise<ICheckConflictsResponse>

Full reference →

---

createThread

plugin.mail.createThread(params: ICreateThreadParams): Promise<ICreateThreadResponse>

Parameter	Type	Required	Description
params	ICreateThreadParams	Yes

Returns: Promise<ICreateThreadResponse>

Full reference →

---

fetchInbox

plugin.mail.fetchInbox(params: IFetchInboxParams): Promise<IFetchInboxResponse>

Parameter	Type	Required	Description
params	IFetchInboxParams	Yes

Returns: Promise<IFetchInboxResponse>

Full reference →

---

findOrCreateThread

plugin.mail.findOrCreateThread(params: IFindOrCreateThreadParams): Promise<IFindOrCreateThreadResponse>

Parameter	Type	Required	Description
params	IFindOrCreateThreadParams	Yes

Returns: Promise<IFindOrCreateThreadResponse>

Full reference →

---

forceReserveFiles

plugin.mail.forceReserveFiles(params: IForceReserveFilesParams): Promise<IForceReserveFilesResponse>

Parameter	Type	Required	Description
params	IForceReserveFilesParams	Yes

Returns: Promise<IForceReserveFilesResponse>

Full reference →

---

getAgent

plugin.mail.getAgent(params: IGetAgentParams): Promise<IGetAgentResponse>

Parameter	Type	Required	Description
params	IGetAgentParams	Yes

Returns: Promise<IGetAgentResponse>

Full reference →

---

getMessage

plugin.mail.getMessage(params: IGetMessageParams): Promise<IGetMessageResponse>

Parameter	Type	Required	Description
params	IGetMessageParams	Yes

Returns: Promise<IGetMessageResponse>

Full reference →

---

getMessages

plugin.mail.getMessages(params: IGetMessagesParams): Promise<IGetMessagesResponse>

Parameter	Type	Required	Description
params	IGetMessagesParams	Yes

Returns: Promise<IGetMessagesResponse>

Full reference →

---

getThread

plugin.mail.getThread(params: IGetThreadParams): Promise<IGetThreadResponse>

Parameter	Type	Required	Description
params	IGetThreadParams	Yes

Returns: Promise<IGetThreadResponse>

Full reference →

---

listAgents

plugin.mail.listAgents(): Promise<IListAgentsResponse>

No parameters.

Returns: Promise<IListAgentsResponse>

Full reference →

---

listReservations

plugin.mail.listReservations(params: IListReservationsParams): Promise<IListReservationsResponse>

Parameter	Type	Required	Description
params	IListReservationsParams	Yes

Returns: Promise<IListReservationsResponse>

Full reference →

---

listThreads

plugin.mail.listThreads(params: IListThreadsParams): Promise<IListThreadsResponse>

Parameter	Type	Required	Description
params	IListThreadsParams	Yes	(default: {})

Returns: Promise<IListThreadsResponse>

Full reference →

---

markRead

plugin.mail.markRead(params: IMarkReadParams): Promise<IMarkReadResponse>

Parameter	Type	Required	Description
params	IMarkReadParams	Yes

Returns: Promise<IMarkReadResponse>

Full reference →

---

registerAgent

plugin.mail.registerAgent(params: IRegisterAgentParams): Promise<IRegisterAgentResponse>

Parameter	Type	Required	Description
params	IRegisterAgentParams	Yes

Returns: Promise<IRegisterAgentResponse>

Full reference →

---

releaseFiles

plugin.mail.releaseFiles(params: IReleaseFilesParams): Promise<IReleaseFilesResponse>

Parameter	Type	Required	Description
params	IReleaseFilesParams	Yes

Returns: Promise<IReleaseFilesResponse>

Full reference →

---

replyMessage

plugin.mail.replyMessage(params: IReplyMessageParams): Promise<IReplyMessageResponse>

Parameter	Type	Required	Description
params	IReplyMessageParams	Yes

Returns: Promise<IReplyMessageResponse>

Full reference →

---

reserveFiles

plugin.mail.reserveFiles(params: IReserveFilesParams): Promise<IReserveFilesResponse>

Parameter	Type	Required	Description
params	IReserveFilesParams	Yes

Returns: Promise<IReserveFilesResponse>

Full reference →

---

search

plugin.mail.search(params: ISearchParams): Promise<ISearchResponse>

Parameter	Type	Required	Description
params	ISearchParams	Yes

Returns: Promise<ISearchResponse>

Full reference →

---

sendMessage

plugin.mail.sendMessage(params: ISendMessageParams): Promise<ISendMessageResponse>

Parameter	Type	Required	Description
params	ISendMessageParams	Yes

Returns: Promise<ISendMessageResponse>

Full reference →

---

summarizeThread

plugin.mail.summarizeThread(params: ISummarizeThreadParams): Promise<ISummarizeThreadResponse>

Parameter	Type	Required	Description
params	ISummarizeThreadParams	Yes

Returns: Promise<ISummarizeThreadResponse>

Full reference →

---

updateThreadStatus

plugin.mail.updateThreadStatus(params: IUpdateThreadStatusParams): Promise<IUpdateThreadStatusResponse>

Parameter	Type	Required	Description
params	IUpdateThreadStatusParams	Yes

Returns: Promise<IUpdateThreadStatusResponse>

Full reference →