Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Matrix
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Container Registry
Model registry
Operate
Environments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
TeDomum
Matrix
Commits
ac3cc323
Unverified
Commit
ac3cc323
authored
5 years ago
by
Brendan Abolivier
Browse files
Options
Downloads
Patches
Plain Diff
Make account validity renewal emails work when email notifs are disabled
parent
ddd30f44
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
changelog.d/5341.bugfix
+1
-0
1 addition, 0 deletions
changelog.d/5341.bugfix
synapse/config/emailconfig.py
+57
-42
57 additions, 42 deletions
synapse/config/emailconfig.py
with
58 additions
and
42 deletions
changelog.d/5341.bugfix
0 → 100644
+
1
−
0
View file @
ac3cc323
Fix a bug where account validity renewal emails could only be sent when email notifs were enabled.
This diff is collapsed.
Click to expand it.
synapse/config/emailconfig.py
+
57
−
42
View file @
ac3cc323
# -*- coding: utf-8 -*-
# Copyright 2015, 2016 OpenMarket Ltd
# Copyright 2015-2016 OpenMarket Ltd
# Copyright 2017-2018 New Vector Ltd
# Copyright 2019 The Matrix.org Foundation C.I.C.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
...
...
@@ -29,12 +31,49 @@ logger = logging.getLogger(__name__)
class
EmailConfig
(
Config
):
def
read_config
(
self
,
config
):
# TODO: We should separate better the email configuration from the notification
# and account validity config.
self
.
email_enable_notifs
=
False
email_config
=
config
.
get
(
"
email
"
,
{})
self
.
email_smtp_host
=
email_config
.
get
(
"
smtp_host
"
,
None
)
self
.
email_smtp_port
=
email_config
.
get
(
"
smtp_port
"
,
None
)
self
.
email_smtp_user
=
email_config
.
get
(
"
smtp_user
"
,
None
)
self
.
email_smtp_pass
=
email_config
.
get
(
"
smtp_pass
"
,
None
)
self
.
require_transport_security
=
email_config
.
get
(
"
require_transport_security
"
,
False
)
if
"
app_name
"
in
email_config
:
self
.
email_app_name
=
email_config
[
"
app_name
"
]
else
:
self
.
email_app_name
=
"
Matrix
"
self
.
email_notif_from
=
email_config
.
get
(
"
notif_from
"
,
None
)
# make sure it's valid
parsed
=
email
.
utils
.
parseaddr
(
self
.
email_notif_from
)
if
self
.
email_notif_from
and
parsed
[
1
]
==
''
:
raise
RuntimeError
(
"
Invalid notif_from address
"
)
template_dir
=
email_config
.
get
(
"
template_dir
"
)
# we need an absolute path, because we change directory after starting (and
# we don't yet know what auxilliary templates like mail.css we will need).
# (Note that loading as package_resources with jinja.PackageLoader doesn't
# work for the same reason.)
if
not
template_dir
:
template_dir
=
pkg_resources
.
resource_filename
(
'
synapse
'
,
'
res/templates
'
)
self
.
email_template_dir
=
os
.
path
.
abspath
(
template_dir
)
self
.
email_enable_notifs
=
email_config
.
get
(
"
enable_notifs
"
,
False
)
account_validity_renewal_enabled
=
config
.
get
(
"
account_validity
"
,
{},
).
get
(
"
renew_at
"
)
if
self
.
email_enable_notifs
:
if
self
.
email_enable_notifs
or
account_validity_renewal_enabled
:
# make sure we can import the required deps
import
jinja2
import
bleach
...
...
@@ -42,6 +81,7 @@ class EmailConfig(Config):
jinja2
bleach
if
self
.
email_enable_notifs
:
required
=
[
"
smtp_host
"
,
"
smtp_port
"
,
...
...
@@ -66,34 +106,13 @@ class EmailConfig(Config):
"
email.enable_notifs is True but no public_baseurl is set
"
)
self
.
email_smtp_host
=
email_config
[
"
smtp_host
"
]
self
.
email_smtp_port
=
email_config
[
"
smtp_port
"
]
self
.
email_notif_from
=
email_config
[
"
notif_from
"
]
self
.
email_notif_template_html
=
email_config
[
"
notif_template_html
"
]
self
.
email_notif_template_text
=
email_config
[
"
notif_template_text
"
]
self
.
email_expiry_template_html
=
email_config
.
get
(
"
expiry_template_html
"
,
"
notice_expiry.html
"
,
)
self
.
email_expiry_template_text
=
email_config
.
get
(
"
expiry_template_text
"
,
"
notice_expiry.txt
"
,
)
template_dir
=
email_config
.
get
(
"
template_dir
"
)
# we need an absolute path, because we change directory after starting (and
# we don't yet know what auxilliary templates like mail.css we will need).
# (Note that loading as package_resources with jinja.PackageLoader doesn't
# work for the same reason.)
if
not
template_dir
:
template_dir
=
pkg_resources
.
resource_filename
(
'
synapse
'
,
'
res/templates
'
)
template_dir
=
os
.
path
.
abspath
(
template_dir
)
for
f
in
self
.
email_notif_template_text
,
self
.
email_notif_template_html
:
p
=
os
.
path
.
join
(
template_dir
,
f
)
p
=
os
.
path
.
join
(
self
.
email_
template_dir
,
f
)
if
not
os
.
path
.
isfile
(
p
):
raise
ConfigError
(
"
Unable to find email template file %s
"
%
(
p
,
))
self
.
email_template_dir
=
template_dir
self
.
email_notif_for_new_users
=
email_config
.
get
(
"
notif_for_new_users
"
,
True
...
...
@@ -101,29 +120,25 @@ class EmailConfig(Config):
self
.
email_riot_base_url
=
email_config
.
get
(
"
riot_base_url
"
,
None
)
self
.
email_smtp_user
=
email_config
.
get
(
"
smtp_user
"
,
None
)
self
.
email_smtp_pass
=
email_config
.
get
(
"
smtp_pass
"
,
None
)
self
.
require_transport_security
=
email_config
.
get
(
"
require_transport_security
"
,
False
)
if
"
app_name
"
in
email_config
:
self
.
email_app_name
=
email_config
[
"
app_name
"
]
else
:
self
.
email_app_name
=
"
Matrix
"
# make sure it's valid
parsed
=
email
.
utils
.
parseaddr
(
self
.
email_notif_from
)
if
parsed
[
1
]
==
''
:
raise
RuntimeError
(
"
Invalid notif_from address
"
)
else
:
self
.
email_enable_notifs
=
False
# Not much point setting defaults for the rest: it would be an
# error for them to be used.
if
account_validity_renewal_enabled
:
self
.
email_expiry_template_html
=
email_config
.
get
(
"
expiry_template_html
"
,
"
notice_expiry.html
"
,
)
self
.
email_expiry_template_text
=
email_config
.
get
(
"
expiry_template_text
"
,
"
notice_expiry.txt
"
,
)
for
f
in
self
.
email_expiry_template_text
,
self
.
email_expiry_template_html
:
p
=
os
.
path
.
join
(
self
.
email_template_dir
,
f
)
if
not
os
.
path
.
isfile
(
p
):
raise
ConfigError
(
"
Unable to find email template file %s
"
%
(
p
,
))
def
default_config
(
self
,
config_dir_path
,
server_name
,
**
kwargs
):
return
"""
# Enable sending emails for notification events or expiry notices
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment