[releases/25.x] [Email] Add email retrieval filters (#2425)

This pull request backports #2415 to releases/25.x Fixes [AB#550315](https://dynamicssmb2.visualstudio.com/1fcb79e7-ab07-432a-a3c6-6cf5a88ba4a5/_workitems/edit/550315) --------- Co-authored-by: Maria Zhelezova <[email protected]>
microsoft · Dec 3, 2024 · 09c57a4 · 09c57a4
1 parent 2c3b63c
commit 09c57a4
Show file tree

Hide file tree

Showing 20 changed files with 811 additions and 111 deletions.
diff --git a/.github/AL-Go-Settings.json b/.github/AL-Go-Settings.json
@@ -18,7 +18,8 @@
     "CLEAN22",
     "CLEAN23",
     "CLEAN24",
-    "CLEAN25"
+    "CLEAN25",
+    "CLEAN26"
   ],
   "unusedALGoSystemFiles": [
     "AddExistingAppOrTestApp.yaml",

diff --git a/src/System Application/App/DotNet Aliases/src/dotnet.al b/src/System Application/App/DotNet Aliases/src/dotnet.al
@@ -261,6 +261,16 @@ dotnet
         }
     }
 
+    assembly("Microsoft.Dynamics.Nav.AppHTMLSanitizer")
+    {
+        Culture = 'neutral';
+        PublicKeyToken = '31bf3856ad364e35';
+
+        type("Microsoft.Dynamics.Nav.AppHTMLSanitizer.AppHtmlSanitizer"; "AppHtmlSanitizer")
+        {
+        }
+    }
+
     assembly("Microsoft.Dynamics.Nav.AzureADGraphClient")
     {
         type("Microsoft.Dynamics.Nav.AzureADGraphClient.GroupInfoPage"; "GroupInfoPage")

diff --git a/src/System Application/App/Email/src/Account/EmailAccountImpl.Codeunit.al b/src/System Application/App/Email/src/Account/EmailAccountImpl.Codeunit.al
@@ -29,16 +29,16 @@ codeunit 8889 "Email Account Impl."
     var
         EmailAccounts: Record "Email Account";
         Connector: Enum "Email Connector";
-        IEmailConnector: Interface "Email Connector";
+        EmailConnector: Interface "Email Connector";
     begin
         TempEmailAccount.Reset();
         TempEmailAccount.DeleteAll();
 
         foreach Connector in Connector.Ordinals do begin
-            IEmailConnector := Connector;
+            EmailConnector := Connector;
 
             EmailAccounts.DeleteAll();
-            IEmailConnector.GetAccounts(EmailAccounts);
+            EmailConnector.GetAccounts(EmailAccounts);
 
             if EmailAccounts.FindSet() then
                 repeat

diff --git a/src/System Application/App/Email/src/Account/EmailAccounts.Page.al b/src/System Application/App/Email/src/Account/EmailAccounts.Page.al
@@ -387,8 +387,8 @@ page 8887 "Email Accounts"
         IsSelected := not IsNullGuid(SelectedAccountId);
 
         EmailAccount.GetAllAccounts(true, Rec); // Refresh the email accounts
-        if V2Filter then
-            FilterToConnectorv2Accounts(Rec);
+        if V2V3Filter then
+            FilterToConnectorv2v3Accounts(Rec);
         EmailScenario.GetDefaultEmailAccount(DefaultEmailAccount); // Refresh the default email account
 
         if IsSelected then begin
@@ -402,7 +402,7 @@ page 8887 "Email Accounts"
         CurrPage.Update(false);
     end;
 
-    local procedure FilterToConnectorv2Accounts(var EmailAccounts: Record "Email Account")
+    local procedure FilterToConnectorv2v3Accounts(var EmailAccounts: Record "Email Account")
     var
         IConnector: Interface "Email Connector";
     begin
@@ -411,7 +411,13 @@ page 8887 "Email Accounts"
 
         repeat
             IConnector := EmailAccounts.Connector;
-            if not (IConnector is "Email Connector v2") then
+#if not CLEAN26
+#pragma warning disable AL0432
+            if not (IConnector is "Email Connector v2") and not (IConnector is "Email Connector v3") then
+#pragma warning restore AL0432
+#else
+            if not (IConnector is "Email Connector v3") then
+#endif
                 EmailAccounts.Delete();
         until EmailAccounts.Next() = 0;
     end;
@@ -457,12 +463,24 @@ page 8887 "Email Accounts"
     end;
 
     /// <summary>
-    /// Filters the email accounts to only show accounts that are using the Email Connector v2.
+    /// Filters the email accounts to only show accounts that are using the Email Connector v2 or v3.
     /// </summary>
     /// <param name="Filter">True to filter the email accounts, false to show all email accounts</param>
-    procedure FilterConnectorV2Accounts(Filter: Boolean)
+#if not CLEAN26
+    [Obsolete('Replaced by FilterConnectorV3Accounts. In addition, this function now returns both v2 and v3 accounts.', '26.0')]
+    procedure FilterConnectorV2Accounts(UseFilter: Boolean)
     begin
-        V2Filter := Filter;
+        V2V3Filter := UseFilter;
+    end;
+#endif
+
+    /// <summary>
+    /// Filters the email accounts to only show accounts that are using the Email Connector v2 or v3.
+    /// </summary>
+    /// <param name="UseFilter">True to filter the email accounts, false to show all email accounts</param>
+    procedure FilterConnectorV3Accounts(UseFilter: Boolean)
+    begin
+        V2V3Filter := UseFilter;
     end;
 
     var
@@ -477,6 +495,6 @@ page 8887 "Email Accounts"
         ShowLogo: Boolean;
         IsLookupMode: Boolean;
         HasEmailAccount: Boolean;
-        V2Filter: Boolean;
+        V2V3Filter: Boolean;
         EmailConnectorHasBeenUninstalledMsg: Label 'The selected email extension has been uninstalled. To view information about the email account, you must reinstall the extension.';
 }
