Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patschi/mailpiler-mailcow-integration
This is a simple integration of mailcow aliases and the mailbox name into mailpiler when using IMAP authentication.
https://github.com/patschi/mailpiler-mailcow-integration
mailcow mailpiler piler
Last synced: 2 months ago
JSON representation
This is a simple integration of mailcow aliases and the mailbox name into mailpiler when using IMAP authentication.
- Host: GitHub
- URL: https://github.com/patschi/mailpiler-mailcow-integration
- Owner: patschi
- License: gpl-3.0
- Created: 2020-08-24T19:29:18.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-15T21:58:47.000Z (over 1 year ago)
- Last Synced: 2024-04-28T15:36:21.275Z (5 months ago)
- Topics: mailcow, mailpiler, piler
- Language: PHP
- Homepage:
- Size: 35.2 KB
- Stars: 12
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mailpiler-mailcow-integration
This is a simple integration of mailcow aliases and the mailbox name into mailpiler when using IMAP authentication. [A guide can be found in the official mailcow docs here](https://mailcow.github.io/mailcow-dockerized-docs/u_e-mailpiler-integration/).
## Requirements
Tested combinations:
| piler version | PHP versions | Notes |
| ------------- | ------------ | ----- |
| 1.3.9 | 7.4 | Working, but domain wildcards are not yet implemented. |
| 1.3.10 | 7.4 | None |
| 1.4.1/1.4.2 | 7.4, 8.1 | None |
| Future | n/a | Future versions might work, but not tested. |
## The problem to solve
mailpiler offers the authentication based on IMAP:
```php
$config['ENABLE_IMAP_AUTH'] = 1;
$config['IMAP_HOST'] = 'mail.example.com';
$config['IMAP_PORT'] = 993;
$config['IMAP_SSL'] = true;
```
So when you log in using `[email protected]`, you will only see delivered emails sent from or to this specific email address. When additional aliases are defined in mailcow, like `[email protected]`, you won't see emails sent from or to this email even the fact you're a recipient of mails sent to this alias.
With hooking into the authentication process of mailpiler this fires API requests to the mailcow API (requiring read-only API access) to read out the aliases your email address participates. Beside that, it will also read the "Name" of the mailbox specified to display it on the top-right of mailpiler after login.
## Configuration
[See setup instructions in the official mailcow docs here](https://mailcow.github.io/mailcow-dockerized-docs/u_e-mailpiler-integration/).