Microsoft Outlook

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Enabled by default.
  • Authentication: OAuth 2.0.
  • Connection: A user authorizes the connection in the provider's consent screen.
  • Scopes: Mail.Read, Mail.Send, Mail.ReadWrite, Mail.Read.Shared, Mail.ReadWrite.Shared, Calendars.Read, Calendars.ReadWrite, offline_access.

Credentials

Set these per environment. See Connect an integration.

These variables are required only when you supply your own OAuth app. If a managed app is available, you can connect without setting them. Provider permissions and consent still apply.

VariableRequiredDescription
MICROSOFT_CLIENT_IDYesMicrosoft Azure App Client ID (Application ID) Docs.
MICROSOFT_CLIENT_SECRETYesMicrosoft Azure App Client Secret Docs.

Cloud access modes

Hosted Cloud tools support both user-delegated OAuth 2.0 authorization code access and application/service access using the OAuth 2.0 client credentials grant. These are separate credential configurations. The local Code runtime has its own supported authentication methods.

Set every application variable below in the target project environment. Delegated OAuth app variables above do not activate application access.

Application variableRequired
OUTLOOK_SERVICE_ACCOUNT_CLIENT_IDYes
OUTLOOK_SERVICE_ACCOUNT_CLIENT_SECRETYes
OUTLOOK_SERVICE_ACCOUNT_TENANT_IDYes
OUTLOOK_SERVICE_ACCOUNT_MAILBOXYes

Configure application access describes provider setup, identity selection, project tool policy and supported-operation restrictions.

Setup

  1. Choose who owns the Microsoft OAuth app: On hosted Veryfront, Outlook uses the Veryfront-managed Microsoft OAuth app: connect Outlook from the project's integrations and approve the Microsoft consent screen, no environment variables needed. Set MICROSOFT_CLIENT_ID and MICROSOFT_CLIENT_SECRET only to use your own Microsoft OAuth app, which is required for local and self-hosted runs.
  2. Register an app in Microsoft Entra: In the Microsoft Entra admin center, open App registrations and register a new application. For Supported account types, choose accounts in any organizational directory and personal Microsoft accounts, because the connector signs in through the common endpoint.
  3. Add the redirect URIs: Under Authentication, add a Web platform. Add the redirect URI of the environment that completes the flow: https://api.veryfront.com/oauth/callback/outlook for hosted Veryfront, or your app origin followed by /api/auth/outlook/callback for a local or self-hosted app.
  4. Add Microsoft Graph permissions: Under API permissions, add these delegated Microsoft Graph permissions: Mail.Read, Mail.Send, Mail.ReadWrite, Mail.Read.Shared, Mail.ReadWrite.Shared, Calendars.Read, Calendars.ReadWrite, offline_access. If your tenant does not let users consent to apps, an administrator must grant consent for the organization.
  5. Create a client secret: Under Certificates & secrets, create a client secret. Set MICROSOFT_CLIENT_ID and MICROSOFT_CLIENT_SECRET from the app's credentials. Client secrets expire, so rotate MICROSOFT_CLIENT_SECRET before the expiry date you choose.
  6. Verify access: Run List Emails (read-only). It returns message summaries from the connected mailbox without changing it.

Provider notes

  • The connection requests Mail.Read, Mail.Send, Mail.ReadWrite, Mail.Read.Shared, Mail.ReadWrite.Shared, Calendars.Read, Calendars.ReadWrite and offline_access. offline_access lets the connection refresh its access token. Mail.Read.Shared lets the tools read mailboxes shared with the user. Mail.ReadWrite.Shared lets Move Shared Mailbox Email move messages in those mailboxes.
  • The shared mailbox tools address the mailbox you name in the mailbox argument and never fall back to the signed-in user's mailbox. This connector signs in with delegated OAuth only, so the signed-in user must have access to that mailbox in Exchange. Application (app-only) permissions are not used by this connector.
  • Tools that create, update, send or delete data are marked as writes and need write authority; the other tools are read-only.

Provider API reference.

Tools

