Source code for web.views.mailbox_views.MailboxEmailsFilterView

# SPDX-License-Identifier: AGPL-3.0-or-later
#
# Eonvelope - a open-source self-hostable email archiving server
# Copyright (C) 2024 David Aderbauer & The Eonvelope Contributors
#
# 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 <https://www.gnu.org/licenses/>.

"""Module with the :class:`web.views.MailboxEmailsFilterView` view."""

from __future__ import annotations

from typing import TYPE_CHECKING, Any, override

from django.views.generic.detail import SingleObjectMixin

from core.models import Email, Mailbox
from web.views.email_views import EmailFilterView

if TYPE_CHECKING:
    from django.db.models import QuerySet




class MailboxEmailsFilterView(EmailFilterView, SingleObjectMixin):  # type: ignore[misc]  # SingleObjectMixin attributes are shadowed purposefully
    """View for filtering listed :class:`core.models.Email` instances belonging to a certain mailbox."""

    URL_NAME = "mailbox-emails"
    template_name = "web/mailbox/mailbox_email_filter_list.html"



    @override
    def get_queryset(self) -> QuerySet[Email]:
        mailbox_queryset = Mailbox.objects.filter(account__user=self.request.user)  # type: ignore[misc]  # user auth is checked by LoginRequiredMixin, we also test for this
        self.object = self.get_object(queryset=mailbox_queryset)
        return super().get_queryset().filter(mailbox=self.object)




    @override
    def get_context_data(self, **kwargs: Any) -> dict[str, Any]:
        context = super().get_context_data(**kwargs)
        context["mailbox"] = self.object
        return context