EWS v2

Exchange Web Services and Office 365 (mail).

Category

Email

Pack

MicrosoftExchangeOnPremise

Configuration parameters

• credentials — Email address (required)
• defaultTargetMailbox — Email address from which to fetch incidents (required)
• folder — Name of the folder from which to fetch incidents (supports Exchange Folder ID and sub-folders e.g. Inbox/Phishing)
• isPublicFolder — Public Folder
• impersonation — Has impersonation rights
• proxy — Use system proxy settings
• isFetch — Fetch incidents
• fetch_time — First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)
• markAsRead — Mark fetched emails as read
• incidentType — Incident type
• incidentFetchInterval — Incidents Fetch Interval
• ewsServer — ┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉ ‎ Manual Mode Exchange Server Hostname or IP address
• domainAndUserman — DOMAIN\USERNAME (e.g. DEMISTO.INT\admin)
• defaultServerVersion — Exchange Server Version (On-Premise only. Supported versions: 2007, 2010, 2010_SP2, 2013, 2013_SP1, 2016, and 2019)
• insecure — Trust any certificate (not secure)
• authType — ┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉┉ ‎ Advanced Mode Override Authentication Type (NTLM, Basic, or Digest).
• requestTimeout — Timeout (in seconds) for HTTP requests to Exchange Server
• maxFetch — Max incidents per fetch
• separate_process — Run as a separate process (protects against memory depletion)
• legacy_name — Use legacy attachment name
• skip_unparsable_emails — Skip unparsable emails during fetch incidents

Commands (24)

• 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. This command requires eDiscovery permissions to the Exchange Server. For more information, see the EWSv2 integration documentation.
• 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-autodiscovery-config — Returns the auto-discovery information. Can be used to manually configure the Exchange Server.
• 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 it's content as 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. 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-resolve-name — This operation verifies aliases and matches display names to the correct mailbox user. It handles one ambiguous name at a time. If there are multiple potential matches, all will be returned, but limited to a maximum of 100 candidates.
• 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.
• ews-search-mailboxes — Searches over multiple mailboxes or all Exchange mailboxes. Use either the mailbox-search-scope command or the email-addresses command to search specific mailboxes. This command requires eDiscovery permissions to the Exchange Server. For more information, see the EWS v2 integration documentation.
• reply-mail — Replies to an email using EWS.
• send-mail — Sends an email using EWS.