.. _auto_microsoft_outlook_worker:

*MICROSOFT OUTLOOK*
===================

Connects to Microsoft Outlook via the Microsoft Graph API using OAuth 2.0 delegated (Access Token) authentication. Supports sending emails, reading the inbox, listing mail folders, fetching individual emails, and full CRUD management of calendar events. Use this worker whenever a workflow needs to interact with a user's Outlook mailbox or calendar programmatically.

When to use
-----------

Tagged: ``access_token``, ``azure_ad``, ``calendar``, ``delegated_auth``, ``email``, ``entra``, ``integration``, ``microsoft_graph``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Authentication Mode
     - auth_mode
     - select
     - client_credentials
     - ✓
     - Authentication strategy to use: 'client_credentials' (app-only, currently unsupported for Outlook operations) or 'access_token' (delegated OAuth 2.0 — required for all Outlook operations); default is 'client_credentials' but 'access_token' must be selected in practice.
   * - Azure Tenant ID
     - tenant_id
     - text
     - —
     - 
     - Azure AD (Entra) tenant ID (GUID) associated with the app registration; required only when auth_mode is 'client_credentials', leave blank for 'access_token' mode.
   * - Application (Client) ID
     - client_id
     - text
     - —
     - 
     - Application (client) ID from the Azure AD app registration; required only when auth_mode is 'client_credentials', leave blank for 'access_token' mode.
   * - Client Secret
     - client_secret
     - text
     - —
     - 
     - Client secret value from the Azure AD app registration; required only when auth_mode is 'client_credentials', leave blank for 'access_token' mode.
   * - Access Token
     - access_token
     - textarea
     - —
     - 
     - Pre-obtained OAuth 2.0 bearer token string with delegated Outlook/Graph permissions; required when auth_mode is 'access_token' — obtain via your Azure AD OAuth 2.0 authorization-code or device-code flow.
   * - Operation
     - operation
     - select
     - list_folders
     - ✓
     - The Outlook operation to execute: 'send_email', 'read_inbox', 'list_folders', 'get_email', 'list_events', 'create_event', 'update_event', or 'delete_event'; default is 'list_folders'.
   * - Recipients (To)
     - to_recipients
     - text
     - —
     - 
     - Comma-separated list of recipient email addresses (e.g. 'alice@example.com,bob@example.com'); required for the 'send_email' operation, leave blank for all other operations.
   * - Subject
     - subject
     - text
     - —
     - 
     - Subject line of the email or calendar event title (plain text string); required for 'send_email' and 'create_event' operations, optional for 'update_event'.
   * - Body
     - body
     - textarea
     - —
     - 
     - Body/content of the email or calendar event description (plain text or HTML string); optional — leave blank to send an empty body.
   * - Event Start
     - event_start
     - text
     - —
     - 
     - ISO 8601 datetime string for the calendar event start time (e.g. '2026-05-01T09:00:00'); required for 'create_event', optional for 'update_event', ignored for all other operations.
   * - Event End
     - event_end
     - text
     - —
     - 
     - ISO 8601 datetime string for the calendar event end time (e.g. '2026-05-01T10:00:00'); required for 'create_event', optional for 'update_event', ignored for all other operations.
   * - Folder ID / Email ID
     - folder_id
     - text
     - —
     - 
     - Mail folder ID or email message ID; required for 'get_email' (pass the message ID here), optionally used by 'read_inbox' to scope to a specific folder, leave blank for calendar and folder-listing operations.
   * - Event ID
     - event_id
     - text
     - —
     - 
     - Graph API calendar event ID string; required for 'update_event' and 'delete_event' operations, leave blank for all other operations.
   * - Max Results
     - max_results
     - number
     - 50
     - 
     - Maximum number of items to return for list operations ('read_inbox', 'list_folders', 'list_events'); integer between 1 and 999, default is 50.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Status
     - status
     - text
     - Human-readable string indicating whether the operation succeeded (e.g. 'Success: send_email completed successfully.') or failed with an error message.
   * - Results
     - results
     - dataset
     - Structured dataset (array of associative arrays) containing the operation results — e.g. inbox messages, folder list, event list, or send confirmation rows — ready for downstream dataset workers.
   * - Raw Response
     - raw_response
     - json
     - Full, unmodified JSON response object returned by the Microsoft Graph API; use for debugging or to extract fields not surfaced in the 'results' dataset.

Disciplines
-----------

- platform.integration
- platform.notification

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>microsoft_outlook_worker</code>. Schema hash: <code>48a6a3c7f57c</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>