Codeunit 8892 Email Scenario Impl.

System Application, System.Email

src/System Application/App/Email/src/Scenario/EmailScenarioImpl.Codeunit.al341 lines, Copyright (c) Microsoft Corporation. MIT

// ------------------------------------------------------------------------------------------------// 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;using System;codeunit 8892 "Email Scenario Impl."{    Access = Internal;    InherentPermissions = X;    InherentEntitlements = X;    Permissions = tabledata "Email Scenario" = rimd;    procedure GetEmailAccount(Scenario: Enum "Email Scenario"; var EmailAccount: Record "Email Account"): Boolean    var        EmailScenario: Record "Email Scenario";        TempAllEmailAccounts: Record "Email Account";        EmailAccounts: Codeunit "Email Account";    begin        EmailAccounts.GetAllAccounts(TempAllEmailAccounts);        // Find the account for the provided scenario        if EmailScenario.Get(Scenario) then            if TempAllEmailAccounts.Get(EmailScenario."Account Id", EmailScenario.Connector) then begin                EmailAccount := TempAllEmailAccounts;                exit(true);            end;        // Fallback to the default account if the scenario isn't mapped or the mapped account doesn't exist        if EmailScenario.Get(Enum::"Email Scenario"::Default) then            if TempAllEmailAccounts.Get(EmailScenario."Account Id", EmailScenario.Connector) then begin                EmailAccount := TempAllEmailAccounts;                exit(true);            end;        exit(false);    end;    procedure IsThereEmailAccountSetForScenario(Scenario: Enum "Email Scenario"): Boolean    var        EmailScenario: Record "Email Scenario";    begin        exit(EmailScenario.Get(Scenario));    end;    procedure SetEmailAccount(Scenario: Enum "Email Scenario"; EmailAccount: Record "Email Account")    var        EmailScenario: Record "Email Scenario";    begin        if not EmailScenario.Get(Scenario) then begin            EmailScenario.Scenario := Scenario;            EmailScenario.Insert();        end;        EmailScenario."Account Id" := EmailAccount."Account Id";        EmailScenario.Connector := EmailAccount.Connector;        EmailScenario.Modify();    end;    procedure UnassignScenario(Scenario: Enum "Email Scenario")    var        EmailScenario: Record "Email Scenario";    begin        if EmailScenario.Get(Scenario) then            EmailScenario.Delete();    end;    /// <summary>    /// Get a list of entries, representing a tree structure with email accounts and the scenarios, assigned to each accout.    /// </summary>    /// <example>    /// Account sales@cronus.com has scenarios "Sales Quote" and "Sales Credit Memo" assigned.    /// Account purchase@cronus.com has scenarios "Purchase Quote" and "Purchase Invoice" assigned.    /// The result of calling the function will be:    /// sales@cronus.com, "Sales Quote", "Sales Credit Memo", purchase@cronus.com, "Purchase Quote", "Purchase Invoice"    /// </example>    /// <param name="Result">A flatten tree structure representing the all the email accounts and the scenarios assigned to them.</param>    procedure GetScenariosByEmailAccount(var Result: Record "Email Account Scenario")    var        TempEmailAccounts: Record "Email Account";        TempEmailAccountScenarios: Record "Email Account Scenario";        TempDefaultAccount: Record "Email Account";        EmailAccount: Codeunit "Email Account";        DisplayName: Text[2048];        Position: Integer;        Default: Boolean;    begin        Result.Reset();        Result.DeleteAll();        EmailAccount.GetAllAccounts(TempEmailAccounts);        if not TempEmailAccounts.FindSet() then            exit; // No accounts, nothing to do        // The position is set in order to be able to properly sort the entries (by order of insertion)        Position := 1;        GetDefaultAccount(TempDefaultAccount);        repeat            Default := (TempEmailAccounts."Account Id" = TempDefaultAccount."Account Id") and (TempEmailAccounts.Connector = TempDefaultAccount.Connector);            DisplayName := StrSubstNo(AccountDisplayLbl, TempEmailAccounts.Name, TempEmailAccounts."Email Address");            // Add entry for the email account. Scenario is -1, because it isn't needed when displaying the email account.            AddEntry(Result, Result.EntryType::Account, -1, TempEmailAccounts."Account Id", TempEmailAccounts.Connector, DisplayName, Default, Position);            // Get the email scenarios assigned to the current email account, sorted by "Display Name"            GetEmailScenariosForAccount(TempEmailAccounts, TempEmailAccountScenarios);            if TempEmailAccountScenarios.FindSet() then                repeat                    // Add entry for every scenario that is assigned to the current email account                    AddEntry(Result, TempEmailAccountScenarios.EntryType::Scenario, TempEmailAccountScenarios.Scenario, TempEmailAccountScenarios."Account Id", TempEmailAccountScenarios.Connector, TempEmailAccountScenarios."Display Name", false, Position);                until TempEmailAccountScenarios.Next() = 0;        until TempEmailAccounts.Next() = 0;        // Order by position to show accurate results        Result.SetCurrentKey(Position);    end;    local procedure GetEmailScenariosForAccount(EmailAccount: Record "Email Account"; var EmailAccountScenarios: Record "Email Account Scenario")    var        EmailScenarios: Record "Email Scenario";        ValidEmailScenarios: DotNet Hashtable;        IsScenarioValid: Boolean;        Scenario: Integer;    begin        EmailAccountScenarios.Reset();        EmailAccountScenarios.DeleteAll();        // Get all email scenarios assigned to the email account        EmailScenarios.SetRange("Account Id", EmailAccount."Account Id");        EmailScenarios.SetRange(Connector, EmailAccount.Connector);        if not EmailScenarios.FindSet() then            exit;        // Find all valid scenarios. Invalid scenario may occur if the extension that added them was removed.        ValidEmailScenarios := ValidEmailScenarios.Hashtable();        foreach Scenario in Enum::"Email Scenario".Ordinals() do            ValidEmailScenarios.Add(Scenario, Scenario);        // Convert Email Scenario-s to Email Account Scenario-s so they can be sorted by "Display Name"        repeat            IsScenarioValid := ValidEmailScenarios.Contains(EmailScenarios.Scenario.AsInteger());            // Add entry for every scenario that exists and uses the email account. Skip the default scenario.            if (EmailScenarios.Scenario <> Enum::"Email Scenario"::Default) and IsScenarioValid then begin                EmailAccountScenarios.Scenario := EmailScenarios.Scenario.AsInteger();                EmailAccountScenarios."Account Id" := EmailScenarios."Account Id";                EmailAccountScenarios.Connector := EmailScenarios.Connector;                EmailAccountScenarios."Display Name" := Format(EmailScenarios.Scenario);                EmailAccountScenarios.Insert();            end;        until EmailScenarios.Next() = 0;        EmailAccountScenarios.SetCurrentKey("Display Name"); // sort scenarios by "Display Name"    end;    local procedure AddEntry(var Result: Record "Email Account Scenario"; EntryType: Option; Scenario: Integer; AccountId: Guid; Connector: Enum "Email Connector"; DisplayName: Text[2048]; Default: Boolean; var Position: Integer)    begin        // Add entry to the result while maintaining the position so that the tree represents the data correctly        Result.EntryType := EntryType;        Result.Scenario := Scenario;        Result."Account Id" := AccountId;        Result.Connector := Connector;        Result."Display Name" := DisplayName;        Result.Default := Default;        Result.Position := Position;        Result.Insert();        Position := Position + 1;    end;    procedure AddScenarios(EmailAccount: Record "Email Account Scenario"): Boolean    var        EmailScenario: Record "Email Scenario";        TempSelectedScenarios: Record "Email Account Scenario";        ScenariosForAccount: Page "Email Scenarios for Account";    begin        EmailAccountImpl.CheckPermissions();        if EmailAccount.EntryType <> EmailAccount.EntryType::Account then // wrong entry, the entry should be of type "Account"            exit;        ScenariosForAccount.Caption := StrSubstNo(ScenariosForAccountCaptionTxt, EmailAccount."Display Name");        ScenariosForAccount.LookupMode(true);        ScenariosForAccount.SetRecord(EmailAccount);        if ScenariosForAccount.RunModal() <> Action::LookupOK then            exit(false);        ScenariosForAccount.GetSelectedScenarios(TempSelectedScenarios);        if not TempSelectedScenarios.FindSet() then            exit(false);        repeat            if not EmailScenario.Get(TempSelectedScenarios.Scenario) then begin                EmailScenario."Account Id" := EmailAccount."Account Id";                EmailScenario.Connector := EmailAccount.Connector;                EmailScenario.Scenario := Enum::"Email Scenario".FromInteger(TempSelectedScenarios.Scenario);                EmailScenario.Insert();            end else begin                EmailScenario."Account Id" := EmailAccount."Account Id";                EmailScenario.Connector := EmailAccount.Connector;                EmailScenario.Modify();            end;        until TempSelectedScenarios.Next() = 0;        exit(true);    end;    procedure GetAvailableScenariosForAccount(EmailAccount: Record "Email Account Scenario"; var EmailScenarios: Record "Email Account Scenario"; IncludeDefaultEmailScenario: Boolean)    var        Scenario: Record "Email Scenario";        EmailScenario: Codeunit "Email Scenario";        CurrentScenario, i : Integer;        IsAvailable: Boolean;    begin        EmailScenarios.Reset();        EmailScenarios.DeleteAll();        i := 1;        foreach CurrentScenario in Enum::"Email Scenario".Ordinals() do begin            Clear(Scenario);            Scenario.SetRange("Account Id", EmailAccount."Account Id");            Scenario.SetRange(Connector, EmailAccount.Connector);            Scenario.SetRange(Scenario, CurrentScenario);            // If the scenario isn't already connected to the email account, then it's available. We can choose to skip the default scenario.            // We skip the default scenario when assigning scenarios to account            // We include the default scenario when attaching attachments to scenarios            if IncludeDefaultEmailScenario then                IsAvailable := Scenario.IsEmpty()            else                IsAvailable := Scenario.IsEmpty() and (not (CurrentScenario = Enum::"Email Scenario"::Default.AsInteger()));            // If the scenario is available, allow partner to determine if it should be shown            if IsAvailable then                EmailScenario.OnBeforeInsertAvailableEmailScenario(Enum::"Email Scenario".FromInteger(CurrentScenario), IsAvailable);            if IsAvailable then begin                EmailScenarios."Account Id" := EmailAccount."Account Id";                EmailScenarios.Connector := EmailAccount.Connector;                EmailScenarios.Scenario := CurrentScenario;                EmailScenarios."Display Name" := Format(Enum::"Email Scenario".FromInteger(Enum::"Email Scenario".Ordinals().Get(i)));                EmailScenarios.Insert();            end;            i := i + 1;        end;    end;    procedure ChangeAccount(var EmailScenario: Record "Email Account Scenario"): Boolean    var        TempSelectedAccount: Record "Email Account";        Scenario: Record "Email Scenario";        EmailAccount: Codeunit "Email Account";        AccountsPage: Page "Email Accounts";    begin        EmailAccountImpl.CheckPermissions();        if not EmailScenario.FindSet() then            exit(false);        EmailAccount.GetAllAccounts(false, TempSelectedAccount);        if TempSelectedAccount.Get(EmailScenario."Account Id", EmailScenario.Connector) then;        AccountsPage.EnableLookupMode();        AccountsPage.SetRecord(TempSelectedAccount);        AccountsPage.Caption := ChangeEmailAccountForScenarioTxt;        if AccountsPage.RunModal() <> Action::LookupOK then            exit(false);        AccountsPage.GetAccount(TempSelectedAccount);        if IsNullGuid(TempSelectedAccount."Account Id") then // defensive check, no account was selected            exit;        repeat            if Scenario.Get(EmailScenario.Scenario) then begin                Scenario."Account Id" := TempSelectedAccount."Account Id";                Scenario.Connector := TempSelectedAccount.Connector;                Scenario.Modify();            end;        until EmailScenario.Next() = 0;        exit(true);    end;    procedure DeleteScenario(var EmailScenario: Record "Email Account Scenario"): Boolean    var        Scenario: Record "Email Scenario";    begin        EmailAccountImpl.CheckPermissions();        if not EmailScenario.FindSet() then            exit(false);        repeat            if EmailScenario.EntryType = EmailScenario.EntryType::Scenario then begin                Scenario.SetRange(Scenario, EmailScenario.Scenario);                Scenario.SetRange("Account Id", EmailScenario."Account Id");                Scenario.SetRange(Connector, EmailScenario.Connector);                Scenario.DeleteAll();            end;        until EmailScenario.Next() = 0;        exit(true);    end;    local procedure GetDefaultAccount(var EmailAccount: Record "Email Account")    var        Scenario: Record "Email Scenario";    begin        if not Scenario.Get(Enum::"Email Scenario"::Default) then            exit;        EmailAccount."Account Id" := Scenario."Account Id";        EmailAccount.Connector := Scenario.Connector;    end;    var        EmailAccountImpl: Codeunit "Email Account Impl.";        AccountDisplayLbl: Label '%1 (%2)', Locked = true;        ChangeEmailAccountForScenarioTxt: Label 'Change e-mail account used for the selected scenarios';        ScenariosForAccountCaptionTxt: Label 'Assign scenarios to account %1', Comment = '%1 = the name of the e-mail accout, e.g. Notification Account (notification@cronus.com)';}