libervia-backend/libervia/backend/tools/common/email.py
Goffi e8b3948ad0 plugin misc account: fix send_email calls + admin email flag:
The `send_email` calls in `send_emails` passed the plugin `EmailSettings` as the `config`
argument, raising `AttributeError` on account creation and leading to the profile
deletion.

They now pass the main config via a new `email_settings`.

`credentials_xmpp_connect` takes a new `send_email` flag to let frontends skip the admin
notification email (notably useful in web local mode).
2026-11-04 09:47:04 +01:00

89 lines
3.1 KiB
Python

#!/usr/bin/env python3
# SàT: a jabber client
# Copyright (C) 2009-2026 Jérôme Poisson (goffi@goffi.org)
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""email sending facilities"""
from email.mime.text import MIMEText
from twisted.internet import defer
from twisted.mail import smtp
from libervia.backend.tools import config as tools_config
from libervia.backend.core.log import getLogger
log = getLogger(__name__)
def send_email(
config: tools_config.Settings,
to_emails: list[str] | str,
subject: str = "",
body: str = "",
from_email: str | None = None,
email_settings: tools_config.EmailSettings | None = None,
) -> defer.Deferred:
"""Send an email using Libervia configuration
@param config: the configuration instance
@param to_emails: list of recipients
if unicode, it will be split to get emails
@param subject: subject of the message
@param body: body of the message
@param from_email: address of the sender
@param email_settings: ``EmailSettings`` to use, default to ``config.email``
@return:Same as smtp.sendmail.
"""
if isinstance(to_emails, str):
to_emails = to_emails.split()
settings = email_settings or config.email
email_host = settings.server
email_from = from_email or settings.from_
# we suppose that email domain and XMPP domain are identical
domain = config.common.xmpp_domain
if domain is None:
if email_from is not None:
domain = email_from.split("@", 1)[-1]
else:
domain = "example.net"
if email_from is None:
email_from = "no_reply@" + domain
email_sender_domain = settings.sender_domain or domain
email_port = settings.port
email_username = settings.username
email_password = settings.password
email_auth = settings.auth
email_starttls = settings.starttls
msg = MIMEText(body, "plain", "UTF-8")
msg["Subject"] = subject
msg["From"] = email_from
msg["To"] = ", ".join(to_emails)
return smtp.sendmail(
email_host.encode("utf-8"),
email_from.encode("utf-8"),
[email.encode("utf-8") for email in to_emails],
msg.as_bytes(),
senderDomainName=email_sender_domain if email_sender_domain else None,
port=email_port,
username=email_username.encode("utf-8") if email_username else None,
password=email_password.encode("utf-8") if email_password else None,
requireAuthentication=email_auth,
requireTransportSecurity=email_starttls,
)