aboutsummaryrefslogtreecommitdiff
path: root/webmentions_ssg/cli/mail.py
blob: 47687e288d4c5e1753e3a4618e61784b4a0acce2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
#
# SPDX-License-Identifier: BSD-3-Clause

"""Provide a command for testing outgoing email configuration."""

import click
from flask import current_app
from flask.cli import AppGroup
from flask_mail import Message

from .. import MAIL

MAIL_CLI = AppGroup("mail", help="Handle mail")


@MAIL_CLI.command("test", help="Send an email to test the SMTP configuration")
@click.option(
    "--to", "recipient", help="Recipient address (defaults to NOTIFICATION_EMAIL)."
)
def send_test_mail(recipient: str | None) -> None:
    """
    Send a test email using the configured SMTP server.

    :param recipient: Optional recipient overriding NOTIFICATION_EMAIL.
    :raises click.ClickException: If configuration is missing or sending fails.
    """
    recipient = recipient or current_app.config.get("NOTIFICATION_EMAIL")
    if not recipient:
        raise click.ClickException(
            "No recipient specified. Set NOTIFICATION_EMAIL or pass --to."
        )

    sender = current_app.config.get("MAIL_DEFAULT_SENDER")
    if not sender:
        raise click.ClickException("MAIL_DEFAULT_SENDER is not configured.")

    message = Message(
        subject="webmentions-ssg: test email",
        sender=sender,
        recipients=[recipient],
        body=(
            "This is a test email from webmentions-ssg.\n\n"
            "If you received this message, the outgoing mail configuration works.\n"
        ),
    )

    try:
        MAIL.send(message)
    except Exception as exc:
        raise click.ClickException(f"Could not send test email: {exc}") from exc

    click.echo(f"Test email sent to {recipient}.")