✨(template) add view and modal to manage message template for a mailbox

Author: sdemagny

src/backend/core/api/openapi.json

@@ -2387,7 +2387,7 @@
         "/api/v1.0/mailboxes/{mailbox_id}/message-templates/": {
             "get": {
                 "operationId": "mailboxes_message_templates_list",
-                "description": "ViewSet for retrieving and rendering message templates for a mailbox.",
+                "description": "List message templates for a mailbox.",
                 "parameters": [
                     {
                         "in": "path",
@@ -2397,6 +2397,20 @@
                             "format": "uuid"
                         },
                         "required": true
+                    },
+                    {
+                        "in": "query",
+                        "name": "type",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "type": "string",
+                                "enum": [
+                                    "message",
+                                    "signature"
+                                ]
+                            }
+                        }
                     }
                 ],
                 "tags": [

src/backend/core/api/viewsets/message_template.py

@@ -103,6 +103,23 @@ def render_template(self, request, mailbox_id, pk=None):  # pylint: disable=unus
                 status=status.HTTP_400_BAD_REQUEST,
             )
 
+    @extend_schema(
+        responses=MessageTemplateSerializer(many=True),
+        description="List message templates for a mailbox.",
+        parameters=[
+            OpenApiParameter(
+                name="type",
+                type=OpenApiTypes.STR,
+                location=OpenApiParameter.QUERY,
+                enum=[c[1] for c in MessageTemplateTypeChoices.choices],
+                many=True,
+            ),
+        ],
+    )
+    def list(self, request, *args, **kwargs):
+        """List message templates for a mailbox."""
+        return super().list(request, *args, **kwargs)
+
 
 class AvailableMailboxMessageTemplateViewSet(
     mixins.ListModelMixin, viewsets.GenericViewSet

src/backend/core/urls.py

@@ -97,7 +97,7 @@
 )
 
 # Router for /mailboxes/{mailbox_id}/message-templates/available/
