Skip to content

Commit fab8a4b

Browse files
committed
docs: update email configuration section headers for consistency
1 parent 68ae64c commit fab8a4b

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

docs/Features/email-config.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
## Email Service Configuration
1+
# Email Service Configuration
22

33
The MailService provides email functionality using SMTP protocol. It supports:
44

55
- Account activation emails
66
- Password reset emails
77
- Welcome emails
88

9-
### Configuration Options
9+
## Configuration Options
1010

1111
Configure email settings in `appsettings.json`:
1212

@@ -31,14 +31,14 @@ Configure email settings in `appsettings.json`:
3131
}
3232
```
3333

34-
#### Development Configuration
34+
### Development Configuration
3535

3636
For local development, you can use:
3737

3838
- [MailHog](https://github.com/mailhog/MailHog) - Recommended for Mac/Linux
3939
- [Papercut SMTP](https://github.com/ChangemakerStudios/Papercut-SMTP) - Windows alternative
4040

41-
#### Production Configuration
41+
### Production Configuration
4242

4343
Common SMTP providers:
4444

@@ -59,7 +59,7 @@ Common SMTP providers:
5959
}
6060
```
6161

62-
### Usage Examples
62+
## Usage Examples
6363

6464
1. Activation Email:
6565

@@ -90,7 +90,7 @@ await _mailService.SendCreationEmail(
9090
);
9191
```
9292

93-
### Security Best Practices
93+
## Security Best Practices
9494

9595
1. **SMTP Security**
9696

@@ -115,7 +115,7 @@ await _mailService.SendCreationEmail(
115115
- Log delivery failures with correlation IDs
116116
- Monitor bounce rates and spam reports
117117

118-
### Testing
118+
## Testing
119119

120120
1. Unit Testing:
121121

@@ -153,7 +153,7 @@ public async Task Should_Connect_To_SMTP_Server()
153153
}
154154
```
155155

156-
### Troubleshooting Guide
156+
## Troubleshooting Guide
157157

158158
1. **Connection Issues**
159159
- Verify network connectivity to SMTP server
@@ -170,7 +170,7 @@ public async Task Should_Connect_To_SMTP_Server()
170170
- Monitor email logs for bounce reasons
171171
- Verify recipient address format
172172

173-
### Dependencies
173+
## Dependencies
174174

175175
- **MailKit**: SMTP client library
176176
```xml
@@ -181,7 +181,7 @@ public async Task Should_Connect_To_SMTP_Server()
181181
<PackageReference Include="MimeKit" Version="4.1.0" />
182182
```
183183

184-
### Additional Resources
184+
## Additional Resources
185185

186186
- [JHipster Email Configuration Guide](https://www.jhipster.tech/tips/011_tip_configuring_email_in_jhipster.html)
187187
- [MailKit Documentation](https://github.com/jstedfast/MailKit#documentation)

docs/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ You can also find lot of information in https://www.jhipster.tech
3030
Features/database-migrations
3131
Features/dependencies-management
3232
Features/dto
33+
Features/email-config
3334
Features/entity-auditing
3435
Features/fronts
3536
Features/heroku

0 commit comments

Comments
 (0)