Skip to content

Commit bfe63d2

Browse files
authored
Merge pull request #91 from rususlasan/enhancement/ie-incoming-filtration-note
Update ImunifyEmail documentation: add note about incoming filtration feature
2 parents 1546cf4 + cf63c60 commit bfe63d2

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/email/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,36 @@ Where "4600" the Imunify Email's feature id.
181181

182182
To enable Imunify Email on account/key level you have to follow almost the same algorithm but use endpoints (1)/(2) (refer to documentation above to get more details).
183183

184+
### **Beta**: Incoming Emails Filtration
185+
186+
:::tip Highlights
187+
ImunifyEmail now includes a **beta** feature for incoming email filtration, aimed at protecting server users from spam emails.
188+
This feature is currently in beta mode and is free to use.
189+
:::
190+
191+
#### Enabling/Disabling Incoming Filtration
192+
193+
To enable the incoming filtration feature, the server administrator needs to run the following command from the console:
194+
```
195+
ie-config enable-incoming
196+
```
197+
198+
To disable, run the following command:
199+
```
200+
ie-config disable-incoming
201+
```
202+
203+
Once you enable the feature, ImunifyEmail will start filtering incoming emails. Additionally, the UI in cPanel will be updated with the following changes:
204+
205+
- **Quarantine Tab**: A new column will be added to show the email direction (whether the email is outgoing or incoming).
206+
- **Settings Tab**:
207+
- A toggle will be available to disable the incoming filtration feature for specific cPanel accounts.
208+
- A table will be added to display statistics of incoming emails, showing the number of spam and ham emails by day.
209+
- **Statistics Tab**: A new section will be added to display detailed statistics of incoming emails, including the number of spam and ham emails over time.
210+
211+
The ie-cli utility reflects the same API as the UI, allowing customers to retrieve quarantine and statistics information via the command line interface.
212+
Use `--help` to get more info.
213+
184214
### User interface access
185215

186216
In order to access the UI as a hosting administrator, navigate to WHM -> Plugins -> Imunify360 -> Email tab.

0 commit comments

Comments
 (0)