diff --git a/src/System Application/App/Email/src/Connector/DefaultEmailConnectorv2.Codeunit.al b/src/System Application/App/Email/src/Connector/DefaultEmailConnectorv2.Codeunit.al
@@ -8,8 +8,15 @@ namespace System.Email;
 /// <summary>
 /// This is the default implementation of the Email Connector v2 interface which adds the reply, retrievial of emails and marking them as read functionalities.
 /// </summary>
-codeunit 8998 "Default Email Connector v2" implements "Email Connector v2"
+#if not CLEAN26
+#pragma warning disable AL0432
+codeunit 8998 "Default Email Connector v2" implements "Email Connector v2", "Email Connector v3"
+#pragma warning restore AL0432
+#else
+codeunit 8998 "Default Email Connector v2" implements "Email Connector v3"
+#endif
 {
+
     procedure Send(EmailMessage: Codeunit "Email Message"; AccountId: Guid)
     begin
 
@@ -50,10 +57,18 @@ codeunit 8998 "Default Email Connector v2" implements "Email Connector v2"
 
     end;
 
+#if not CLEAN26
+    [Obsolete('Replaced by RetrieveEmails with an additional Filters parameter of type Record "Email Retrieval Filters".', '26.0')]
     procedure RetrieveEmails(AccountId: Guid; var EmailInbox: Record "Email Inbox")
     begin
 
     end;
+#endif
+
+    procedure RetrieveEmails(AccountId: Guid; var EmailInbox: Record "Email Inbox"; var Filters: Record "Email Retrieval Filters" temporary)
+    begin
+
+    end;
 
     procedure MarkAsRead(AccountId: Guid; ExternalId: Text)
     begin

diff --git a/src/System Application/App/Email/src/Connector/EmailConnector.Enum.al b/src/System Application/App/Email/src/Connector/EmailConnector.Enum.al
@@ -8,9 +8,18 @@ namespace System.Email;
 /// <summary>
 /// Enum that holds all of the available email connectors.
 /// </summary>
-enum 8889 "Email Connector" implements "Email Connector", "Email Connector v2", "Default Email Rate Limit"
+#if not CLEAN26
+#pragma warning disable AL0432
+enum 8889 "Email Connector" implements "Email Connector", "Email Connector v2", "Email Connector v3", "Default Email Rate Limit"
+#pragma warning restore AL0432
+#else
+enum 8889 "Email Connector" implements "Email Connector", "Email Connector v3", "Default Email Rate Limit"
+#endif
 {
     Extensible = true;
     DefaultImplementation = "Default Email Rate Limit" = "Default Email Rate Limit",
-                            "Email Connector v2" = "Default Email Connector v2";
+#if not CLEAN26
+                            "Email Connector v2" = "Default Email Connector v2",
+#endif
+                            "Email Connector v3" = "Default Email Connector v2";
 }
diff --git a/src/System Application/App/Email/src/Connector/EmailConnectorv2.Interface.al b/src/System Application/App/Email/src/Connector/EmailConnectorv2.Interface.al
@@ -1,3 +1,4 @@
+#if not CLEAN26
 // ------------------------------------------------------------------------------------------------
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
@@ -10,6 +11,10 @@ namespace System.Email;
 /// </summary>
 interface "Email Connector v2" extends "Email Connector"
 {
+    ObsoleteReason = 'Replaced by "Email Connector v3" which adds filtering capability for retrieval of emails';
+    ObsoleteState = Pending;
+    ObsoleteTag = '26.0';
+
     /// <summary>
     /// Reply to an e-mail using the provided account.
     /// </summary>
@@ -30,4 +35,5 @@ interface "Email Connector v2" extends "Email Connector"
     /// <param name="AccountId">The email account ID.</param>
     /// <param name="ExternalId">The external ID of the email.</param>
     procedure MarkAsRead(AccountId: Guid; ExternalId: Text);
-}
+}
+#endif
diff --git a/src/System Application/App/Email/src/Connector/EmailConnectorv3.Interface.al b/src/System Application/App/Email/src/Connector/EmailConnectorv3.Interface.al
@@ -0,0 +1,34 @@
+// ------------------------------------------------------------------------------------------------
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+// ------------------------------------------------------------------------------------------------
+
+namespace System.Email;
+
+/// <summary>
+/// An e-mail connector interface enhances the "Email Connector" with reading, replying to e-mails and marking emails as read.
+/// </summary>
+interface "Email Connector v3" extends "Email Connector"
+{
+    /// <summary>
+    /// Reply to an e-mail using the provided account.
+    /// </summary>
+    /// <param name="EmailMessage">The email message that is to be sent out.</param>
+    /// <param name="AccountId">The email account ID which is used to send out the email.</param>
+    procedure Reply(var EmailMessage: Codeunit "Email Message"; AccountId: Guid);
+
+    /// <summary>
+    /// Read e-mails from the provided account.
+    /// </summary>
+    /// <param name="AccountId">The email account ID which is used to send out the email.</param>
+    /// <param name="EmailInbox">The email inbox record that will store the emails.</param>
+    /// <param name="Filters">Filters to be used when retrieving emails.</param>
+    procedure RetrieveEmails(AccountId: Guid; var EmailInbox: Record "Email Inbox"; var Filters: Record "Email Retrieval Filters" temporary);
+
+    /// <summary>
+    /// Mark an e-mail as read in the provided account.
+    /// </summary>
+    /// <param name="AccountId">The email account ID.</param>
+    /// <param name="ExternalId">The external ID of the email.</param>
+    procedure MarkAsRead(AccountId: Guid; ExternalId: Text);
+}
diff --git a/src/System Application/App/Email/src/Email/Email.Codeunit.al b/src/System Application/App/Email/src/Email/Email.Codeunit.al
@@ -197,7 +197,7 @@ codeunit 8901 Email
     #endregion
 
     #region Reply
