.
# Validating Emails using Service Suite Scripts
1. Create a Script in Service suite as shown below:
2. Please refer the below document if the outlook account as 2FA authentication:
[How to create an App Password for an Outlook account and use in service suite script to login to account with 2FA enabled. ](/books/services-workbench-knowledge-base/page/create-an-app-password-for-an-outlook-account-and-use-in-service-suite-script-to-login-to-account-with-2fa-enabled)
Note: Below is the spec on AIQ mail client
### Mail Client
>createMailClient(String host, String userMail, String password, String protocol)
returns a MailService object.
>MailService object has the following available methods:
- login()
- setFromFolder(String:folder)
- logout()
- getLastUnreadMessages(int:quantity)
- getAllRecipients();
- getFrom();
- message.getSentDate();
- message.getFolder()
- MailMessage byte\[\] getAttachedFile(String fileName)
· List<String> getAttachments() //You can get a list with all the names of the attachments from a MailMessage and you can get the file (byte\[\]) using the file name.
### Sample code snippet
```
var mailClient = createMailClient("imap.gmail.com", "myEmail@gmail.com", "App Password", "IMAP");
try{
mailClient.login();
}
catch (e){
mailClient.login();
}
log("Login Outlook Account");
mailClient.setFromFolder("Inbox");
log("Navigate to the Inbox folder");
//mailClient.setFromFolder("Junk Email");
var lastUnreadMails = mailClient.getLastUnreadMessages(5);
var url;
var attachments;
//log(lastUnreadMails.size());
for(var i = 0; i < lastUnreadMails.size(); i++){
if(lastUnreadMails.get(i). getFrom(). contains("Appvance")){
log("Fetch the url from this subject" + lastUnreadMails.get(i).getSubject());
log("From "+lastUnreadMails.get(i).getFrom());
log("Date "+lastUnreadMails.get(i).getSentDate());
log("Folder "+lastUnreadMails.get(i).getFolder());
log("getRecipients "+lastUnreadMails.get(i).getRecipients());
log("Fetch the url from this body" + lastUnreadMails.get(i).getBody());
attachments = lastUnreadMails.get(i).getAttachments();
for(var j = 0; j < attachments.size(); j++){
log("Attachment name: "+attachments.get(j));
var bytes = lastUnreadMails.get(i).getAttachedFile(attachments.get(j));
locker.put("bytes",bytes);
writeBytes("newBytes.pdf", bytes);
}
//code = urlify(lastUnreadMails.get(i).getBody());
}
// log("Fetch the url from this body" + lastUnreadMails.get(i).getSubject());
}
mailClient.logout();
```
```
var mailClient = createMailClient("imap.outlook.com", "aiqtest@outlook.com", "password", "IMAP");
mailClient.login();
mailClient.setFromFolder("Inbox");
var lastUnreadMails = mailClient.getLastUnreadMessages(1);
var url = "";
var from=lastUnreadMails.get(0).getFrom().contains("Appvance");
log(from);
```
---
Last updated: June 02, 2023
If you have any feedback on this topic, please contact us at
# Microsoft Graph: Send, Read, Reply, and Delete Email in Service Suite
# Microsoft Graph: Send, Read, Reply, and Delete Email in Service Suite
Use this article when a Service Suite workflow needs to validate Microsoft Graph email operations in an approved test mailbox. Do not run destructive email actions against real customer or employee mailboxes unless the customer has explicitly approved the test.
## Configuration checklist
- Use a dedicated test mailbox and a Microsoft Entra ID app registration approved for the workflow.
- Grant only the Graph permissions required for send, read, reply, or delete operations.
- Store client secrets, certificates, or tokens in secured variables or an approved secret store.
- Use test subjects, correlation IDs, or message metadata so the workflow finds the correct email.
- Separate read-only validation from delete or cleanup steps.
## Validation workflow
1. Confirm token acquisition and Graph endpoint access with the test mailbox.
2. Send or locate a controlled test message.
3. Validate the response status, message ID, subject, recipient, and body fields needed by the test.
4. Reply or delete only the controlled message created for the test run.
5. Review logs to confirm secrets and message content are not exposed unnecessarily.
*Last updated: October 8, 2026*
# Sample Service Suite Scripts
Here are some Service Suite samples scripts that can be used as a reference.
### Basic Authentication
```
```
```
/**
* btoa
* @param st
* @returns base64 encoded string
*/
function btoa(st) {
return Java.type("java.util.Base64").getEncoder().encode(st);
}
var $username = "admin";
var $password = "Password@1";
var $TOKEN = "Basic "+btoa($username+":"+$password);
addGlobalHeader("authorization", $TOKEN);
var url = "https://someServer.com/api/somecall";
var data = {"short_description":"some data",
"description":"some description"};
var call = createPost(url, data);
call.addHeader("Content-Type", "application/json");
var resp = process(call);
```
```
```
```
var formPage = get("https://demosite.appvance.com/products/ruby-on-rails-tote");
log(getCookies("https://demosite.appvance.com/"));
var token = extract("html",formPage,'//form[@action="/orders/populate"]/input[@name="authenticity_token"]/@value');
log("Extracted token: "+token);
var form = formData();
form.put("authenticity_token",token);
form.put("utf-8",decodeURIComponent("%E2%9C%93"));
form.put("variant_id","1");
form.put("quantity","1");
form.put("button","");
var postData = createPost("https://demosite.appvance.com/orders/populate",form);
var purchaseResults = process(postData);
log("response:\n"+purchaseResults.getDataString());
assertContains(get("https://demosite.appvance.com/cart?variant_id=1").getDataString(),"Ruby on Rails Tote");
assertContains(get("https://demosite.appvance.com/cart_link").getDataString(),"$15.99");
```
```
$baseURL = "http://localhost:8080";
var $loginForm = formData();
$loginForm.put("username","appvance");
$loginForm.put("password","appvance");
var $call = createPost($baseURL+"/AppvanceServer/rest/admin/loggin", $loginForm);
var $resp = process($call);
var $json = JSON.parse($resp.getDataString());
if ($json.logged) {
var $jsession = getCookieValue($baseURL,"JSESSIONID");
addGlobalHeader("cookie","JSESSIONID="+$jsession); // adding global cookie for JSESSIONID
log("Logged In, JSESSIONID: "+$jsesssion);
} else {
log("Unsuccessful login");
}
```
```
var payload = "John123-1341-123";
var call = createPost("https://example.com/getAddress", payload, "text/xml");
var result = process(call);
var address1 = extract("XML", result, "//Address1");
var city = extract("XML", result, "//City");
var state = extract("XML", result, "//ST");
```
```
const $boundary = "AIQ-DS-BOUNDARY";
function login($baseURL, $username, $password) {
var $loginForm = formData();
$loginForm.put("username",$username);
$loginForm.put("password",$password);
var $call = createPost($baseURL + "/AppvanceServer/rest/admin/logginForServices", $loginForm);
var $resp = process($call).getDataString();
if ($resp.indexOf("true") != -1) {
var $jsession = getCookieValue($baseURL,"JSESSIONID");
addGlobalHeader("cookie","JSESSION=" + $jsession);
log("Login successful")
return true;
} else {
log("Login was NOT successful")
return false;
}
}
function createMultipartPayload($filename) {
var header = '--' + $boundary + '\n' +
'Content-Disposition: form-data; name="file"; filename="' + $filename + '"\r\n' +
'Content-Type: application/octet-stream\r\n\r\n';
var headerBytes = new Array(header.length);
for (var i = 0; i < header.length; ++i) {
headerBytes[i] = header.charCodeAt(i);
}
var docBytes = readBytes($filename);
var footer = '\r\n--' + $boundary + "--\r\n";
var footerBytes = new Array(footer.length);
for (var i = 0; i < footer.length; ++i) {
footerBytes[i] = footer.charCodeAt(i);
}
return headerBytes.concat(docBytes).concat(footerBytes);
}
var $filename = "test2.js"; // CHANGE FOR YOUR FILE TO UPLOAD
var $repositoryName = "test"; // CHANGE FOR YOUR REPO NAME, THIS CONF MUST BE IN THE USER ACCOUNT USED TO LOGIN
var $username = "appvance";
var $password = "appvance";
login("http://my-aiq-controller.appvance.com:8080", $username, $password); // CHANGE FOR YOUR AIQ SERVER DNS
var data = createMultipartPayload($filename);
log(data.length, $username, $password);
var call= createPost("http://localhost:8080/AppvanceServer/rest/file/uploadFile?&commitMessage=Appvance+skip+commit&path=REPOSITORY/"+$repositoryName+"/"+$filename, data, "multipart/form-data", " boundary=" + $boundary);
var resp = process(call);
log(resp.getDataString())
```
```
/**
* Creates a multipart payload from file contentes
**/
function createMultipartPayload($filename) {
var header = '--' + $boundary + '\n' +
'Content-Disposition: form-data; name="file"; filename="' + $filename + '"\r\n' +
'Content-Type: application/octet-stream\r\n\r\n';
var headerBytes = new Array(header.length);
for (var i = 0; i < header.length; ++i) {
headerBytes[i] = header.charCodeAt(i);
}
var docBytes = readBytes($filename);
var footer = '\r\n--' + $boundary + "--\r\n";
var footerBytes = new Array(footer.length);
for (var i = 0; i < footer.length; ++i) {
footerBytes[i] = footer.charCodeAt(i);
}
return headerBytes.concat(docBytes).concat(footerBytes);
}
/*
* Uploads a file to $SERVER
*/
function uploadFile($filename) {
var data = createMultipartPayload($filename);
var url = $SERVER+ "/upload/"+$filename+"?filename="+$filename;
log("url: "+url);
var call= createPut(url, data, "multipart/form-data", " boundary=" + $boundary);
return process(call).getDataString();
}
const $boundary = "AIQ-DS-BOUNDARY";
const $SERVER = "http://xxxx.eu-west-2.elb.amazonaws.com";
var $filename = "test2.js"; // CHANGE FOR YOUR FILE TO UPLOAD
var result = uploadFile($filename);
log(result);
```
```
var date = new Date();
var formatDate = date.getDate() + "-" + date.getMonth() + "-" + date.getYear() + " " + date.toLocaleTimeString();
var graphService = createOAuthMailClient("email", "clientID", "secretKey", "tenantID");
var msg = graphService.createMailMessage("Message generated " + formatDate, "Test body email.");
msg.addTo(["to@test.com"]);
var sent = graphService.sendMessage(msg);
if (!sent) {
throw new Error('An error occurred while sending the email.');
} else {
log("Email sent.");
}
```
```
var graphService = createOAuthMailClient("email", "clientID", "secretKey", "tenantID");
var unreadList = graphService.getUnreadMessages();
var unreadCount = unreadList.size();
if (unreadCount > 0) {
var i = 0; //first unread email
log("Id: " + unreadList.get(i).id);
log("From: " + unreadList.get(i).from.emailAddress.address);
log("Subject: " + unreadList.get(i).subject);
var subject = unreadList.get(i).subject;
var startIndex = subject.lastIndexOf("Ref. ") + 5;
var refCode = subject.substr(startIndex, 8);
log("Ref code: " + refCode);
```
```
var expectedBody = "This is an automated acknowledgement to let you know that your correspondence to the Appvance Information Rights Team has been received.Any request for personal data will be handled as a data subject access request.";
var body = unreadList.get(i).body.content.replace(/(\r\n|\n|\r)/gm,""); //remove line break and spaces.
body = body.substr(0,body.indexOf("uk")+2); //trim to remove links at the end
log("Email have the expected content: " + (body === expectedBody));
} else {
log("There's no unread messages.");
}
```
```
/**
* btoa
* @param st
* @returns base64 encoded string
*/
function btoa(st) {
return Java.type(java.util.Base64).getEncoder().encode(st);
}
/**
* atob
* @param st
* @returns decoded base64 string
*/
function atob(st) {
return Java.type(java.util.Base64).getDecoder().decode(st);
}
/**
*
* @param length number
* @returns random number of length number of digits
*/
function randomNumber(length) {
var result = '';
for (var i = 0; i < length; i++) {
result += Math.floor(Math.random() * 10);
}
return result;
}
/**
* Extracts catching an exception and returning NOT_FOUND string if target is not found.
* @param {string} format ("HTML","HTTP","PDF","CSV","Excel","TEXT","STRING")
* @param {HttpResponse} response
* @param {string} target
* @returns
*/
function extractOrNotFound(format, response, target) {
const NOT_FOUND = "Not found.";
var value;
try {
value = extract(format, response, target);
if (typeof value == "undefined") {
return NOT_FOUND;
}
return value;
} catch (e) {
return NOT_FOUND;
}
}
/**
* SSN
* @returns random string matching social security number format
*/
function SSN() {
var result = '';
result = randomNumber(3) + "-" + randomNumber(2) + "-" + randomNumber(4);
return result;
}
// *************************************************************************
// parseCurrencyStringToNumber
//
// Parse a currency string to a number, $1,245.50 -> 1245.5
// ************************************************************************
function parseCurrencyStringToNumber(currency) {
if (typeof currency == "undefined" || currency == "") {
log("Warning in parseCurrencyStringToNumber, expecting a number but got undefined or empty.");
return -1;
}
if (currency == "0") {
return 0;
}
if (currency.indexOf("(") !== -1) {
currency = "-" + currency.replace(/[(|)]+/g, "")
}
return Number(String(currency).replace(/[^0-9.-]+/g, ""));
}
// *************************************************************************
// parseNumberToCurrency
//
// Parse a number to a string currency with commas, 1245.5 -> $1,245.50
// ************************************************************************
function parseNumberToCurrency(aNumber) {
if (aNumber == 0) {
return ("$0.00");
};
var tempST = String(aNumber).replace(/[^0-9.-]+/g, "");
try {
var tempNumber = Number(parseFloat(tempST).toFixed(2));
var tempLocale = tempNumber.toLocaleString(undefined, { minimumFractionDigits: 2 });
return "$" + tempLocale;
} catch (e) {
log("Error converting to currency [" + aNumber + "], isNAN: " + isNaN(aNumber) + " - " + e.message);
return "NA";
}
}
/**
* dateToString
* @param day
* @returns
*/
function dateToString(day) {
var dd = String(day.getDate()).padStart(2, '0');
var mm = String(day.getMonth() + 1).padStart(2, '0'); //January is 0!
var yyyy = day.getFullYear();
return mm + '/' + dd + '/' + yyyy;;
}
function getTodayDate() {
var now = java.time.LocalDateTime.now();
var formatter = java.time.format.DateTimeFormatter.ofPattern("MM/dd/yyyy");
return now.withHour(0).withMinute(0).withSecond(0).format(formatter);
}
function getYesterdayDate() {
var now = java.time.LocalDateTime.now();
var formatter = java.time.format.DateTimeFormatter.ofPattern("MM/dd/yyyy");
return now.minus(1, java.time.temporal.ChronoUnit.DAYS).withHour(0).withMinute(0)
.withSecond(0).format(formatter);
}
function getTomorrowDate() {
var now = java.time.LocalDateTime.now();
var formatter = java.time.format.DateTimeFormatter.ofPattern("MM/dd/yyyy");
return now.plus(1, java.time.temporal.ChronoUnit.DAYS).withHour(0).withMinute(0)
.withSecond(0).format(formatter);
}
/**
* getDateISOString
* @returns
*/
function getDateISOString() {
var st = new Date().toISOString();
return st.replace(/\-/g, "_").replace(/\:/g, "_").replace(/\./g, "_");
}
/**
* dateOneMonthAfter
* @param $date
* @returns
*/
function dateOneMonthAfter($date) {
var day = new Date(Date.parse($date));
day.setMonth(day.getMonth() + 1);
day.setTime(day.getTime() + TIME_OFFSET);
return dateToString(day);
}
/**
* dateOneYearAfter
* @param $date
* @returns
*/
function dateOneYearAfter($date) {
var day = new Date(Date.parse($date));
day.setFullYear(day.getFullYear() + 1);
day.setTime(day.getTime() + TIME_OFFSET);
return dateToString(day);
}
/**
* randomLastName
* @returns
*/
function randomLastName() {
var sylabs = 2 + Math.floor(Math.random() * 2)
var result = '';
var characters = 'bccdfghjkllmnnprrssttvwyz';
var vocals = 'aeioeua';
var charactersLength = characters.length;
result += "SBCLKJMCH".charAt(Math.floor(Math.random() * 9));
result += vocals.charAt(Math.floor(Math.random() * 7));
sylabs--;
for (var i = 0; i < sylabs; i++) {
result += characters.charAt(Math.floor(Math.random() * charactersLength));
result += vocals.charAt(Math.floor(Math.random() * 7));
}
result += characters.charAt(Math.floor(Math.random() * charactersLength));
return result;
}
```
---
Last updated: June 02, 2023
If you have any feedback on this topic, please contact us at
# Run Node.js npm Code from Service Suite
# Run Node.js npm Code from Service Suite
Use this guidance when a Service Suite scenario needs to call Node.js code or an npm package. Keep package execution controlled, repeatable, and limited to approved dependencies.
## Before execution
- Confirm the package is approved for the AIQ environment.
- Pin dependency versions through the approved package-management process.
- Keep credentials, tokens, and environment-specific values out of source files and articles.
- Document expected input, output, exit code, stdout, and stderr behavior.
## Validation workflow
1. Run the Node.js code with a small local or non-production sample.
2. Confirm Service Suite can locate the script and dependencies.
3. Review output and failures before using the package in a suite or scheduled run.
4. Record dependency changes with the scenario maintenance notes.
**Last updated:** September 8, 2026
# Send Email from Service Suite
Use this article when a Service Suite workflow needs to send email through an approved mail provider or internal SMTP path.
## What changed in this article
- Updated the email article around approved Service Suite email workflows and mail-provider controls.
- Added checks for SMTP/API endpoint, authentication, sender ownership, recipient controls, TLS, rate limits, retry behavior, and audit logging.
- Added guidance to avoid hard-coded passwords, personal mailboxes, and sensitive test data in email content.
## Validation workflow
1. Confirm the approved mail provider, sender identity, recipient list, and allowed test data before sending email.
2. Validate authentication, TLS, request payload, response status, and retry/error behavior in a controlled run.
3. Review logs and received messages without exposing passwords, tokens, or sensitive customer data.
**Review note:** This page now treats email sending as an integration with data-transmission risk controls.
---
Last updated: October 5, 2026
If you have feedback on this topic, contact .
# RBAC setup to use Graph Service in Service Suite
RBAC (Role-Based Access Control) for applications will eventually replace application access policies (see below). Today, the public preview shows some ragged edges in terms of the integration between Exchange Online and Azure AD that Microsoft says they’ll fix before general availability. Even with some bumps to navigate, the new functionality is a welcome addition that extends tenant control over their data, which is always a good thing.
In order to use this protocol you need to do the following configurations in your azure account so the roles and permissions are set correctly.
Once you have done the below steps you should be able to use the service suite Graph Service oauth2 client to send/receive emails using RBAC with the normal client commands.
1. Open Windows PowerShell as an Administrator
2. Execute: `connect-mggraph -scopes "Application.Read.All"`. If the exception *"The term connect-mggraph' is not recognized as the name of a cmdlet"* appears, execute the command
`install-module microsoft.graph`
3. After Microsoft Graph is installed, execute again the command `connect-mggraph -scopes "Application.Read.All"`
4. Sign in
5. After signing in, should see this:
6. Execute: `$SP = Get-MgServicePrincipal -All`
7. Execute: `$ServicePrincipalId = $SP | Where-Object {$_.displayName -eq "{Application name}"} | Select-Object -ExpandProperty Id`
8. Execute: `$AppId = $SP | Where-Object {$_.displayName -eq "{Application name}"} | Select-Object -ExpandProperty AppId`
9. Execute: `Write-Host ("AppId is {0} and Service Principal Id is {1}" -f $AppId, $ServicePrincipalId)`
Output:
10. Execute: `Install-Module -Name ExchangeOnlineManagement`
11. Execute: `Import-module ExchangeOnlineManagement`
12. Execute: `Connect-ExchangeOnline -UserPrincipalName {user email}`
Output:
13. Execute: `New-ServicePrincipal -AppId $AppId -ServiceId $ServicePrincipalId -DisplayName '{Application name}'`
14. Execute: `New-ManagementScope -Name "Management emails" -RecipientRestrictionFilter "CustomAttribute1 -eq '{RolName}'"`
15. Execute: `Set-Mailbox -Identity {username} -CustomAttribute1 "{RolName}"`
16. Execute: `Get-EXOMailbox -Filter {CustomAttribute1 -eq "{RolName}"} | Format-Table DisplayName`
17. Execute: `New-ManagementRoleAssignment -App $AppId -Role "Application Mail.Mail.ReadWrite" -CustomResourceScope "Management emails"`
18. Execute: `New-ManagementRoleAssignment -App $AppId -Role "Application Mail.Send" -CustomResourceScope "Management emails"`
# Assing a role to a user
Execute: Set-Mailbox -Identity {username} -CustomAttribute1 "{RolName}"
# List available permissions
Execute: `Get-ManagementRole | Where-Object {$_.Name -like "Application *"}`
# See permissions assigned to a user
Execute: `Test-ServicePrincipalAuthorization -Identity $AppId -Resource {email}`
---
Last updated: May 26, 2023
If you have any feedback on this topic, please contact us at