Skip to content

Commit bbde73b

Browse files
suraj-webkulsuraj-webkul
committed
refactor the imap configuration.
1 parent 05dd138 commit bbde73b

File tree

2 files changed

+69
-36
lines changed

2 files changed

+69
-36
lines changed

‎docs/2.0/advanced/email-inbound-parse.md

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -69,29 +69,45 @@ Krayin CRM allows you to receive and manage your emails using the IMAP protocol.
6969
7070
**IMAP** (Internet Message Access Protocol) allows you to access your emails from any device without downloading them to your computer. Emails stay on the server, and you view them directly, with attachments only downloaded if needed. IMAP is ideal for accessing email on multiple devices, as any changes (like reading or deleting) are synced across all devices, making email management efficient and ensuring data consistency everywhere.
7171
72-
#### **Configure .env File**
72+
#### Configuring IMAP Settings
7373
74-
To enable IMAP in Krayin CRM, you need to configure the `.env` file. Open the `.env` file in the root directory of your Laravel project and make the following changes:
74+
To properly configure your email service via IMAP, follow the steps below to set up the necessary parameters through the application’s configuration interface.
7575
76-
```env
77-
MAIL_RECEIVER_DRIVER=webklex-imap
76+
#### Step 1: Access IMAP Settings
7877
79-
IMAP_HOST=imap.example.com # Replace with your IMAP host (e.g., imap.gmail.com)
80-
IMAP_PORT=993 # Use port 993 for IMAP with SSL encryption
81-
IMAP_ENCRYPTION=ssl # Choose 'ssl' or 'tls' based on your server settings
82-
IMAP_VALIDATE_CERT=true # Set this to 'true' to validate SSL certificates
83-
IMAP_USERNAME=your_username # Replace with your IMAP account username (email address)
84-
IMAP_PASSWORD=your_password # Replace with your IMAP account password
85-
```
78+
1. **Open Your Application Dashboard**:
79+
- Navigate to the **Configuration** section in your application.
80+
81+
2. **Select IMAP Settings**:
82+
- Click on **IMAP Settings** from the menu.
83+
84+
#### Step 2: Enter IMAP Configuration Details
85+
86+
In the IMAP settings interface, you will find fields to input the following parameters:
87+
88+
| Parameter | Description | Example |
89+
|---------------------|------------------------------------------------------------------|---------------------------|
90+
| **Host** | The hostname of your email server. | `imap.example.com` |
91+
| **Port** | The port used for IMAP connections. | `993` (for SSL) |
92+
| **Encryption Type** | The encryption type for the connection (e.g., SSL, TLS). | `SSL` |
93+
| **Validate SSL** | Specify whether to validate the SSL certificate. | `true` or `false` |
94+
| **IMAP Username** | Your email account username (usually the full email address). | `[email protected]` |
95+
| **IMAP Password** | The password associated with your email account. | `yourpassword` |
96+
97+
#### Step 3: Example Configuration
98+
99+
When filling out the IMAP settings, your input should resemble the following:
100+
101+
- **Host**: `imap.example.com`
102+
- **Port**: `993`
103+
- **Encryption Type**: `SSL`
104+
- **Validate SSL**: `true` or `false`
105+
- **IMAP Username**: `[email protected]`
106+
- **IMAP Password**: `yourpassword`
86107
87-
#### **Explanation of the `.env` IMAP Variables:**
108+
#### Step 4: Save Configuration
88109
89-
- **IMAP_HOST**: The IMAP server host name (e.g., `imap.gmail.com` for Gmail, `imap.example.com` for other email providers).
90-
- **IMAP_PORT**: The port used for IMAP communication, typically `993` for SSL.
91-
- **IMAP_ENCRYPTION**: Defines the encryption method for secure communication. It can be `ssl` or `tls`.
92-
- **IMAP_VALIDATE_CERT**: Set to `true` to validate SSL certificates for secure communication.
93-
- **IMAP_USERNAME**: Your IMAP email account username, which is typically your email address.
94-
- **IMAP_PASSWORD**: Your IMAP email account password.
110+
After entering all required fields, click the **Save** button to store your IMAP configuration. This will ensure your application can connect to the email server using the provided settings.
95111
96112
#### **Set IMAP as the Email Receiver Driver**
97113