-
+#if not CLEAN26
     /// <summary>
     /// Sends a reply to an external message id in the foreground.
     /// </summary>
@@ -206,9 +206,10 @@ codeunit 8901 Email
     /// <param name="EmailAccountId">The ID of the email account to use for sending the email.</param>
     /// <param name="EmailConnector">The email connector to use for sending the email.</param>
     /// <returns>True if sent</returns>
+    [Obsolete('Replaced by Reply without the ExternalId parameter. ExternalId is not used and is contained in the EmailMessage parameter.', '26.0')]
     procedure Reply(EmailMessage: Codeunit "Email Message"; ExternalId: Text; EmailAccountId: Guid; EmailConnector: Enum "Email Connector"): Boolean
     begin
-        exit(EmailImpl.Reply(EmailMessage, ExternalId, EmailAccountId, EmailConnector));
+        exit(EmailImpl.Reply(EmailMessage, EmailAccountId, EmailConnector));
     end;
 
     /// <summary>
@@ -219,9 +220,10 @@ codeunit 8901 Email
     /// <param name="EmailAccountId">The ID of the email account to use for sending the email.</param>
     /// <param name="EmailConnector">The email connector to use for sending the email.</param>
     /// <returns>True if sent</returns>
+    [Obsolete('Replaced by ReplyAll without the ExternalId parameter. ExternalId is not used and is contained in the EmailMessage parameter.', '26.0')]
     procedure ReplyAll(EmailMessage: Codeunit "Email Message"; ExternalId: Text; EmailAccountId: Guid; EmailConnector: Enum "Email Connector"): Boolean
     begin
