Source code for web.views.email_views.EmailFilterView

# 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.EmailFilterView` view."""

from __future__ import annotations

from typing import TYPE_CHECKING, override

from django.contrib.auth.mixins import LoginRequiredMixin

from core.models import Email
from web.filters import EmailFilterSet
from web.views.base import FilterPageView

if TYPE_CHECKING:
    from django.db.models import QuerySet




class EmailFilterView(LoginRequiredMixin, FilterPageView):
    """View for filtering listed :class:`core.models.Email` instances."""

    URL_NAME = Email.get_list_web_url_name()
    model = Email
    template_name = "web/email/email_filter_list.html"
    context_object_name = "emails"
    filterset_class = EmailFilterSet
    ordering = ["-is_favorite", "-datetime"]



    @override
    def get_queryset(self) -> QuerySet[Email]:
        """Restricts the queryset to objects owned by the requesting user."""
        return (
            super()
            .get_queryset()
            .filter(mailbox__account__user=self.request.user)
            .select_related("mailbox", "mailbox__account")
        )