‎docs/master/advanced/email-inbound-parse.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -69,29 +69,46 @@ Krayin CRM allows you to receive and manage your emails using the IMAP protocol.
6969
7070
**IMAP** (Internet Message Access Protocol) allows you to access your emails from any device without downloading them to your computer. Emails stay on the server, and you view them directly, with attachments only downloaded if needed. IMAP is ideal for accessing email on multiple devices, as any changes (like reading or deleting) are synced across all devices, making email management efficient and ensuring data consistency everywhere.
7171
72-
#### **Configure .env File**
7372
74-
To enable IMAP in Krayin CRM, you need to configure the `.env` file. Open the `.env` file in the root directory of your Laravel project and make the following changes:
73+
#### Configuring IMAP Settings
7574
76-
```env
77-
MAIL_RECEIVER_DRIVER=webklex-imap
75+
To properly configure your email service via IMAP, follow the steps below to set up the necessary parameters through the application’s configuration interface.
7876
79-
IMAP_HOST=imap.example.com # Replace with your IMAP host (e.g., imap.gmail.com)
80-
IMAP_PORT=993 # Use port 993 for IMAP with SSL encryption
81-
IMAP_ENCRYPTION=ssl # Choose 'ssl' or 'tls' based on your server settings
82-
IMAP_VALIDATE_CERT=true # Set this to 'true' to validate SSL certificates
83-
IMAP_USERNAME=your_username # Replace with your IMAP account username (email address)
84-
IMAP_PASSWORD=your_password # Replace with your IMAP account password
85-
```
77+
#### Step 1: Access IMAP Settings
78+
79+
1. **Open Your Application Dashboard**:
80+
- Navigate to the **Configuration** section in your application.
81+
82+
2. **Select IMAP Settings**:
83+
- Click on **IMAP Settings** from the menu.
84+
85+
#### Step 2: Enter IMAP Configuration Details
86+
87+
In the IMAP settings interface, you will find fields to input the following parameters:
88+
89+
| Parameter | Description | Example |
90+
|---------------------|------------------------------------------------------------------|---------------------------|
91+
| **Host** | The hostname of your email server. | `imap.example.com` |
92+
| **Port** | The port used for IMAP connections. | `993` (for SSL) |
93+
| **Encryption Type** | The encryption type for the connection (e.g., SSL, TLS). | `SSL` |
94+
| **Validate SSL** | Specify whether to validate the SSL certificate. | `true` or `false` |
95+
| **IMAP Username** | Your email account username (usually the full email address). | `[email protected]` |
96+
| **IMAP Password** | The password associated with your email account. | `yourpassword` |
97+
98+
#### Step 3: Example Configuration
99+
100+
When filling out the IMAP settings, your input should resemble the following:
101+
102+
- **Host**: `imap.example.com`
103+
- **Port**: `993`
104+
- **Encryption Type**: `SSL`
105+
- **Validate SSL**: `true` or `false`
106+
- **IMAP Username**: `[email protected]`
107+
- **IMAP Password**: `yourpassword`
86108
87-
#### **Explanation of the `.env` IMAP Variables:**
109+
#### Step 4: Save Configuration
88110
89-
- **IMAP_HOST**: The IMAP server host name (e.g., `imap.gmail.com` for Gmail, `imap.example.com` for other email providers).
90-
- **IMAP_PORT**: The port used for IMAP communication, typically `993` for SSL.
91-
- **IMAP_ENCRYPTION**: Defines the encryption method for secure communication. It can be `ssl` or `tls`.
92-
- **IMAP_VALIDATE_CERT**: Set to `true` to validate SSL certificates for secure communication.
93-
- **IMAP_USERNAME**: Your IMAP email account username, which is typically your email address.
94-
- **IMAP_PASSWORD**: Your IMAP email account password.
111+
After entering all required fields, click the **Save** button to store your IMAP configuration. This will ensure your application can connect to the email server using the provided settings.
95112
96113
#### **Set IMAP as the Email Receiver Driver**
97114

0 commit comments

Comments
 (0)