Fix: Add sendEmail documentation for non-existent users for all affected versions (Product IS issue #27610)

en/identity-server/5.10.0/docs/references/adaptive-authentication-js-api-reference.md

@@ -16,9 +16,9 @@
     language similar to JavaScript, common knowledge on JavaScript may help
     you to compose effective authentication scripts.
 
 ### Core functions
 
 ##### onLoginRequest(context)
 
 This function is called when the initial authentication request is
 received by the framework. It includes the following parameters.
@@ -61,14 +61,14 @@
 
 The API can be called in either of the following ways:
 
 -   With only the `           stepId          ` . Example:
 
     ``` java
     executeStep(1)
     ```
 
 -   With only the `           stepId          ` and
     `           eventCallbacks          ` . Example:
 
     ``` java
     executeStep(1, {
@@ -215,16 +215,30 @@
 |-----------------------|--------------------------------------------------------------------------------------------------------|
 | user                  | An object representing the user details.                                                               |
 | templateId            | Identifier of the email template. The email template specifies the body of the email that is sent out. |
-| placeholderParameters | Used to replace any placeholders in the template.                                                      |
+| placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> |
 
 **Example code**
 
+Send an email to an existing user:
+
 ``` java
 var user = context.steps[1].subject;
 var firstName = user.localClaims['http://wso2.org/claims/givenname'];
 sendEmail(user, 'myTemplate', {'firstName':firstName});
 ```
 
+Send an email to a non-existent user:
+
+``` java
+var email = 'user@example.com';
+var otp = '123456';
+var sent = sendEmail(context.currentKnownSubject, 'EmailOTP', {
+    'send-to': email,
+    'flowType': 'registration',
+    'OTPCode': otp
+});
+```
+
 ##### sendError(url,parameters)
 
 This function redirects the user to an error page. It includes the

en/identity-server/5.11.0/docs/references/adaptive-authentication-js-api-reference.md

@@ -242,16 +242,30 @@
 |-----------------------|--------------------------------------------------------------------------------------------------------|
 | user                  | An object representing the user details.                                                               |
 | templateId            | Identifier of the email template. The email template specifies the body of the email that is sent out. |
-| placeholderParameters | Used to replace any placeholders in the template.                                                      |
+| placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> |
 
 **Example code**
 
+Send an email to an existing user:
+
 ``` java
 var user = context.steps[1].subject;
 var firstName = user.localClaims['http://wso2.org/claims/givenname'];
 sendEmail(user, 'myTemplate', {'firstName':firstName});
 ```
 
+Send an email to a non-existent user:
+
+``` java
+var email = 'user@example.com';
+var otp = '123456';
+var sent = sendEmail(context.currentKnownSubject, 'EmailOTP', {
+    'send-to': email,
+    'flowType': 'registration',
+    'OTPCode': otp
+});
+```
+
 ##### sendError(url,parameters)
 
 This function redirects the user to an error page. It includes the

en/identity-server/5.9.0/docs/references/adaptive-authentication-js-api-reference.md

@@ -215,16 +215,30 @@
 |-----------------------|--------------------------------------------------------------------------------------------------------|
 | user                  | An object representing the user details.                                                               |
 | templateId            | Identifier of the email template. The email template specifies the body of the email that is sent out. |
-| placeholderParameters | Used to replace any placeholders in the template.                                                      |
+| placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> |
 
 **Example code**
 
+Send an email to an existing user:
+
 ``` java
 var user = context.steps[1].subject;
 var firstName = user.localClaims['http://wso2.org/claims/givenname'];
 sendEmail(user, 'myTemplate', {'firstName':firstName});
 ```
 
+Send an email to a non-existent user:
+
+``` java
+var email = 'user@example.com';
+var otp = '123456';
+var sent = sendEmail(context.currentKnownSubject, 'EmailOTP', {
+    'send-to': email,
+    'flowType': 'registration',
+    'OTPCode': otp
+});
+```
+
 ##### sendError(url,parameters)
 
 This function redirects the user to an error page. It includes the

en/identity-server/6.0.0/docs/references/adaptive-authentication-js-api-reference.md

@@ -233,14 +233,28 @@
 |-----------------------|--------------------------------------------------------------------------------------------------------|
 | user                  | An object representing the user details.                                                               |
 | templateId            | Identifier of the email template. The email template specifies the body of the email that is sent out. |
-| placeholderParameters | Used to replace any placeholders in the template.                                                      |
+| placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> |
+
+Send an email to an existing user:
 
 ``` java
 var user = context.steps[1].subject;
 var firstName = user.localClaims['http://wso2.org/claims/givenname'];
 sendEmail(user, 'myTemplate', {'firstName':firstName});
 ```
 
+Send an email to a non-existent user:
+
+``` java
+var email = 'user@example.com';
+var otp = '123456';
+var sent = sendEmail(context.currentKnownSubject, 'EmailOTP', {
+    'send-to': email,
+    'flowType': 'registration',
+    'OTPCode': otp
+});
+```
+
 #### sendError(url,parameters)
 
 This function redirects the user to an error page. It includes the

en/identity-server/6.1.0/docs/references/adaptive-authentication-js-api-reference.md

@@ -272,14 +272,28 @@
 |-----------------------|--------------------------------------------------------------------------------------------------------|
 | user                  | An object representing the user details.                                                               |
 | templateId            | Identifier of the email template. The email template specifies the body of the email that is sent out. |
-| placeholderParameters | Used to replace any placeholders in the template.                                                      |
+| placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> |
+
+Send an email to an existing user:
 
 ``` java
 var user = context.steps[1].subject;
 var firstName = user.localClaims['http://wso2.org/claims/givenname'];
 sendEmail(user, 'myTemplate', {'firstName':firstName});
 ```
 
+Send an email to a non-existent user:
+
+``` java
+var email = 'user@example.com';
+var otp = '123456';
+var sent = sendEmail(context.currentKnownSubject, 'EmailOTP', {
+    'send-to': email,
+    'flowType': 'registration',
+    'OTPCode': otp
+});
+```
+
 #### sendError(url,parameters)
 
 This function redirects the user to an error page. It includes the

en/identity-server/7.0.0/docs/references/conditional-auth/api-reference.md

@@ -688,19 +688,39 @@
         </tr>
         <tr>
           <td><code>placeholderParameters</code></td>
-          <td>Used to replace any placeholders in the template.</td>
+          <td><p>Used to replace any placeholders in the template.</p>
+            <p>This parameter also supports the following optional fields:</p>
+            <ul>
+              <li><code>send-to</code>: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li>
+              <li><code>flowType</code>: Specifies the flow type. Set this to <code>registration</code> when sending emails to non-existent users.</li>
+            </ul>
+          </td>
         </tr>
       </tbody>
     </table>
 
 - **Example**
 
+    Send an email to an existing user:
+
     ``` js
     var user = context.steps[1].subject;
     var firstName = user.localClaims['http://wso2.org/claims/givenname'];
     sendEmail(user, 'myTemplate', {'firstName':firstName});
     ```
 
+    Send an email to a non-existent user:
+
+    ``` js
+    var email = 'user@example.com';
+    var otp = '123456';
+    var sent = sendEmail(context.currentKnownSubject, 'EmailOTP', {
+        'send-to': email,
+        'flowType': 'registration',
+        'OTPCode': otp
+    });
+    ```
+
 ### Get parameter value from JWT
 
 `getValueFromDecodedAssertion(jwt, parameterName, isParameterInPayload)`

en/identity-server/7.1.0/docs/references/conditional-auth/api-reference.md

@@ -690,19 +690,39 @@
         </tr>
         <tr>
           <td><code>placeholderParameters</code></td>
-          <td>Used to replace any placeholders in the template.</td>
+          <td><p>Used to replace any placeholders in the template.</p>
+            <p>This parameter also supports the following optional fields:</p>
+            <ul>
+              <li><code>send-to</code>: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li>
+              <li><code>flowType</code>: Specifies the flow type. Set this to <code>registration</code> when sending emails to non-existent users.</li>
+            </ul>
+          </td>
         </tr>
       </tbody>
     </table>
 
 - **Example**
 
+    Send an email to an existing user:
+
     ``` js
     var user = context.steps[1].subject;
     var firstName = user.localClaims['http://wso2.org/claims/givenname'];
     sendEmail(user, 'myTemplate', {'firstName':firstName});
     ```
 
+    Send an email to a non-existent user:
+
+    ``` js
+    var email = 'user@example.com';
+    var otp = '123456';
+    var sent = sendEmail(context.currentKnownSubject, 'EmailOTP', {
+        'send-to': email,
+        'flowType': 'registration',
+        'OTPCode': otp
+    });
+    ```
+
 ### Get parameter value from JWT
 
 `getValueFromDecodedAssertion(jwt, parameterName, isParameterInPayload)`

en/identity-server/7.2.0/docs/references/conditional-auth/api-reference.md

@@ -694,19 +694,39 @@
         </tr>
         <tr>
           <td><code>placeholderParameters</code></td>
-          <td>Used to replace any placeholders in the template.</td>
+          <td><p>Used to replace any placeholders in the template.</p>
+            <p>This parameter also supports the following optional fields:</p>
+            <ul>
+              <li><code>send-to</code>: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li>
+              <li><code>flowType</code>: Specifies the flow type. Set this to <code>registration</code> when sending emails to non-existent users.</li>
+            </ul>
+          </td>
         </tr>
       </tbody>
     </table>
 
 - **Example**
 
+    Send an email to an existing user:
+
     ``` js
     var user = context.steps[1].subject;
     var firstName = user.localClaims['http://wso2.org/claims/givenname'];
     sendEmail(user, 'myTemplate', {'firstName':firstName});
     ```
 
+    Send an email to a non-existent user:
+
+    ``` js
+    var email = 'user@example.com';
+    var otp = '123456';
+    var sent = sendEmail(context.currentKnownSubject, 'EmailOTP', {
+        'send-to': email,
+        'flowType': 'registration',
+        'OTPCode': otp
+    });
+    ```
+
 ### Get parameter value from JWT
 
 `getValueFromDecodedAssertion(jwt, parameterName, isParameterInPayload)`

en/identity-server/next/docs/references/conditional-auth/api-reference.md

@@ -694,19 +694,39 @@
         </tr>
         <tr>
           <td><code>placeholderParameters</code></td>
-          <td>Used to replace any placeholders in the template.</td>
+          <td><p>Used to replace any placeholders in the template.</p>
+            <p>This parameter also supports the following optional fields:</p>
+            <ul>
+              <li><code>send-to</code>: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li>
+              <li><code>flowType</code>: Specifies the flow type. Set this to <code>registration</code> when sending emails to non-existent users.</li>
+            </ul>
+          </td>
         </tr>
       </tbody>
     </table>
 
 - **Example**
 
+    Send an email to an existing user:
+
     ``` js
     var user = context.steps[1].subject;
     var firstName = user.localClaims['http://wso2.org/claims/givenname'];
     sendEmail(user, 'myTemplate', {'firstName':firstName});
     ```
 
+    Send an email to a non-existent user:
+
+    ``` js
+    var email = 'user@example.com';
+    var otp = '123456';
+    var sent = sendEmail(context.currentKnownSubject, 'EmailOTP', {
+        'send-to': email,
+        'flowType': 'registration',
+        'OTPCode': otp
+    });
+    ```
+
 ### Get parameter value from JWT
 
 `getValueFromDecodedAssertion(jwt, parameterName, isParameterInPayload)`