-# allow to insert the template into editor (new message, reply, signature)
+# allow to insert the template into editor (message, signature)
 mailbox_message_template_nested_router = DefaultRouter()
 mailbox_message_template_nested_router.register(
     r"message-templates/available",

src/backend/locale/fr_FR/LC_MESSAGES/django.po

@@ -743,10 +743,8 @@ msgstr ""
 "{html: str, text: str, raw: any}"
 
 #: core/models.py:1687
-#, fuzzy
-#| msgid "Type of template (reply, new_message, signature)"
 msgid "Type of template (message, signature)"
-msgstr "Type de modèle (réponse, nouveau message, signature)"
+msgstr "Type de modèle (message, signature)"
 
 #: core/models.py:1693
 msgid "Whether this template is available for use"

src/frontend/public/locales/common/en-US.json

@@ -48,6 +48,7 @@
   "Are you sure you want to delete this label? This action is irreversible!": "Are you sure you want to delete this label? This action is irreversible!",
   "Are you sure you want to delete this mailbox? This action is irreversible!": "Are you sure you want to delete this mailbox? This action is irreversible!",
   "Are you sure you want to delete this signature? This action is irreversible!": "Are you sure you want to delete this signature? This action is irreversible!",
+  "Are you sure you want to delete this template? This action is irreversible!": "Are you sure you want to delete this template? This action is irreversible!",
   "Are you sure you want to reset the password?": "Are you sure you want to reset the password?",
   "At least one recipient is required.": "At least one recipient is required.",
   "Attachments must be less than {{size}}.": "Attachments must be less than {{size}}.",
@@ -83,6 +84,7 @@
   "Create a new personal mailbox": "Create a new personal mailbox",
   "Create a new shared mailbox": "Create a new shared mailbox",
   "Create a new signature for {{domain}}": "Create a new signature for {{domain}}",
+  "Create a new template": "Create a new template",
   "Create a simple redirect (Coming soon)": "Create a simple redirect (Coming soon)",
   "Create the label \"{{label}}\"": "Create the label \"{{label}}\"",
   "create_mailbox_modal.success.credential_text": "Your Messages credentials are:\n- Email: {{id}}\n- Password: {{password}}\n\nIt will be asked to change your password at your first login.",
@@ -96,6 +98,7 @@
   "Delete label \"{{label}}\"": "Delete label \"{{label}}\"",
   "Delete mailbox {{mailbox}}": "Delete mailbox {{mailbox}}",
   "Delete signature \"{{signature}}\"": "Delete signature \"{{signature}}\"",
+  "Delete template \"{{template}}\"": "Delete template \"{{template}}\"",
   "Description": "Description",
   "Description must be less than 255 characters.": "Description must be less than 255 characters.",
   "Did you forget an attachment?": "Did you forget an attachment?",
@@ -115,15 +118,19 @@
   "Drop your attachments here": "Drop your attachments here",
   "Edit": "Edit",
   "Edit {{mailbox}} address": "Edit {{mailbox}} address",
+  "Edit template \"{{template}}\"": "Edit template \"{{template}}\"",
   "Email address": "Email address",
   "EML or MBOX": "EML or MBOX",
   "Enter the email addresses of the recipients separated by commas": "Enter the email addresses of the recipients separated by commas",
   "Error while checking DNS records": "Error while checking DNS records",
   "Error while loading addresses": "Error while loading addresses",
   "Error while loading signatures": "Error while loading signatures",
+  "Error while loading templates": "Error while loading templates",
   "Expand": "Expand",
   "Expand all": "Expand all",
+  "Failed to delete template.": "Failed to delete template.",
   "Failed to refresh summary.": "Failed to refresh summary.",
+  "Failed to save template. Please try again.": "Failed to save template. Please try again.",
   "Feedback?": "Feedback?",
   "First name": "First name",
   "First name is required.": "First name is required.",
@@ -171,6 +178,7 @@
   "Loading labels...": "Loading labels...",
   "Loading next threads...": "Loading next threads...",
   "Loading signatures...": "Loading signatures...",
+  "Loading templates...": "Loading templates...",
   "Loading variables...": "Loading variables...",
   "Logout": "Logout",
   "Mailbox {{mailbox}} has been deleted successfully.": "Mailbox {{mailbox}} has been deleted successfully.",
@@ -184,6 +192,7 @@
   "Mark as unread": "Mark as unread",
   "Mark as unread from here": "Mark as unread from here",
   "Message sent successfully": "Message sent successfully",
+  "Message templates": "Message templates",
   "Messaging": "Messaging",
   "Missing": "Missing",
   "Modify": "Modify",
@@ -198,6 +207,7 @@
   "New domain": "New domain",
   "New message": "New message",
   "New signature": "New signature",
+  "New template": "New template",
   "No accesses": "No accesses",
   "No attachments": "No attachments",
   "No DNS records found": "No DNS records found",
@@ -206,6 +216,7 @@
   "No signatures found": "No signatures found",
   "No subject": "No subject",
   "No summary available.": "No summary available.",
+  "No template found": "No template found",
   "No threads.": "No threads.",
   "Open filters": "Open filters",
   "Open the menu": "Open the menu",
@@ -267,6 +278,9 @@
   "Synchronize mailboxes with an identity provider": "Synchronize mailboxes with an identity provider",
   "Target": "Target",
   "Target email": "Target email",
+  "Template created!": "Template created!",
+  "Template deleted!": "Template deleted!",
+  "Template updated!": "Template updated!",
   "Temporary password": "Temporary password",
   "Thank you for your feedback!": "Thank you for your feedback!",
   "The address has been updated!": "The address has been updated!",

src/frontend/public/locales/common/fr-FR.json

@@ -48,6 +48,7 @@
   "Are you sure you want to delete this label? This action is irreversible!": "Êtes-vous sûr de vouloir supprimer ce libellé ? Cette action est irréversible !",
   "Are you sure you want to delete this mailbox? This action is irreversible!": "Êtes-vous sûr de vouloir supprimer cette boîte aux lettres ? Cette action est irréversible !",
   "Are you sure you want to delete this signature? This action is irreversible!": "Êtes-vous sûr de vouloir supprimer cette signature ? Cette action est irréversible !",
+  "Are you sure you want to delete this template? This action is irreversible!": "Êtes-vous sûr de vouloir supprimer ce modèle ? Cette action est irréversible !",
   "Are you sure you want to reset the password?": "Êtes-vous sûr de vouloir réinitialiser le mot de passe ?",
   "At least one recipient is required.": "Il faut au moins un destinataire.",
   "Attachments must be less than {{size}}.": "Les pièces jointes ne peuvent pas excéder {{size}}.",
@@ -83,6 +84,7 @@
   "Create a new personal mailbox": "Créer une nouvelle boîte personnelle",
   "Create a new shared mailbox": "Créer une nouvelle boîte partagée",
   "Create a new signature for {{domain}}": "Création d'une nouvelle signature pour {{domain}}",
+  "Create a new template": "Créer un nouveau modèle",
   "Create a simple redirect (Coming soon)": "Créer une simple redirection (Bientôt disponible)",
   "Create the label \"{{label}}\"": "Créer le libellé \"{{label}}\"",
   "create_mailbox_modal.success.credential_text": "Vos identifiants Messages sont : \n- Courriel : {{id}}\n- Mot de passe : {{password}}\n\nIl vous sera demandé de changer votre mot de passe lors de votre première connexion.",
@@ -96,6 +98,7 @@
   "Delete label \"{{label}}\"": "Supprimer le libellé \"{{label}}\"",
   "Delete mailbox {{mailbox}}": "Supprimer la boîte aux lettres {{mailbox}}",
   "Delete signature \"{{signature}}\"": "Supprimer la signature \"{{signature}}\"",
+  "Delete template \"{{template}}\"": "Supprimer le modèle \"{{template}}\"",
   "Description": "Description",
   "Description must be less than 255 characters.": "La description ne peut pas excéder 255 caractères.",
   "Did you forget an attachment?": "N'avez-vous pas oublié une pièce jointe ?",
@@ -115,15 +118,19 @@
   "Drop your attachments here": "Déposez vos pièces jointes ici",
   "Edit": "Modifier",
   "Edit {{mailbox}} address": "Modifier l'adresse {{mailbox}}",
+  "Edit template \"{{template}}\"": "Modifier le modèle \"{{template}}\"",
   "Email address": "Adresse mail",
   "EML or MBOX": "EML ou MBOX",
   "Enter the email addresses of the recipients separated by commas": "Entrez les adresses e-mail des destinataires séparés par des virgules",
   "Error while checking DNS records": "Erreur lors de la vérification des enregistrements DNS",
   "Error while loading addresses": "Erreur lors du chargement des adresses",
   "Error while loading signatures": "Erreur lors du chargement des signatures",
+  "Error while loading templates": "Erreur lors du chargement des modèles",
   "Expand": "Développer",
   "Expand all": "Tout développer",
+  "Failed to delete template.": "Erreur lors de la suppression du modèle.",
   "Failed to refresh summary.": "Erreur lors de la mise à jour du résumé.",
+  "Failed to save template. Please try again.": "Erreur lors de la sauvegarde du modèle. Veuillez réessayer.",
   "Feedback?": "Faire un retour",
   "First name": "Prénom",
   "First name is required.": "Le prénom est requis.",
@@ -171,6 +178,7 @@
   "Loading labels...": "Chargement des libellés...",
   "Loading next threads...": "Chargement des conversations suivantes...",
   "Loading signatures...": "Chargement des signatures...",
+  "Loading templates...": "Chargement des modèles...",
   "Loading variables...": "Chargement des variables...",
   "Logout": "Déconnexion",
   "Mailbox {{mailbox}} has been deleted successfully.": "La boîte aux lettres {{mailbox}} a été supprimée avec succès.",
@@ -184,6 +192,7 @@
   "Mark as unread": "Marquer comme non lu",
   "Mark as unread from here": "Marquer comme non lu à partir d'ici",
   "Message sent successfully": "Message envoyé avec succès",
+  "Message templates": "Modèles de message",
   "Messaging": "Messages",
   "Missing": "Manquant",
   "Modify": "Modifier",
@@ -198,6 +207,7 @@
   "New domain": "Nouveau domaine",
   "New message": "Nouveau message",
   "New signature": "Nouvelle signature",
+  "New template": "Nouveau modèle",
   "No accesses": "Aucun accès",
   "No attachments": "Aucune pièce jointe",
   "No DNS records found": "Aucun enregistrement DNS trouvé",
@@ -206,6 +216,7 @@
   "No signatures found": "Aucune signature trouvée",
   "No subject": "Aucun objet",
   "No summary available.": "Aucun résumé disponible.",
+  "No template found": "Aucun modèle trouvé",
   "No threads.": "Aucune conversation.",
   "Open filters": "Ouvrir les filtres",
   "Open the menu": "Ouvrir le menu",
@@ -267,6 +278,9 @@
   "Synchronize mailboxes with an identity provider": "Synchroniser les boîtes aux lettres avec un fournisseur d'identité",
   "Target": "Cible",
   "Target email": "Adresse de destination",
+  "Template created!": "Modèle créé !",
+  "Template deleted!": "Modèle supprimé !",
+  "Template updated!": "Modèle mis à jour !",
   "Temporary password": "Mot de passe temporaire",
   "Thank you for your feedback!": "Merci pour votre message !",
   "The address has been updated!": "L'adresse a été mise à jour !",

src/frontend/src/features/api/gen/mailboxes/mailboxes.ts

@@ -25,6 +25,7 @@ import type {
   Mailbox,
   MailboxLight,
   MailboxesMessageTemplatesAvailableListParams,
+  MailboxesMessageTemplatesListParams,
   MailboxesMessageTemplatesRenderRetrieve200,
   MailboxesSearchListParams,
   MessageTemplate,
@@ -183,7 +184,7 @@ export function useMailboxesList<
 }
 
 /**
- * ViewSet for retrieving and rendering message templates for a mailbox.
+ * List message templates for a mailbox.
  */
 export type mailboxesMessageTemplatesListResponse200 = {
   data: MessageTemplate[];
@@ -198,32 +199,55 @@ export type mailboxesMessageTemplatesListResponse =
     headers: Headers;
   };
 
-export const getMailboxesMessageTemplatesListUrl = (mailboxId: string) => {
-  return `/api/v1.0/mailboxes/${mailboxId}/message-templates/`;
+export const getMailboxesMessageTemplatesListUrl = (
+  mailboxId: string,
+  params?: MailboxesMessageTemplatesListParams,
+) => {
+  const normalizedParams = new URLSearchParams();
+
+  Object.entries(params || {}).forEach(([key, value]) => {
+    if (value !== undefined) {
+      normalizedParams.append(key, value === null ? "null" : value.toString());
+    }
+  });
+
+  const stringifiedParams = normalizedParams.toString();
+
+  return stringifiedParams.length > 0
+    ? `/api/v1.0/mailboxes/${mailboxId}/message-templates/?${stringifiedParams}`
+    : `/api/v1.0/mailboxes/${mailboxId}/message-templates/`;
 };
 
 export const mailboxesMessageTemplatesList = async (
   mailboxId: string,
+  params?: MailboxesMessageTemplatesListParams,
   options?: RequestInit,
 ): Promise<mailboxesMessageTemplatesListResponse> => {
   return fetchAPI<mailboxesMessageTemplatesListResponse>(
-    getMailboxesMessageTemplatesListUrl(mailboxId),
+    getMailboxesMessageTemplatesListUrl(mailboxId, params),
     {
       ...options,
       method: "GET",
     },
   );
 };
 
-export const getMailboxesMessageTemplatesListQueryKey = (mailboxId: string) => {
-  return [`/api/v1.0/mailboxes/${mailboxId}/message-templates/`] as const;
+export const getMailboxesMessageTemplatesListQueryKey = (
+  mailboxId: string,
+  params?: MailboxesMessageTemplatesListParams,
+) => {
+  return [
+    `/api/v1.0/mailboxes/${mailboxId}/message-templates/`,
+    ...(params ? [params] : []),
+  ] as const;
 };
 
 export const getMailboxesMessageTemplatesListQueryOptions = <
   TData = Awaited<ReturnType<typeof mailboxesMessageTemplatesList>>,
   TError = unknown,
 >(
   mailboxId: string,
+  params?: MailboxesMessageTemplatesListParams,
   options?: {
     query?: Partial<
       UseQueryOptions<
@@ -239,12 +263,15 @@ export const getMailboxesMessageTemplatesListQueryOptions = <
 
   const queryKey =
     queryOptions?.queryKey ??
-    getMailboxesMessageTemplatesListQueryKey(mailboxId);
+    getMailboxesMessageTemplatesListQueryKey(mailboxId, params);
 
   const queryFn: QueryFunction<
     Awaited<ReturnType<typeof mailboxesMessageTemplatesList>>
   > = ({ signal }) =>
-    mailboxesMessageTemplatesList(mailboxId, { signal, ...requestOptions });
+    mailboxesMessageTemplatesList(mailboxId, params, {
+      signal,
+      ...requestOptions,
+    });
 
   return {
     queryKey,
@@ -268,6 +295,7 @@ export function useMailboxesMessageTemplatesList<
   TError = unknown,
 >(
   mailboxId: string,
+  params: undefined | MailboxesMessageTemplatesListParams,
   options: {
     query: Partial<
       UseQueryOptions<
@@ -295,6 +323,7 @@ export function useMailboxesMessageTemplatesList<
   TError = unknown,
 >(
   mailboxId: string,
+  params?: MailboxesMessageTemplatesListParams,
   options?: {
     query?: Partial<
       UseQueryOptions<
@@ -322,6 +351,7 @@ export function useMailboxesMessageTemplatesList<
   TError = unknown,
 >(
   mailboxId: string,
+  params?: MailboxesMessageTemplatesListParams,
   options?: {
     query?: Partial<
       UseQueryOptions<
@@ -342,6 +372,7 @@ export function useMailboxesMessageTemplatesList<
   TError = unknown,
 >(
   mailboxId: string,
+  params?: MailboxesMessageTemplatesListParams,
   options?: {
     query?: Partial<
       UseQueryOptions<
@@ -358,6 +389,7 @@ export function useMailboxesMessageTemplatesList<
 } {
   const queryOptions = getMailboxesMessageTemplatesListQueryOptions(
     mailboxId,
+    params,
     options,
   );
 

src/frontend/src/features/api/gen/models/index.ts

@@ -67,6 +67,8 @@ export * from "./mailbox_role_choices";
 export * from "./mailboxes_accesses_list_params";
 export * from "./mailboxes_message_templates_available_list_params";
 export * from "./mailboxes_message_templates_available_list_type";
+export * from "./mailboxes_message_templates_list_params";
+export * from "./mailboxes_message_templates_list_type_item";
 export * from "./mailboxes_message_templates_render_retrieve200";
 export * from "./mailboxes_search_list_params";
 export * from "./maildomain_access_read";