linagora/cyrus-imapd-postfix

Docker image based on last Debian stable release. It embeds:

• postfix
• cyrus-imapd (backports version)

HOW TO START

Start by creating SSL keys:

sudo openssl genrsa -out nginx/ssl/key.pem 2048
sudo openssl req -new -x509 -key nginx/ssl/key.pem -out nginx/ssl/cert.pem -days 365
sudo chmod 600 nginx/ssl/key.pem

Then:

docker build -t cyrus-local .
docker compose up
docker exec -it cyrus /bin/bash

After remote into the docker, run below steps to add dummy data:

Start saslthdb

/etc/init.d/saslauthd start

Create Mailbox user/password in SASLAUTHDB

echo 'createmailbox [email protected]' | cyradm -u cyrus -w cyrus localhost
echo 'createmailbox [email protected]' | cyradm -u cyrus -w cyrus localhost
echo 'secret' | saslpasswd2 -p -c bob
echo 'secret' | saslpasswd2 -p -c alice

List users in SASLAUTHDB and verify password

$ sasldblistusers2
> bob@5cc0d9eab3c9: userPassword
> alice@5cc0d9eab3c9: userPassword
> cyrus@5cc0d9eab3c9: userPassword

testsaslauthd -u bob -p secret -f /var/run/saslauthd/mux
> 0: OK "Success."

Add some dummy emails

By running the following script, your user bob will have a dozen emails in his Inbox:

./provisioning.sh

CONNECT FROM TELNET AND CURL

Sample telnet

To play with Cyrus IMAP (143): telnet localhost 143 then A1 LOGIN bob secret, A2 LIST "" "*", A3 SELECT INBOX, etc

To play with Postfix SMTP (25):

$ telnet localhost 25
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
220 localhost ESMTP Postfix (Debian/GNU)
MAIL FROM:<[email protected]>
250 2.1.0 Ok
RCPT TO:<[email protected]>
250 2.1.5 Ok
DATA
354 End data with <CR><LF>.<CR><LF>
From: Alice <[email protected]>
Subject:cool subject
cool content
.
250 2.0.0 Ok: queued as A7EB0B042F1
QUIT
221 2.0.0 Bye
Connection closed by foreign host.

-> Logs are at /var/log/syslogd/mail/current and show that the email has been delivered:

mail.info: Jan  7 14:34:55 postfix/smtpd[301]: A7EB0B042F1: client=unknown[172.18.0.1]
mail.info: Jan  7 14:35:09 postfix/cleanup[305]: A7EB0B042F1: message-id=<>
mail.info: Jan  7 14:35:09 postfix/qmgr[251]: A7EB0B042F1: from=<[email protected]>, size=198, nrcpt=1 (queue active)
mail.info: Jan  7 14:35:09 cyrus/lmtpunix[308]: Delivered: <cmu-lmtpd-308-1736260509-0@5cc0d9eab3c9> to mailbox: user.bob
mail.notice: Jan  7 14:35:09 cyrus/lmtpunix[308]: USAGE bob user: 0.006167 sys: 0.009251
mail.info: Jan  7 14:35:09 postfix/lmtp[307]: A7EB0B042F1: to=<[email protected]>, relay=localhost[/var/lib/cyrus/socket/lmtp], delay=25, delays=25/0.01/0.02/0.01, dsn=2.1.5, status=sent (250 2.1.5 Success SESSIONID=<cyrus-1736260509-308-2-14725385898710560125>)
mail.info: Jan  7 14:35:09 postfix/qmgr[251]: A7EB0B042F1: removed
mail.info: Jan  7 14:35:11 postfix/smtpd[301]: disconnect from unknown[172.18.0.1] mail=1 rcpt=1 data=1 quit=1 commands=4

Sample CURL

The following query confirms that the email has been received:

curl -X POST -H "Content-Type: application/json" -H "Accept: application/json" --user bob:secret \
-d '{
  "using": [ "urn:ietf:params:jmap:core", "urn:ietf:params:jmap:mail" ],
  "methodCalls": [[ "Mailbox/get", {}, "c1" ]]
}' http://localhost:8008/jmap/ | jq

CONNECT FROM TMAIL-FRONTEND

1. Start cyrus (cf above) ;
2. In your tmail-flutter directory, run flutter build apk and send the generated .apk file to your android device. Alternatively, you can use an emulator ;
3. Upon starting the app, select Use company server. You will be prompted for a server address.
   • If connecting from an emulator running on the same machine as cyrus, the server URL is https://10.0.2.2, a special address that the emulator resolves as localhost on the host machine ;
   • If connecting from a physical device, you have to find the IP address of the machine running cyrus. On Linux/Mac, run ip a in a terminal and locate the IP under the active network interface (listed with state UP). It should look like 10.x.x.x or 192.168.x.x. Then you can input https://x.x.x.x as the server address.
4. log in using the credentials from step 1 (eg, [email protected] and secret).

CONFIGURATION

Environment variables

Changing these variables has no effect when /etc/postfix is populated (after the first run if volume is kept).

Environment variables for Postfix (with default value):

• For Cyrus-Imapd:
  • CYRUS_PWD = "" (if not set, cyradm isn't usable)
  • SASL_PWCHECK_METHOD = saslauthd auxprop
  • SASLDB = sasldb
• For Postfix
  • MAILNAME = example.com
  • OTHER_DESTINATIONS = example.com
  • RELAY_HOST = ""
  • MYNETWORKS = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
  • ROOT_ADDRESS = "": (address to which mail from root and postmaster will be sent)

Exposed ports

• Postfix (depends on configuration):
  • 25
  • 465 (not configured by default)
  • 587 (not configured by default)
• Cyrus (depends on configuration):
  • 110
  • 143
  • 993
  • 995 (not configured by default)
  • 2000 (not configured by default)
  • 8008
  • 8443 (not configured by default)

REPOSITORY AND BUG REPORTS

• Repository: github.com/guimard/cyrus-postfix-docker
• Dockerfile
• Issues database

COPYRIGHT AND LICENCE

Copyright: Xavier (Yadd) Guimard [email protected].

License: GNU General Public License v2.0