Skip to main content

EmailGateway

@totemsdk/edge-email

@totemsdk/edge-email / EmailGateway

Interface: EmailGateway

Properties​

status​

readonly status: "stopped" | "running" | "error"

Methods​

deleteMessage()​

deleteMessage(mailbox, id): Promise<EdgeOperationResult<unknown>>

Parameters​

mailbox​

string

id​

string

Returns​

Promise<EdgeOperationResult<unknown>>

listMailboxes()​

listMailboxes(): Promise<EdgeOperationResult<{ mailboxes: object[]; }>>

Returns​

Promise<EdgeOperationResult<{ mailboxes: object[]; }>>

markAsRead()​

markAsRead(mailbox, id): Promise<EdgeOperationResult<unknown>>

Parameters​

mailbox​

string

id​

string

Returns​

Promise<EdgeOperationResult<unknown>>

moveMessage()​

moveMessage(mailbox, id, destination): Promise<EdgeOperationResult<unknown>>

Parameters​

mailbox​

string

id​

string

destination​

string

Returns​

Promise<EdgeOperationResult<unknown>>

readMessage()​

readMessage(mailbox, id): Promise<EdgeOperationResult<{ message: EmailMessage; }>>

Parameters​

mailbox​

string

id​

string

Returns​

Promise<EdgeOperationResult<{ message: EmailMessage; }>>

searchMessages()​

searchMessages(options): Promise<EdgeOperationResult<{ messages: EmailMessage[]; total: number; }>>

Parameters​

options​
before?​

Date

from?​

string

limit?​

number

mailbox?​

string

query?​

string

since?​

Date

subject?​

string

unreadOnly?​

boolean

Returns​

Promise<EdgeOperationResult<{ messages: EmailMessage[]; total: number; }>>

sendMail()​

sendMail(options): Promise<EdgeOperationResult<{ messageId: string; }>>

Parameters​

options​

SendOptions

Returns​

Promise<EdgeOperationResult<{ messageId: string; }>>

start()​

start(): Promise<void>

Returns​

Promise<void>

stop()​

stop(): Promise<void>

Returns​

Promise<void>