Skip to content

Commit f745fba

Browse files
CSOAR-3249 : EWS Action fails to ingest an attachment when it is an Outlook Item (#5378)
* CSOAR-3249 - initail commit * CSOAR-3249 : updated the doc * CSOAR-3249 : updated the doc * CSOAR-3249 : updated the version * Updates from review * Add directions for fields --------- Co-authored-by: John Pipkin <[email protected]>
1 parent 45c9bd7 commit f745fba

File tree

1 file changed

+105
-2
lines changed

1 file changed

+105
-2
lines changed

docs/platform-services/automation-service/app-central/integrations/microsoft-ews-daemon.md

Lines changed: 105 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,61 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
77

88
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/logos/microsoft-ews-daemon.png')} alt="microsoft-defender-atp" width="100"/>
99

10-
***Version: 2.5
11-
Updated: May 9, 2024***
10+
***Version: 2.6
11+
Updated: May 16, 2025***
1212

1313
:::sumo Cloud SOAR
1414
This integration is only for Cloud SOAR.
1515
:::
1616

1717
Process emails with EWS Daemon.
1818

19+
## Overview
20+
21+
### Purpose
22+
23+
The Microsoft EWS Incoming Mail Daemon automatically retrieves emails. It enables seamless integration with security automation platforms by pulling in messages for further analysis and action.
24+
### Use cases
25+
26+
* Automatically ingest emails from monitored mailboxes for phishing analysis or ticketing systems.
27+
* Feed email content into security orchestration workflows.
28+
* Process and analyze attachments (for example, .eml, .msg, documents) in near real-time.
29+
* Extract and enrich sender/recipient metadata for further investigation.
30+
31+
### Supported versions
32+
33+
* Microsoft Exchange Online (Office 365)
34+
35+
### Prerequisites
36+
* Active Azure subscription
37+
* Application registration with:
38+
* Client ID
39+
* Client Secret
40+
* Tenant ID
41+
* EWS API permissions
42+
* Basic authentication (legacy) or OAuth 2.0 with modern authentication
43+
* Correctly configured EWS endpoint
44+
* Valid credentials or token
45+
46+
### Limitations
47+
* Certain attachments may be represented differently, which can result in missing or inconsistent file metadata (for example, name or type).
48+
* Mailbox rate limits may apply depending on Microsoft tenant configuration
49+
50+
## Usage
51+
52+
### Basic usage
53+
* Configure credentials (Tenant ID, Client ID, Client Secret).
54+
* Set retrieval parameters like polling frequency, folders to include/exclude.
55+
* Enable the Daemon action in a rule or playbook.
56+
* Emails are pulled automatically.
57+
58+
### Advanced usage
59+
* Use filtering parameters to narrow email scope:
60+
* Subject keywords
61+
* Sender domain
62+
* Date ranges
63+
* Enable the Daemon action in a rule or playbook.
64+
1965
## Actions
2066

2167
* **Microsoft EWS Incoming Mail Daemon** *(Daemon)* - Automatically retrieve emails from EWS.
@@ -134,10 +180,66 @@ import IntegrationsAuth from '../../../../reuse/integrations-authentication.md';
134180

135181
<IntegrationsAuth/>
136182

183+
Use the information you set up in [Microsoft EWS configuration](#microsoft-ews-configuration) above:
184+
* **Host**. Enter the host name of the EWS instance, for example, `outlook.office365.com`.
185+
* **Authentication Method**. Select the [EWS authentication](https://learn.microsoft.com/en-us/exchange/client-developer/exchange-web-services/authentication-and-ews-in-exchange) method:
186+
* **Basic**
187+
* **NTLM**
188+
* **OAuth 2.0**
189+
* **Username**. Enter the Microsoft EWS username.
190+
* **Password**. Enter the Microsoft EWS password.
191+
* **Primary SMTP Address**. Enter the [primary SMTP address](https://learn.microsoft.com/en-us/exchange/client-developer/web-service-reference/primarysmtpaddress) for the user.
192+
* **Tenant ID**. Enter the [tenant ID](https://learn.microsoft.com/en-us/entra/fundamentals/how-to-find-tenant) for authentication.
193+
* **Client ID**. Enter the client ID for authentication.
194+
* **Client Secret**. Enter the client secret for authentication.
195+
* **Cloud SOAR API URL**. Enter the URL for your Cloud SOAR API, for example, `https://api.sumologic.com`. Enter the [API endpoint URL](/docs/api/getting-started/#sumo-logic-endpoints-by-deployment-and-firewall-security) for your region.
196+
* **Access ID**. Enter the access ID from a Sumo Logic [access key](/docs/manage/security/access-keys/). Select **Default** as the scope when generating access keys.
197+
* **Access Key**. Enter the access key associated with the Sumo Logic access ID entered above.
198+
* **Automation Engine**. Select whether to use [Cloud or Bridge execution](/docs/platform-services/automation-service/automation-service-integrations/#cloud-or-bridge-execution).
199+
137200
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/misc/microsoft-ews-daemon-configuration.png')} style={{border:'1px solid gray'}} alt="Microsoft EWS Daemon configuration" width="400"/>
138201

139202
For information about Microsoft EWS, see [Microsoft Exchange Web Services documentation](https://learn.microsoft.com/en-us/exchange/client-developer/exchange-web-services/how-to-authenticate-an-ews-application-by-using-oauth).
140203

204+
## API reference
205+
206+
### Configuration
207+
Environment variables or parameters:
208+
* Tenant
209+
* Client ID
210+
* Client secret
211+
* Email: The service account email address
212+
* Password or OAuth token: Authentication credentials
213+
* Automation bridge
214+
* And other fields info based on the requirement
215+
216+
### Containment APIs
217+
218+
### Rate Limits and Quotas
219+
* Microsoft may enforce throttling based on:
220+
* Number of concurrent EWS requests
221+
* Number of items retrieved per call
222+
* Number of mailbox accesses per day/hour
223+
224+
#### Troubleshooting
225+
| Issue | Resolution | Resolution |
226+
| :-- |:-- |:-- |
227+
| No emails retrieved | Incorrect folder, filters too strict | Check filters, verify folder ID |
228+
| Authentication failed | Invalid credentials or token | Update credentials and reauthorize |
229+
230+
### FAQ
231+
232+
#### Can I filter which emails are fetched?
233+
Yes. Filtering can be applied based on folders, received time. Custom filters may be implemented depending on integration configuration.
234+
235+
#### How frequently does the Daemon poll for new messages?
236+
The polling interval is determined by the configuration within the integration setup or automation rule.
237+
238+
### Support
239+
* For issues, questions, or improvements:
240+
* Microsoft [Q&A](https://learn.microsoft.com/answers)
241+
* Review logs on the portal using log search.
242+
141243
## Category
142244

143245
Email Gateway
@@ -150,3 +252,4 @@ Email Gateway
150252
* March 4, 2024 (v2.3) - Updated code for compatibility with Python 3.12
151253
* March 21, 2024 (v2.4) - Resolved an issue related to the Email Body
152254
* May 9, 2024 (v2.5) - A new field has been added to the integration resource for specifying the folder or path to search within
255+
* May 16, 2025 (v2.6) - Enhanced attachment handling to ensure accurate detection and processing.

0 commit comments

Comments
 (0)