-        exit(EmailImpl.ReplyAll(EmailMessage, ExternalId, EmailAccountId, EmailConnector));
+        exit(EmailImpl.ReplyAll(EmailMessage, EmailAccountId, EmailConnector));
     end;
 
     /// <summary>
@@ -232,9 +234,10 @@ codeunit 8901 Email
     /// <param name="EmailAccountId">The ID of the email account to use for sending the email.</param>
     /// <param name="EmailConnector">The email connector to use for sending the email.</param>
     /// <param name="EmailOutbox">The email outbox which is set up for sending in the background.</param>
+    [Obsolete('Replaced by EnqueueReply without the ExternalId parameter. ExternalId is not used and is contained in the EmailMessage parameter.', '26.0')]
     procedure EnqueueReply(EmailMessage: Codeunit "Email Message"; ExternalId: Text; EmailAccountId: Guid; EmailConnector: Enum "Email Connector"; var EmailOutbox: Record "Email Outbox")
     begin
-        EmailImpl.Reply(EmailMessage, ExternalId, EmailAccountId, EmailConnector, EmailOutbox);
+        EmailImpl.Reply(EmailMessage, EmailAccountId, EmailConnector, EmailOutbox);
     end;
 
     /// <summary>
@@ -245,25 +248,88 @@ codeunit 8901 Email
     /// <param name="EmailAccountId">The ID of the email account to use for sending the email.</param>
     /// <param name="EmailConnector">The email connector to use for sending the email.</param>
     /// <param name="EmailOutbox">The email outbox which is set up for sending in the background.</param>
+    [Obsolete('Replaced by EnqueueReplyAll without the ExternalId parameter. ExternalId is not used and is contained in the EmailMessage parameter.', '26.0')]
     procedure EnqueueReplyAll(EmailMessage: Codeunit "Email Message"; ExternalId: Text; EmailAccountId: Guid; EmailConnector: Enum "Email Connector"; var EmailOutbox: Record "Email Outbox")
     begin
