Microsoft Outlook

Send, search, and read emails in Microsoft Outlook.

CommunicationOAuth12 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (12)
send-email
addLabelToEmail
createDraftEmail
custom_api_call
downloadAttachment
findEmail
forwardEmail
moveEmailToFolder
removeLabelFromEmail
reply-email
request_approval_in_mail
sendDraftEmail
Details

Connect

Auth type: OAuth (oauth2). Click Connect and approve access on the provider's page. Appbricx runs the OAuth flow (signed single-use state, PKCE where the provider supports it), stores the tokens encrypted and refreshes them before they expire.

Scopes requested: Mail.SendMail.ReadUser.Read

OAuth needs an OAuth app: the platform's when the operator configured one, or your own (admin panel, Integrations, Configure). You can also bring your own credentials.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("microsoft_outlook", "send-email", {
    "recipients": [],
    "subject": "<subject>",
    "bodyFormat": "html",
    "body": "<body>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Microsoft Outlook answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "microsoft-outlook-send-email",
  name: "Microsoft Outlook: Send Email",
  description: "Calls Microsoft Outlook when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("microsoft_outlook", {
      "action": "send-email",
      "recipients": [],
      "subject": "<subject>",
      "bodyFormat": "html",
      "body": "<body>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/microsoft_outlook/send-email" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"recipients":[],"subject":"<subject>","bodyFormat":"html","body":"<body>"}}'

Actions

send-emailin catalog

Send Email. Sends an email using Microsoft Outlook.

Also accepted as send_email.

Input	Type	Description
`recipients`required	array	To Email(s)
`ccRecipients`optional	array	CC Email(s)
`bccRecipients`optional	array	BCC Email(s)
`subject`required	text	Subject
`bodyFormat`required	one of "html" \| "text"	Body Format
`body`required	long text	Body
`attachments`optional	array	Attachments

addLabelToEmail

Add Label to Email. Adds a category (label) to an email message.

Input	Type	Description
`messageId`required	id (picked from your account)	Select the email message to add the label to.
`categories`required	array	Categories to add to the email.

createDraftEmail

Create Draft Email. Creates a draft email message.

Input	Type	Description
`recipients`required	array	To Email(s)
`ccRecipients`optional	array	CC Email(s)
`bccRecipients`optional	array	BCC Email(s)
`subject`required	text	Subject
`bodyFormat`required	one of "html" \| "text"	Body Format
`body`required	long text	Body
`attachments`optional	array	Attachments

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

downloadAttachment

Download Attachment. Download attachments from a specific email message.

Input	Type	Description
`messageId`required	text	The ID of the email message containing the attachment.

findEmail

Find Email. Searches for emails using full-text search.

Input	Type	Description
`searchQuery`required	text	Search terms to find emails (e.g., "from:john@example.com", "subject:urgent", "hasAttachments:true")
`folderId`optional	id (picked from your account)	Search in a specific folder. Leave empty to search all folders.
`top`optional	number	Maximum number of results to return (1-1000).

forwardEmail

Forward Email. Forwards an email message.

Input	Type	Description
`messageId`required	id (picked from your account)	Select the email message to forward.
`recipients`required	array	To Email(s)
`comment`optional	long text	Optional comment to include with the forwarded message.

moveEmailToFolder

Move Email to Folder. Moves an email message to a specific folder.

Input	Type	Description
`messageId`required	id (picked from your account)	Select the email message to move.
`destinationFolderId`required	id (picked from your account)	The folder to move the email to.

removeLabelFromEmail

Remove Label from Email. Removes a category (label) from an email message.

Input	Type	Description
`messageId`required	id (picked from your account)	Select the email message to remove the label from.
`categories`required	array	Categories to remove from the email.

reply-email

Reply to Email. Reply to an outlook email.

Input	Type	Description
`messageId`required	id (picked from your account)	Select the email message to reply to.
`bodyFormat`required	one of "html" \| "text"	Body Format
`replyBody`required	long text	Reply Body
`ccRecipients`optional	array	CC Recipients
`bccRecipients`optional	array	BCC Recipients
`attachments`optional	array	Attachments
`draft`required	boolean	If enabled, creates draft without sending.

request_approval_in_mail

Request Approval in Email. Send approval request email and then wait until the email is approved or disapproved

Input	Type	Description
`recipients`required	text	The email address of the recipient who will receive the approval request.
`subject`required	text	The subject of the approval request email.
`body`required	long text	The main content of the email. You can include details about the approval request here in the html format or plain text.

sendDraftEmail

Send Draft Email. Sends a draft email message.

Input	Type	Description
`messageId`required	id (picked from your account)	Select the draft email message to send.

Details

Id: microsoft_outlook
Category: Communication
Tags: email, microsoft, inbox, mail, enterprise
Package: @activepieces/piece-microsoft-outlook@0.2.13
Tier: Built in