Mercurial > libervia-backend

annotate libervia/backend/tools/common/email.py @ 4163:3b3cd9453d9b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
plugin XEP-0308: implement Last Message Correction
author Goffi <goffi@goffi.org>
date Tue, 28 Nov 2023 17:38:31 +0100
parents 4b842c1fb686
children b0c36f3d3e04
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2953
diff changeset
1 #!/usr/bin/env python3
3137
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
2
2181
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
3
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
4 # SàT: a jabber client
3479
be6d91572633 date update
Goffi <goffi@goffi.org>
parents: 3465
diff changeset
5 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
2181
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
6
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # This program is free software: you can redistribute it and/or modify
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
10 # (at your option) any later version.
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
11
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # This program is distributed in the hope that it will be useful,
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
15 # GNU Affero General Public License for more details.
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
16
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
19
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
20 """email sending facilities"""
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
21
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2953
diff changeset
22
2953
3caf460bc125 tools (email): moved email code to common so it can be used by frontends
Goffi <goffi@goffi.org>
parents: 2951
diff changeset
23 from email.mime.text import MIMEText
3caf460bc125 tools (email): moved email code to common so it can be used by frontends
Goffi <goffi@goffi.org>
parents: 2951
diff changeset
24 from twisted.mail import smtp
4071
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4037
diff changeset
25 from libervia.backend.core.constants import Const as C
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4037
diff changeset
26 from libervia.backend.tools import config as tools_config
4b842c1fb686 refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents: 4037
diff changeset
27 from libervia.backend.core.log import getLogger
3465
1c7f4ce6a4a2 tools (common/email): try to guess sender domain when necessary:
Goffi <goffi@goffi.org>
parents: 3137
diff changeset
28
1c7f4ce6a4a2 tools (common/email): try to guess sender domain when necessary:
Goffi <goffi@goffi.org>
parents: 3137
diff changeset
29 log = getLogger(__name__)
2181
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
30
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
31
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3780
diff changeset
32 def send_email(config, to_emails, subject="", body="", from_email=None):
2953
3caf460bc125 tools (email): moved email code to common so it can be used by frontends
Goffi <goffi@goffi.org>
parents: 2951
diff changeset
33 """Send an email using SàT configuration
2181
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
34
2953
3caf460bc125 tools (email): moved email code to common so it can be used by frontends
Goffi <goffi@goffi.org>
parents: 2951
diff changeset
35 @param config (SafeConfigParser): the configuration instance
2304
666ad9de044c core (tools/email): an unicode "to" email (instead of a list) can now be used
Goffi <goffi@goffi.org>
parents: 2181
diff changeset
36 @param to_emails(list[unicode], unicode): list of recipients
666ad9de044c core (tools/email): an unicode "to" email (instead of a list) can now be used
Goffi <goffi@goffi.org>
parents: 2181
diff changeset
37 if unicode, it will be split to get emails
2181
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
38 @param subject(unicode): subject of the message
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
39 @param body(unicode): body of the message
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
40 @param from_email(unicode): address of the sender
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
41 @return (D): same as smtp.sendmail
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
42 """
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2953
diff changeset
43 if isinstance(to_emails, str):
2304
666ad9de044c core (tools/email): an unicode "to" email (instead of a list) can now be used
Goffi <goffi@goffi.org>
parents: 2181
diff changeset
44 to_emails = to_emails.split()
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3780
diff changeset
45 email_host = tools_config.config_get(config, None, "email_server") or "localhost"
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3780
diff changeset
46 email_from = from_email or tools_config.config_get(config, None, "email_from")
3780
2c187445a3d3 tools (common/email): use `from_email` is specified, always set `email_sender_domain`
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
47
2c187445a3d3 tools (common/email): use `from_email` is specified, always set `email_sender_domain`
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
48 # we suppose that email domain and XMPP domain are identical
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3780
diff changeset
49 domain = tools_config.config_get(config, None, "xmpp_domain")
3780
2c187445a3d3 tools (common/email): use `from_email` is specified, always set `email_sender_domain`
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
50 if domain is None:
2c187445a3d3 tools (common/email): use `from_email` is specified, always set `email_sender_domain`
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
51 if email_from is not None:
2c187445a3d3 tools (common/email): use `from_email` is specified, always set `email_sender_domain`
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
52 domain = email_from.split("@", 1)[-1]
2c187445a3d3 tools (common/email): use `from_email` is specified, always set `email_sender_domain`
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
53 else:
2c187445a3d3 tools (common/email): use `from_email` is specified, always set `email_sender_domain`
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
54 domain = "example.net"
2c187445a3d3 tools (common/email): use `from_email` is specified, always set `email_sender_domain`
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
55
2181
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
56 if email_from is None:
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2953
diff changeset
57 email_from = "no_reply@" + domain
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3780
diff changeset
58 email_sender_domain = tools_config.config_get(
3780
2c187445a3d3 tools (common/email): use `from_email` is specified, always set `email_sender_domain`
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
59 config, None, "email_sender_domain", domain
2c187445a3d3 tools (common/email): use `from_email` is specified, always set `email_sender_domain`
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
60 )
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3780
diff changeset
61 email_port = int(tools_config.config_get(config, None, "email_port", 25))
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3780
diff changeset
62 email_username = tools_config.config_get(config, None, "email_username")
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3780
diff changeset
63 email_password = tools_config.config_get(config, None, "email_password")
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3780
diff changeset
64 email_auth = C.bool(tools_config.config_get(config, None, "email_auth", C.BOOL_FALSE))
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3780
diff changeset
65 email_starttls = C.bool(tools_config.config_get(config, None, "email_starttls",
2953
3caf460bc125 tools (email): moved email code to common so it can be used by frontends
Goffi <goffi@goffi.org>
parents: 2951
diff changeset
66 C.BOOL_FALSE))
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
67
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
68 msg = MIMEText(body, "plain", "UTF-8")
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2953
diff changeset
69 msg["Subject"] = subject
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2953
diff changeset
70 msg["From"] = email_from
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2953
diff changeset
71 msg["To"] = ", ".join(to_emails)
2181
968b0d13bcc7 plugin account, tools: some cleaning account + email and password tools:
Goffi <goffi@goffi.org>
parents:
diff changeset
72
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
73 return smtp.sendmail(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
74 email_host.encode("utf-8"),
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
75 email_from.encode("utf-8"),
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
76 [email.encode("utf-8") for email in to_emails],
3034
ca6c695c65da tools (common/email): fixed email sending after python 3 port
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
77 msg.as_bytes(),
3465
1c7f4ce6a4a2 tools (common/email): try to guess sender domain when necessary:
Goffi <goffi@goffi.org>
parents: 3137
diff changeset
78 senderDomainName=email_sender_domain if email_sender_domain else None,
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
79 port=email_port,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
80 username=email_username.encode("utf-8") if email_username else None,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
81 password=email_password.encode("utf-8") if email_password else None,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
82 requireAuthentication=email_auth,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
83 requireTransportSecurity=email_starttls,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
84 )