-        EmailImpl.ReplyAll(EmailMessage, ExternalId, EmailAccountId, EmailConnector, EmailOutbox);
+        EmailImpl.ReplyAll(EmailMessage, EmailAccountId, EmailConnector, EmailOutbox);
+    end;
+#endif
+
+    /// <summary>
+    /// Sends a reply to an external message id in the foreground.
+    /// </summary>
+    /// <param name="EmailMessage">The email message with the details of the recipients and reply to be added.</param>
+    /// <param name="EmailAccountId">The ID of the email account to use for sending the email.</param>
+    /// <param name="EmailConnector">The email connector to use for sending the email.</param>
+    /// <returns>True if sent</returns>
+    procedure Reply(EmailMessage: Codeunit "Email Message"; EmailAccountId: Guid; EmailConnector: Enum "Email Connector"): Boolean
+    begin
+        exit(EmailImpl.Reply(EmailMessage, EmailAccountId, EmailConnector));
+    end;
+
+    /// <summary>
+    /// Sends a reply to an external message id to all recipients on that email in the foreground.
+    /// </summary>
+    /// <param name="EmailMessage">The email message with the details of the recipients and reply to be added.</param>
+    /// <param name="EmailAccountId">The ID of the email account to use for sending the email.</param>
+    /// <param name="EmailConnector">The email connector to use for sending the email.</param>
+    /// <returns>True if sent</returns>
+    procedure ReplyAll(EmailMessage: Codeunit "Email Message"; EmailAccountId: Guid; EmailConnector: Enum "Email Connector"): Boolean
+    begin
+        exit(EmailImpl.ReplyAll(EmailMessage, EmailAccountId, EmailConnector));
+    end;
+
+    /// <summary>
+    /// Sends a reply to an external message id in the background.
+    /// </summary>
+    /// <param name="EmailMessage">The email message with the details of the recipients and reply to be added.</param>
+    /// <param name="EmailAccountId">The ID of the email account to use for sending the email.</param>
+    /// <param name="EmailConnector">The email connector to use for sending the email.</param>
+    /// <param name="EmailOutbox">The email outbox which is set up for sending in the background.</param>
+    procedure EnqueueReply(EmailMessage: Codeunit "Email Message"; EmailAccountId: Guid; EmailConnector: Enum "Email Connector"; var EmailOutbox: Record "Email Outbox")
+    begin
+        EmailImpl.Reply(EmailMessage, EmailAccountId, EmailConnector, EmailOutbox);
+    end;
+
+    /// <summary>
+    /// Sends a reply to an external message id to all recipients on that email in the foreground.
+    /// </summary>
+    /// <param name="EmailMessage">The email message with the details of the recipients and reply to be added.</param>
+    /// <param name="EmailAccountId">The ID of the email account to use for sending the email.</param>
+    /// <param name="EmailConnector">The email connector to use for sending the email.</param>
+    /// <param name="EmailOutbox">The email outbox which is set up for sending in the background.</param>
+    procedure EnqueueReplyAll(EmailMessage: Codeunit "Email Message"; EmailAccountId: Guid; EmailConnector: Enum "Email Connector"; var EmailOutbox: Record "Email Outbox")
+    begin
+        EmailImpl.ReplyAll(EmailMessage, EmailAccountId, EmailConnector, EmailOutbox);
     end;
 
     #endregion
 
     #region RetrieveEmails
-
+#if not CLEAN26
     /// <summary>
     /// Retrieves emails from the email account.
     /// </summary>
     /// <param name="EmailAccountId">The ID of the email account to use for sending the email.</param>
     /// <param name="EmailConnector">The email connector to use for sending the email.</param>
     /// <param name="EmailInbox">The return record of all new emails that were retrieved.</param>
+    [Obsolete('Replaced by RetrieveEmails with an additional Filters parameter of type Record "Email Retrieval Filters".', '26.0')]
     procedure RetrieveEmails(EmailAccountId: Guid; EmailConnector: Enum "Email Connector"; var EmailInbox: Record "Email Inbox")
     begin
         EmailImpl.RetrieveEmails(EmailAccountId, EmailConnector, EmailInbox);
     end;
+#endif
+    /// <summary>
+    /// Retrieves emails from the email account.
+    /// </summary>
+    /// <param name="EmailAccountId">The ID of the email account to use for sending the email.</param>
+    /// <param name="EmailConnector">The email connector to use for sending the email.</param>
+    /// <param name="EmailInbox">The return record of all new emails that were retrieved.</param>
+    /// <param name="Filters">Filters to be used when retrieving emails.</param>
+    procedure RetrieveEmails(EmailAccountId: Guid; EmailConnector: Enum "Email Connector"; var EmailInbox: Record "Email Inbox"; var Filters: Record "Email Retrieval Filters" temporary)
+    begin
+        EmailImpl.RetrieveEmails(EmailAccountId, EmailConnector, EmailInbox, Filters);
+    end;
 
     #endregion