Microsoft: Invoke action send Mail — me User Actions send Mail
Microsoft meUserActions.sendMail: arguments, response, policy and SDK examples.
← Me user actions operations · Get started
Operation microsoft.me_sendmail
Provider route: POST /me/sendMail. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/microsoft with npm, or alter-sdk-microsoft with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { MicrosoftIntegration } from "@alter-ai/microsoft";
async function execute(input: Parameters<MicrosoftIntegration["meUserActions"]["sendMail"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new MicrosoftIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.meUserActions.sendMail(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_microsoft import MicrosoftIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = MicrosoftIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.me_user_actions.send_mail(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Required within parent | |
body.Message | Model | Optional | Expand Create message — request body — body |
body.SaveToSentItems | JSON | Optional | |
body.SaveToSentItems (anyOf 1) | boolean | Alternative | Default: false |
body.SaveToSentItems (anyOf 2) | null | Alternative |
Referenced models: Create message — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | null | Root |
Schemas
Section titled “Schemas”5 more schemas are linked from the tables above, on the schema pages.
Create open extension — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | discriminator: {"mapping": {}, "propertyName": "@odata.type"} |
$ (allOf 2).@odata.type | string | Optional |
Referenced models: Get rule — response body — @odata type, id
Get message — response body — @odata type, attachments, bcc Recipients, body, body Preview, cc Recipients, conversation Id, conversation Index, extensions, flag, from, has Attachments, importance, inference Classification, internet Message Headers, internet Message Id, is Delivery Receipt Requested, is Draft, is Read, is Read Receipt Requested, multi Value Extended Properties, parent Folder Id, received Date Time, reply To, sender, sent Date Time, single Value Extended Properties, subject, to Recipients, unique Body, web Link internet Message Headers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Represents the key in a key-value pair. |
name (anyOf 2) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | The value in a key-value pair. |
value (anyOf 2) | null | Alternative |
Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).value | array | Optional | A collection of property values. |
$ (allOf 2).value[] | JSON | Each item | |
$ (allOf 2).value[] (anyOf 1) | string | Alternative | |
$ (allOf 2).value[] (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id
Get event — response body — @odata type, categories, change Key, created Date Time, id, last Modified Date Time
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | discriminator: {"mapping": {"#microsoft.graph.contact": "#/components/schemas/microsoft.graph.contact", "#microsoft.graph.event": "#/components/schemas/microsoft.graph.event", "#microsoft.graph.message": "#/components/schemas/microsoft.graph.message", "#microsoft.graph.note": "#/components/schemas/microsoft.graph.note", "#microsoft.graph.post": "#/components/schemas/microsoft.graph.post"}, "propertyName": "@odata.type"} |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).categories | array | Optional | The categories associated with the item |
$ (allOf 2).categories[] | JSON | Each item | |
$ (allOf 2).categories[] (anyOf 1) | string | Alternative | |
$ (allOf 2).categories[] (anyOf 2) | null | Alternative | |
$ (allOf 2).changeKey | JSON | Optional | |
$ (allOf 2).changeKey (anyOf 1) | string | Alternative | Identifies the version of the item. Every time the item is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only. |
$ (allOf 2).changeKey (anyOf 2) | null | Alternative | |
$ (allOf 2).createdDateTime | JSON | Optional | |
$ (allOf 2).createdDateTime (anyOf 1) | string | Alternative | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Format: date-time Pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ |
$ (allOf 2).createdDateTime (anyOf 2) | null | Alternative | |
$ (allOf 2).lastModifiedDateTime | JSON | Optional | |
$ (allOf 2).lastModifiedDateTime (anyOf 1) | string | Alternative | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Format: date-time Pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ |
$ (allOf 2).lastModifiedDateTime (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id
Invoke action forward — me Event events Forward — request body — body To Recipients item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | discriminator: {"mapping": {"#microsoft.graph.attendee": "#/components/schemas/microsoft.graph.attendee", "#microsoft.graph.attendeeBase": "#/components/schemas/microsoft.graph.attendeeBase"}, "propertyName": "@odata.type"} |
@odata.type | string | Optional | |
emailAddress | JSON | Optional | The recipient's email address. |
emailAddress (anyOf 1) | Model | Alternative | Expand Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name |
emailAddress (anyOf 2) | JSON | Alternative | |
emailAddress (anyOf 2) (anyOf 1) | object | Alternative | |
emailAddress (anyOf 2) (anyOf 2) | null | Alternative |
Referenced models: Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name
Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).value | JSON | Optional | |
$ (allOf 2).value (anyOf 1) | string | Alternative | A property value. |
$ (allOf 2).value (anyOf 2) | null | Alternative |
Referenced models: Get rule — response body — @odata type, id
Add attachment — me Event events Create Attachments — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | discriminator: {"mapping": {}, "propertyName": "@odata.type"} |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).contentType | JSON | Optional | |
$ (allOf 2).contentType (anyOf 1) | string | Alternative | The MIME type. |
$ (allOf 2).contentType (anyOf 2) | null | Alternative | |
$ (allOf 2).isInline | boolean | Optional | true if the attachment is an inline attachment; otherwise, false. |
$ (allOf 2).lastModifiedDateTime | JSON | Optional | |
$ (allOf 2).lastModifiedDateTime (anyOf 1) | string | Alternative | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Format: date-time Pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ |
$ (allOf 2).lastModifiedDateTime (anyOf 2) | null | Alternative | |
$ (allOf 2).name | JSON | Optional | |
$ (allOf 2).name (anyOf 1) | string | Alternative | The attachment's file name. |
$ (allOf 2).name (anyOf 2) | null | Alternative | |
$ (allOf 2).size | number | Optional | The length of the attachment in bytes. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
Referenced models: Get rule — response body — @odata type, id
Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
address | JSON | Optional | |
address (anyOf 1) | string | Alternative | The email address of the person or entity. |
address (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The display name of the person or entity. |
name (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: microsoft.me_sendmail. Catalog operation: me/send-mail. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["Mail.Send"]
No-content response statuses: [204]