mail module

Reference

Package:: @microsoft/teams-js

Used to interact with mail capability, including opening and composing mail.

Interfaces

ComposeNewParams

Parameters supplied when composing a new mail item

ComposeReplyOrForwardParams

Parameters supplied when composing a reply to or forward of a message

See ComposeMailType

OpenMailItemParams

Defines the parameters used to open a mail item in the user's mailbox

Type Aliases

ComposeMailParams

Parameters supplied to composeMail when composing a new mail item

See ComposeNewParams See ComposeReplyOrForwardParams See ComposeMailType

Enums

ComposeMailType

Defines compose mail types.

Functions

composeMail(ComposeMailParams)	Compose a new email in the user's mailbox.
isSupported()	Checks if the mail capability is supported by the host
openMailItem(OpenMailItemParams)	Opens a mail message in the host.

Function Details

composeMail(ComposeMailParams)

Compose a new email in the user's mailbox.

function composeMail(composeMailParams: ComposeMailParams): Promise<void>

Parameters

composeMailParams: ComposeMailParams

Object that specifies the type of mail item to compose and the details of the mail item.

Returns

Promise<void>

isSupported()

Checks if the mail capability is supported by the host

function isSupported(): boolean

Returns

boolean

boolean to represent whether the mail capability is supported

openMailItem(OpenMailItemParams)

Opens a mail message in the host.

function openMailItem(openMailItemParams: OpenMailItemParams): Promise<void>

Parameters

openMailItemParams: OpenMailItemParams

Object that specifies the ID of the mail message.

Returns

Promise<void>