Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ManageSieve for Everyone #504

Closed
wants to merge 6 commits into from
Closed

ManageSieve for Everyone #504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
10e297a
ManageSieve for Everyone
jchristgit Aug 26, 2024
bff134e
Separate mail users by their UID
jchristgit Aug 27, 2024
e8d54fe
Make spam learning pipe scripts world readable/executable
jb3 Aug 28, 2024
62e1e6f
Change templating of user mail_home
jb3 Aug 28, 2024
76c2637
Remove unnecessary & faulty LDAP user attribute mapping
jb3 Aug 28, 2024
be7ac46
Recommend CLI & GUI sieve clients
jchristgit Aug 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ansible/group_vars/all/nftables.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ nftables_configuration: |
set mail_accepted {
type inet_service
elements = {
# Mail configuration
sieve,
# Mail submission
smtp,
smtps,
Expand Down
2 changes: 1 addition & 1 deletion ansible/roles/dovecot/tasks/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@
dest: "{{ dovecot_sieve_pipe_bin_dir }}/{{ item }}"
owner: vmail
group: vmail
mode: "0500"
mode: "0555"
with_items:
- spamc-learn-ham.sh
- spamc-learn-spam.sh
Expand Down
5 changes: 4 additions & 1 deletion ansible/roles/dovecot/templates/configs/10-mail.conf.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
#
# <doc/wiki/MailLocation.txt>
#
mail_home = /var/vmail/%d/%n
mail_home = /var/vmail/%u
mail_location = maildir:~/mail


Expand Down Expand Up @@ -433,6 +433,9 @@ service welcome {
executable = script /etc/dovecot/welcome.sh
user = dovecot
unix_listener welcome {
# Group write permissions are necessary to allow this to run for new users.
mode = 0660
user = vmail
group = vmail
}
}
8 changes: 6 additions & 2 deletions ansible/roles/dovecot/templates/configs/auth-ldap.conf.ext.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ passdb {
}

userdb {
driver = static
args = uid=vmail gid=vmail home=/var/vmail/%u mail=maildir:~/mail sieve=/home/%u/sieve sieve_user_log=/var/vmail/%u/sieve.log
driver = prefetch
}

userdb {
driver = ldap
args = /etc/dovecot/dovecot-ldap.conf.ext
}
2 changes: 1 addition & 1 deletion ansible/roles/dovecot/templates/dovecot-ldap.conf.ext.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ base = cn=users,cn=accounts,dc=box,dc=pydis,dc=wtf
#
# There are also other special fields which can be returned, see
# http://wiki2.dovecot.org/UserDatabase/ExtraFields
user_attrs = uidNumber=uid, gidNumber=gid, uid=home=/home/%$
user_attrs = uidNumber=uid, gidNumber=gid, sieve=~/main.sieve, sieve_user_log=~/sieve.log

# Filter for user lookup. Some variables can be used (see
# http://wiki2.dovecot.org/Variables for full list):
Expand Down
6 changes: 0 additions & 6 deletions ansible/roles/dovecot/templates/dovecot.conf.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,6 @@ dict {
#quota = mysql:/etc/dovecot/dovecot-dict-sql.conf.ext
}

# PYDIS CONFIG START

protocols = imap lmtp

# PYDIS CONFIG END

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sure there is a reason, but why is this diff removed?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default protocols includes the managesieve endpoint. I figured instead of amending it here, just relying on the bundled protocols setting (via the include) is good.

# Most of the actual configuration gets included below. The filenames are
# first sorted by their ASCII value and parsed in that order. The 00-prefixes
# in filenames are intended to make it easier to understand the ordering.
Expand Down
17 changes: 8 additions & 9 deletions docs/docs/services/email/mail-clients.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,14 @@ are not provided by the PyDis mailserver please let us know in `#dev-oops`.

We support server-side email filtering with [Pigeonhole
Sieve](https://doc.dovecot.org/configuration_manual/sieve/pigeonhole_sieve_interpreter/).

!!! example "DevOps Only"

For now, since this feature requires access to a home directory on the host, it is
only accessable to members of the DevOps team. If you are not a member of the DevOps
team and wish to configure sieve, please let us know in the #dev-oops channel.

We may in future investigate further usage of `dovecot-managesieved` to allow for
remote management of the Sieve filters.
Sieve scripts are managed via [the ManageSieve
protocol](https://datatracker.ietf.org/doc/html/rfc5804). Your e-mail client
should have built-in functionality for writing and editing these scripts. See
[the official Sieve website](http://sieve.info/) for more information.

If you're looking for clients, [`sieve-connect` is a solid
CLI](https://people.spodhuis.org/phil.pennock/software/), and [Thomas Schmid's
`sieve`](https://github.com/thsmi/sieve) is a solid GUI.

Using this, users can perform common mail tasks automatically by writing small
sieve scripts that are able to act on inbound mail before it reaches a user
Expand Down
Loading