EWSO365

The new EWS O365 integration uses OAuth 2.0 protocol and can be used with Exchange Online and Office 365 (mail).

Email · Microsoft Exchange Online

Configuration parameters

  • azure_cloud — Azure Cloud
  • _client_id — ID / Application ID
  • _tenant_id — Token / Tenant ID
  • credentials —
  • default_target_mailbox — Email Address (required)
  • upn_mailbox — UPN Address
  • folder — Name of the folder from which to fetch incidents
  • access_type — Access Type (Impersonation is deprecated as of February 2025)
  • is_public_folder — Public Folder
  • isFetch — Fetch incidents
  • incidentType — Incident type
  • fetch_time — First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)
  • max_fetch — Maximum number of incidents per fetch (up to 200). Performance might be affected by a value higher than 50.
  • mark_as_read — Mark fetched emails as read
  • request_timeout — Timeout (in seconds) for HTTP requests to Exchange Server
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings
  • separate_process — Run as a separate process (protects against memory depletion)
  • self_deployed — Use a self deployed Azure Application
  • client_id — ID / Application ID (Deprecated)
  • tenant_id — Token / Tenant ID (Deprecated)
  • client_secret — Key / Application Secret (Deprecated)
  • incidentFetchInterval — Incidents Fetch Interval
  • incidentFilter — What time field should we filter incidents by?
  • legacy_name — Use legacy attachment name
  • skip_unparsable_emails — Skip unparsable emails during fetch incidents

Commands (22)

  • ews-auth-reset

    Run this command if for some reason you need to rerun the authentication process.

  • ews-create-folder

    Creates a new folder in a specified mailbox.

  • ews-delete-attachment

    Deletes the attachments of an item (email message).

  • ews-delete-items

    Delete items from mailbox.

  • ews-expand-group

    Expands a distribution list to display all members. By default, expands only first layer of the distribution list. If recursive-expansion is "True", the command expands nested distribution lists and returns all members.

  • ews-find-folders

    Retrieves information for folders for a specified mailbox. Only folders with read permissions will be returned. Your visual folders on the mailbox, such as "Inbox", are under the folder "Top of Information Store".

  • ews-get-attachment

    Retrieves the actual attachments from an item (email message). To get all attachments for a message, only specify the item-id argument.

  • ews-get-contacts

    Retrieves contacts for a specified mailbox.

  • ews-get-folder

    Retrieves a single folder.

  • ews-get-items

    Retrieves items by item ID.

  • ews-get-items-as-eml

    Retrieves items by item ID and uploads its content as an EML file.

  • ews-get-items-from-folder

    Retrieves items from a specified folder in a mailbox. The items are order by the item created time, most recent is first.

  • ews-get-out-of-office

    Retrieves the out-of-office status for a specified mailbox.

  • ews-get-searchable-mailboxes

    Returns a list of searchable mailboxes. This command requires eDiscovery permissions to the Exchange Server. For more information, see the EWSv2 integration documentation.

  • ews-mark-item-as-junk

    Marks an item as junk. This is commonly used to block an email address (meaning all future emails from this sender will be sent to the junk folder). For more information, see the Microsoft documentation: https://msdn.microsoft.com/en-us/library/office/dn481311(v=exchg.150).aspx.

  • ews-mark-items-as-read

    Marks items as read or unread.

  • ews-move-item

    Move an item to different folder in the mailbox.

  • ews-move-item-between-mailboxes

    Moves an item from one mailbox to different mailbox.

  • ews-recover-messages

    Recovers messages that were soft-deleted.

  • ews-search-mailbox

    Searches for items in the specified mailbox. Specific permissions are needed for this operation to search in a target mailbox other than the default.

  • reply-mail

    Replies to an email using EWS.

  • send-mail

    Sends an email.