ToolAccessDescription
List Emails<br /><code className="reference-identifier">outlook__list_emails</code>ReadList emails
Get Email<br /><code className="reference-identifier">outlook__get_email</code>ReadGet email
Send Email<br /><code className="reference-identifier">outlook__send_email</code>WriteSend email
Search Emails<br /><code className="reference-identifier">outlook__search_emails</code>ReadSearch emails
List Folders<br /><code className="reference-identifier">outlook__list_folders</code>ReadList folders
Get Folder<br /><code className="reference-identifier">outlook__get_folder</code>ReadGet folder
Create Folder<br /><code className="reference-identifier">outlook__create_folder</code>WriteCreate folder
Update Folder<br /><code className="reference-identifier">outlook__update_folder</code>WriteRename folder
Delete Folder<br /><code className="reference-identifier">outlook__delete_folder</code>WriteDelete folder
Mark Email Read<br /><code className="reference-identifier">outlook__mark_email_read</code>WriteMark email read
Mark Email Unread<br /><code className="reference-identifier">outlook__mark_email_unread</code>WriteMark email unread
Delete Email<br /><code className="reference-identifier">outlook__delete_email</code>WriteDelete email
Move Email<br /><code className="reference-identifier">outlook__move_email</code>WriteMove email
Archive Email<br /><code className="reference-identifier">outlook__archive_email</code>WriteArchive email
Flag Email<br /><code className="reference-identifier">outlook__flag_email</code>WriteFlag email
Clear Email Flag<br /><code className="reference-identifier">outlook__clear_email_flag</code>WriteClear email flag
Categorize Email<br /><code className="reference-identifier">outlook__categorize_email</code>WriteReplace email categories
List Categories<br /><code className="reference-identifier">outlook__list_categories</code>ReadList categories
Create Category<br /><code className="reference-identifier">outlook__create_category</code>WriteCreate category
Update Category<br /><code className="reference-identifier">outlook__update_category</code>WriteUpdate category
Delete Category<br /><code className="reference-identifier">outlook__delete_category</code>WriteDelete category
Create Draft<br /><code className="reference-identifier">outlook__create_draft</code>WriteCreate draft
List Drafts<br /><code className="reference-identifier">outlook__list_drafts</code>ReadList drafts
Get Draft<br /><code className="reference-identifier">outlook__get_draft</code>ReadGet draft
Update Draft<br /><code className="reference-identifier">outlook__update_draft</code>WriteUpdate draft
Send Draft<br /><code className="reference-identifier">outlook__send_draft</code>WriteSend draft
Delete Draft<br /><code className="reference-identifier">outlook__delete_draft</code>WriteDelete draft
Reply Email<br /><code className="reference-identifier">outlook__reply_email</code>WriteReply email
Reply All Email<br /><code className="reference-identifier">outlook__reply_all_email</code>WriteReply all email
Forward Email<br /><code className="reference-identifier">outlook__forward_email</code>WriteForward email
Create Reply Draft<br /><code className="reference-identifier">outlook__create_reply_draft</code>WriteCreate reply draft
Create Reply All Draft<br /><code className="reference-identifier">outlook__create_reply_all_draft</code>WriteCreate reply all draft
Create Forward Draft<br /><code className="reference-identifier">outlook__create_forward_draft</code>WriteCreate forward draft
List Attachments<br /><code className="reference-identifier">outlook__list_attachments</code>ReadList attachments
Get Attachment<br /><code className="reference-identifier">outlook__get_attachment</code>ReadGet attachment
Add Attachment To Message<br /><code className="reference-identifier">outlook__add_attachment_to_message</code>WriteAdd attachment to message
List Conversation Messages<br /><code className="reference-identifier">outlook__list_conversation_messages</code>ReadList conversation messages
List Threads<br /><code className="reference-identifier">outlook__list_threads</code>ReadList threads
Get Thread<br /><code className="reference-identifier">outlook__get_thread</code>ReadGet thread
List Shared Mailbox Emails<br /><code className="reference-identifier">outlook__list_shared_mailbox_emails</code>ReadList shared mailbox emails
Search Shared Mailbox Emails<br /><code className="reference-identifier">outlook__search_shared_mailbox_emails</code>ReadSearch shared mailbox emails
Get Shared Mailbox Email<br /><code className="reference-identifier">outlook__get_shared_mailbox_email</code>ReadGet shared mailbox email
List Shared Mailbox Folders<br /><code className="reference-identifier">outlook__list_shared_mailbox_folders</code>ReadList shared mailbox folders
List Shared Mailbox Child Folders<br /><code className="reference-identifier">outlook__list_shared_mailbox_child_folders</code>ReadList shared mailbox child folders
List Shared Mailbox Attachments<br /><code className="reference-identifier">outlook__list_shared_mailbox_attachments</code>ReadList shared mailbox attachments
Get Shared Mailbox Attachment<br /><code className="reference-identifier">outlook__get_shared_mailbox_attachment</code>ReadGet shared mailbox attachment
Move Shared Mailbox Email<br /><code className="reference-identifier">outlook__move_shared_mailbox_email</code>WriteMove shared mailbox email
Get Shared Mailbox Email MIME<br /><code className="reference-identifier">outlook__get_shared_mailbox_email_mime</code>ReadGet shared mailbox email MIME
List Calendars<br /><code className="reference-identifier">outlook__list_calendars</code>ReadList calendars
Get Calendar<br /><code className="reference-identifier">outlook__get_calendar</code>ReadGet calendar
Create Calendar<br /><code className="reference-identifier">outlook__create_calendar</code>WriteCreate calendar
Update Calendar<br /><code className="reference-identifier">outlook__update_calendar</code>WriteUpdate calendar
Delete Calendar<br /><code className="reference-identifier">outlook__delete_calendar</code>WriteDelete calendar
List Events<br /><code className="reference-identifier">outlook__list_events</code>ReadList events
List Calendar View<br /><code className="reference-identifier">outlook__list_calendar_view</code>ReadList calendar view
Get Event<br /><code className="reference-identifier">outlook__get_event</code>ReadGet event
Create Event<br /><code className="reference-identifier">outlook__create_event</code>WriteCreate event
Update Event<br /><code className="reference-identifier">outlook__update_event</code>WriteUpdate event
Delete Event<br /><code className="reference-identifier">outlook__delete_event</code>WriteDelete event
Respond To Event<br /><code className="reference-identifier">outlook__respond_to_event</code>WriteRespond to event
Get Event Instances<br /><code className="reference-identifier">outlook__get_event_instances</code>ReadGet event instances
List Event Attachments<br /><code className="reference-identifier">outlook__list_event_attachments</code>ReadList event attachments
Get Event Attachment<br /><code className="reference-identifier">outlook__get_event_attachment</code>ReadGet event attachment
Add Event Attachment<br /><code className="reference-identifier">outlook__add_event_attachment</code>WriteAdd event attachment
Find Free Time<br /><code className="reference-identifier">outlook__find_free_time</code>ReadFind free time
Get Schedule<br /><code className="reference-identifier">outlook__get_schedule</code>ReadGet schedule
Find Meeting Times<br /><code className="reference-identifier">outlook__find_meeting_times</code>ReadFind meeting times

Verify the connection

Call a read tool such as outlook__list_emails with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.