Skip to content

Commit aeb55c3

Browse files
committed
IE documentation: add a Quick Start Guide
1 parent 48c8624 commit aeb55c3

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

docs/email/README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
# Email
22

3+
## Quick Start Guide
4+
5+
Welcome to Imunify Email, a powerful plugin designed to enhance your Imunify360 experience with advanced email protection features such as:
6+
- **Advanced Server Protection**: Provides robust protection against outgoing spam, ensuring your server maintains a high reputation and reliable email delivery.
7+
- **Rate-Limit Settings**: Allows you to define how many messages can be sent on behalf of specific accounts, domains, emails, or scripts, helping to prevent abuse and maintain control over email traffic.
8+
- **BETA: Incoming Filtration**: A new feature, currently in beta, that can be enabled to protect your users from incoming spam. Learn more about enabling this feature [here](https://docs.imunify360.com/email/#beta-incoming-emails-filtration).
9+
10+
### Installation Steps
11+
12+
:::tip Requirements
13+
- cPanel
14+
- Imunify360
15+
:::
16+
17+
1. **Install Imunify360**
18+
19+
Imunify Email is a plugin for the Imunify360 product. To use Imunify Email, you must first install Imunify360. Follow the [installation instructions for Imunify360](https://docs.imunify360.com/installation/#installation-instructions) to get started.
20+
21+
2. **Enable Imunify Email in CLN**
22+
23+
Once Imunify360 is installed and registered, you can enable the Imunify Email plugin through the CLN (CloudLinux Network) portal. This will automatically install all necessary components. Follow the [instructions to enable Imunify Email in CLN](https://docs.imunify360.com/email/#how-to-enable-imunify-email).
24+
For the system requirements and installation steps, refer to the [Installation](https://docs.imunify360.com/email/#installation).
25+
26+
## Full Documentation
27+
328
#### Imunify Email compatibility
429

530
Imunify Email has been checked for compatibility with following tools and mail gateways:
@@ -37,7 +62,7 @@ Minimum system requirements for installation:
3762
- Used disk space depends on the number of accounts on a server. By default, each account will have 100 MB limitation for quarantine space. This limit can be adjusted using UI later.
3863
:::
3964

40-
To install ImunifyEmail, you need to enable the corresponding option in your CLN account. After that the product will be installed automatically
65+
To install Imunify Email, you need to enable the corresponding option in your CLN account. After that the product will be installed automatically
4166
within 24 hours. To install it immediately you can use on of the following command as root user:
4267
```
4368
/usr/bin/imunify360-agent update-license
@@ -93,7 +118,7 @@ The configuration change is compatible with WHM Advanced Editor, you can continu
93118
#### Background
94119

95120
In order to use ImunifyEmail you have to enable it in CLN. You can achieve it in two ways:
96-
1. via UI
121+
1. via CLN UI
97122
2. via CLN API
98123

99124
When you enable/disable Imunify Email, the script will automatically run the corresponding action within 24 hours. In order to apply changes on the particular server immediately, please run the following command on behalf of the `root` user:

0 commit comments

Comments
 (0)