docs: Add reference to fetchmail `compose.yaml` example

This commit is contained in:
Brennan Kinney 2024-05-02 14:43:41 +12:00 committed by GitHub
parent 83da191f3a
commit e7727ffe75
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 50 additions and 47 deletions

View File

@ -26,9 +26,7 @@ Generate a file called `fetchmail.cf` and place it in the `docker-data/dms/confi
A detailed description of the configuration options can be found in the [online version of the manual page][fetchmail-docs].
### IMAP Configuration
!!! example
!!! example "IMAP Configuration"
```fetchmailrc
poll 'imap.gmail.com' proto imap
@ -38,9 +36,7 @@ A detailed description of the configuration options can be found in the [online
ssl
```
### POP3 Configuration
!!! example
!!! example "POP3 Configuration"
```fetchmailrc
poll 'pop3.gmail.com' proto pop3
@ -54,6 +50,8 @@ A detailed description of the configuration options can be found in the [online
Dont forget the last line! (_eg: `is 'user1@example.com'`_). After `is`, you have to specify an email address from the configuration file: `docker-data/dms/config/postfix-accounts.cf`.
!!! tip
More details how to configure fetchmail can be found in the [fetchmail man page in the chapter “The run control file”][fetchmail-docs-run].
### Polling Interval
@ -77,7 +75,7 @@ To debug your `fetchmail.cf` configuration run this command:
For more information about the configuration script `setup.sh` [read the corresponding docs][docs-setup].
Here a sample output of `./setup.sh debug fetchmail`:
!!! example "Sample output of `setup debug fetchmail`"
```log
fetchmail: 6.3.26 querying outlook.office365.com (protocol POP3) at Mon Aug 29 22:11:09 2016: poll started
@ -119,7 +117,12 @@ fetchmail: 6.3.26 querying outlook.office365.com (protocol POP3) at Mon Aug 29 2
fetchmail: normal termination, status 1
```
!!! tip "Troubleshoot with this reference `compose.yaml`"
[Here is a minimal `compose.yaml` example][fetchmail-compose-example] that runs two instances of DMS locally, with one configured with `fetchmail.cf`.
[docs-setup]: ../../config/setup.sh.md
[fetchmail-website]: https://www.fetchmail.info
[fetchmail-docs]: https://www.fetchmail.info/fetchmail-man.html
[fetchmail-docs-run]: https://www.fetchmail.info/fetchmail-man.html#31
[fetchmail-compose-example]: https://github.com/orgs/docker-mailserver/discussions/3994#discussioncomment-9290570