Change Email From Address to Queue using Environment Variable in JavaScript

Dec 5, 2023 • 3 • 519

Table of contents

Scenario
Preparations
Environment variable
Create a webresource with a JavaScript file
Form Events
End result
Idea

Special thanks to Kevin Hendricks and Jan-Frederik Kobus for their support in implementing this scenario.

Scenario

The scenario of the blog is related to the email entity of a Model Driven app. The goal is to use a shared mailbox to send emails from instead of the personal address of the current user. The case is to automatically change the From address and be able to have a flexible setup for different queue ids.

Preparations

To prepare the mailbox it needs to be set-up and approved as a queue.

Queue

Environment variable

Create an environment variable named Outgoing Queue ID to store the queue ID. This allows for easy deployment of the solution to multiple environments, each having a different queue ID.

Environment variable

Create a webresource with a JavaScript file

Create a Javascript with the following content:

Change ‘demo_outgoingqueueid’ with the internal name of your environment variable.

Change ‘Test Mailbox’ with the name of the mailbox you want to use.

var MAILBOX;
(function (MAILBOX) {
    var Email;
    (function (Email) {
        let FORM_CONTEXT;
        let GLOBAL_CONTEXT;
        let FORM_ID;
        let FORM_TYPE;
        function onFormLoad(executionContext) {
            console.log('OnFormLoad Triggered');
            FORM_CONTEXT = executionContext.getFormContext();
            GLOBAL_CONTEXT = Xrm.Utility.getGlobalContext();
            FORM_ID = FORM_CONTEXT.ui.formSelector.getCurrentItem() != null ? FORM_CONTEXT.ui.formSelector.getCurrentItem().getId().toUpperCase() : "";
            FORM_TYPE = FORM_CONTEXT.ui.getFormType();
            FORM_CONTEXT.data.entity.addOnSave(function () { onFormSave(); });
            addOnchangeFunctionsToAttributes();

            setFromOutgoingQueue();
        }
        Email.onFormLoad = onFormLoad;
        function onFormSave(executionContext) {
            console.log('onFormSave Triggered');
        }
        Email.onFormSave = onFormSave;
        function addOnchangeFunctionsToAttributes() {
            console.log('addOnchangeFunctionsToAttributes Triggered');
        }
        Email.addOnchangeFunctionsToAttributes = addOnchangeFunctionsToAttributes;
        async function setFromOutgoingQueue() {
            let fromAttribute = FORM_CONTEXT.getAttribute("from");
            if (fromAttribute == null)
				return;
			
			let queueId = await retrieveEnvironmentVariable("demo_outgoingqueueid")
                .catch(error => showDialog("Error", error.message));
            if (queueId == null || queueId === "") 
				return;
			
			fromAttribute.setValue([{ id: queueId, name: "Test Mailbox", entityType: "queue" }]);
        }
        Email.setFromOutgoingQueue = setFromOutgoingQueue;
		async function retrieveEnvironmentVariable(environmentVariableSchemaName) {
			return new Promise((resolve, reject) => {
				var parameters = {};
				parameters.DefinitionSchemaName = environmentVariableSchemaName;

				var retrieveEnvironmentVariableValueRequest = {
					DefinitionSchemaName: parameters.DefinitionSchemaName,

					getMetadata: function() {
						return {
							boundParameter: null,
							parameterTypes: {
								"DefinitionSchemaName": {
									"typeName": "Edm.String",
									"structuralProperty": 1
								}
							},
							operationType: 1,
							operationName: "RetrieveEnvironmentVariableValue"
						};
					}
				};

				Xrm.WebApi.online.execute(retrieveEnvironmentVariableValueRequest).then(
					function success(result) {
						if (result.ok) {
							result.json().then(
								function (response) {
									resolve(response["Value"]);
								}
							);
						}
					},
					function(error) {
						reject(error.message);
					}
				);
			});
		}
        Email.retrieveMultipleRecords = retrieveMultipleRecords;	
		async function showDialog(title, message) {
			var alertStrings = { confirmButtonLabel: "OK", text: message, title: title };
			var alertOptions = { height: 320, width: 460 };
			Xrm.Navigation.openAlertDialog(alertStrings, alertOptions);
		}
        Email.showDialog = showDialog;	
    })(Email = MAILBOX.Email || (MAILBOX.Email = {}));
})(MAILBOX || (MAILBOX = {}));

Form Events

Go to the events on the Email form and add an Event Handler. Select Add library.

Event Handler

Select ‘New web resource’

New web resource

Upload the JavaScript file and ‘Save and publish’. Upload JavaScript

Select the newly added webresource to add to the Email form. Add JavaScript

Configure the event using the right settings.

Publish the changes and test the Email form!

End result

The final outcome is an email form where the From address is seamlessly set to the shared mailbox queue instead of the user who is logged in, eliminating the need for manual switching and searching. End result

Idea

In this version of the script and setup only the queue id of the mail is an environment variable, an idea is to also have the name of the mailbox as an environment variable, i.e. ‘outgoing mailbox’.