Rule description
This rule sends an email to the specified Active Directory user scope. It can be used as a standalone rule in a runbook or in conjunction with a Web Action.
When to use this rule
This rule takes all the users returned by the rule query section and sends them an email using the settings in the action settings.
You can use this rule in these scenarios:
- To send notifications to a certain group of Active Directory users.
- As part of a runbook. You should set the Limit scope to this domain or OU to Get scope from runbook session. In this case, the rule will take the users from the output of certain supported provisioning rules instead of directly through this query section.
- As a linked rule to a web action or an automation rule. For details please see How to configure one rule to run after another rule or a web action – Cayosoft Help Center.
Rule Settings
Query Section
| Setting name | Description |
|---|---|
|
General Settings |
|
| Limit scope to this Domain or OU |
This setting defines the search query scope. To improve query performance, limit the scope to specific OU. Important: To test rule configuration, limit the rule scope to an OU that contains test accounts or objects.
|
| Query criteria | Query criteria are sent to the target platform with other query parameters to reduce the number of returned objects and may improve query performance. |
| Maximum number of users | Limit the number of new users returned by the query who will be sent a notification. |
|
More options |
|
|
Properties to Display |
To display additional properties for each object found by the query, add those properties to the list. |
|
System properties |
List of properties required for this rule to be executed correctly. |
|
Filter |
To hide unwanted data based on criteria, not supported by the target system in the query criteria, set the filtering conditions here. Example: filter by the found object Distinguished Name. Tip: For optimal performance, use the Query criteria above to filter objects whenever possible.
|
|
Sort by |
Sort result objects list. |
|
Initialization script |
Usually, rules use query criteria to limit the query search scope. It improves the performance of the executed rule. Due to PowerShell limitations, it is not possible to use calculated expressions in query criteria. That is the point where the initialization script can help. You can initialize a global variable in this setting and then use it in query criteria. Important: To use a variable, declared in the initialization script, in the query scope, it must be global: $global:<variable name>.
|
Action Section
| Setting name | Description |
|---|---|
| User email attribute | Specify user mail attribute. |
| To | Specify if the user object's email address (selected attribute) should be used or the User's manager email address. Also, you can select the custom recipient. |
| CC, Bcc | Email address where the copy will be sent. |
| From | Users can receive emails from default SMTP from the address. |
| Subject |
Email subject. Tip: It is possible to customize email subjects by using different tokens, see Customizing an automation rule or web action output email – Cayosoft Help Center.
|
| Message |
Message text. Tip: It is possible to customize email messages by using different tokens, see Customizing an automation rule or web action output email – Cayosoft Help Center.
|
| Limit the number of emails sent per minute |
An integer value that represents the number of emails sent per minute by this rule. To change the default value, navigate to Home > Configuration > Settings > Email Settings (SMTP). The default limit for Office 365 SMTP gate is 30 emails per minute. |
| Add attachment |
Add an attachment if needed. |
| Advanced Options |
|
| Write to selected attribute |
Specify the user attribute where the notification timestamp will be written. If this setting is empty no timestamp will be written. |
| Attribute value |
Specify the value that will be written to the selected attribute after every notification. |
Output Section
This section defines the output format of this rule.
To get more information about this section, please see the Output section article.
Enforce/Schedule section
This section defines the schedule for how often to run the rule.
To get more information about this section, please see the Enforce/Schedule section article.
Change History
| Version | Notes |
|---|---|
| 10.3.0 | Add attachment setting has been added. |
| 8.2.0 | The rule is introduced in the product. |
Comments
0 comments
Please sign in to leave a comment.