@itentialopensource/adapter-microsoft_graph 1.1.0 → 1.1.1

package/CALLS.md

@@ -628,6 +628,12 @@ Specific adapter calls are built based on the API of the Microsoft_graph. The Ad
     <td style="padding:15px">{base_path}/{version}/v1.0/me/sendMail?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
+  <tr>
+    <td style="padding:15px">sendmailApplication(body, userId, callback)</td>
+    <td style="padding:15px">Send mail with client credentials</td>
+    <td style="padding:15px">{base_path}/{version}/v1.0/users/{pathv1}/sendMail?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
   <tr>
     <td style="padding:15px">getmailboxsettings(callback)</td>
     <td style="padding:15px">Get mailbox settings</td>

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 1.1.1 [10-11-2023]
+
+* Patch/adapt 2935
+
+See merge request itentialopensource/adapters/cloud/adapter-microsoft_graph!4
+
+---
+
 ## 1.1.0 [09-26-2023]
 
 * 2023 Adapter Migration

package/adapter.js

@@ -7039,6 +7039,95 @@ class MicrosoftGraph extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @function sendmailApplication
+   * @pronghornType method
+   * @name sendmailApplication
+   * @summary Send mail
+   *
+   * @param {object} body - body param
+   * @param {string} userId - user id or userPrincipalName to sendmail from
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /sendmailApplication
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  sendmailApplication(body, userId, callback) {
+    const meth = 'adapter-sendmailApplication';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (body === undefined || body === null || body === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['body'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (userId === undefined || userId === null || userId === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['userId'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [userId];
+    const bodyVars = body;
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('Mail', 'sendmailApplication', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['sendmail'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
   /**
    * @function getmailboxsettings
    * @pronghornType method

package/entities/Mail/action.json

@@ -125,6 +125,26 @@
         }
       ]
     },
+    {
+      "name": "sendmailApplication",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/v1.0/users/{pathv1}/sendMail?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
     {
       "name": "getmailboxsettings",
       "protocol": "REST",

package/entities/Mail/schema.json

@@ -16,6 +16,7 @@
         "getmymailboxrules",
         "getmycategories",
         "sendmail",
+        "sendmailApplication",
         "getmailboxsettings",
         "setautomaticreplies",
         "getauserSmessages",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-microsoft_graph",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "This adapter integrates with system described as: microsoftGraph.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",

package/pronghorn.json

@@ -3819,6 +3819,80 @@
       },
       "task": true
     },
+    {
+      "name": "sendmailApplication",
+      "summary": "Send mail with client credentials",
+      "description": "Send mail with client credentials",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": ": object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "example": {
+                  "message": {
+                    "subject": "Meet for lunch?",
+                    "body": {
+                      "contentType": "Text",
+                      "content": "The new cafeteria is open."
+                    },
+                    "toRecipients": [
+                      {
+                        "emailAddress": {
+                          "address": "{{UserName}}"
+                        }
+                      }
+                    ],
+                    "ccRecipients": [
+                      {
+                        "emailAddress": {
+                          "address": "{{UserName}}"
+                        }
+                      }
+                    ]
+                  },
+                  "saveToSentItems": "false"
+                }
+              }
+            ],
+            "definitions": {}
+          }
+        },
+        {
+          "name": "userId",
+          "type": "string",
+          "info": ": string",
+          "required": true,
+          "schema": {
+            "title": "userId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/sendmailApplication"
+      },
+      "task": true
+    },
     {
       "name": "getmailboxsettings",
       "summary": "Get mailbox settings",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "1.0.2",
-  "configLines": 10828,
+  "version": "1.1.0",
+  "configLines": 10902,
   "scriptLines": 1783,
-  "codeLines": 20081,
+  "codeLines": 20170,
   "testLines": 15130,
   "testCases": 772,
-  "totalCodeLines": 36994,
-  "wfTasks": 227
+  "totalCodeLines": 37083,
+  "wfTasks": 228
 }