Options
Description
The Options Object is returned from the GetNotitifcationsOptionsObject method and allows configuration of additional Notification options
Properties
|
Name |
Data Type |
Description |
Default Value |
|
SendToUserOrUserGroups |
UserOrUserGroupIDs |
Collection of M-Files user and/or M-Files group id's |
|
|
SendToExternalUsers |
Strings |
List of email address to send the notification to, a list of strings with correctly formated and valid email addresses |
|
|
template |
String |
The name of the template to use for the notification, the default template value is default |
default is default options |
|
SubstituteUsers |
Integer |
Indicates how to handle Substitute users when sending a notification
|
0 is the default |
|
Grouping |
String |
Identifier used to group multiple notifications together, this option allows for many notifications from many Events/Activities to be grouped together and sent as a single Notification. |
the value from the template settings is used |
|
MessagePriority |
String |
Sets the Email priority the following options are valid
High Priority Emails are displayed with a red exclamation mark when viewed in Outlook
|
LOW |
|
AttachmentOptions |
AttachmentOptions |
See AttachmentOptions below |
|
Properties - AttachmentOptions
|
Name |
Data Type |
Description |
Default Value |
|
AttachFiles |
Boolean |
Indicates if the files within an Object should be attached to the Notification Email |
false indicating files will not be attached |
|
AttachFilesFilter |
String |
A string allowing files to be filtered when attaching |
* is the default indicating all files are to be attached |
|
AttachFilesIfMfilesUser |
Boolean |
A flag indicating if when sending Notifications to M-Files user ID's the files should be attached to the Notification |
false indicating that MFiles users will not receive attached files |
|
AttachFilesIfExternal |
Boolean |
A flag indicating if when sending Notifications to external email addresses the files should be attached to the Notification |
true indicating the external users will receive attached files |
|
ZipOptions |
ZipOptions |
see ZipOtions below |
|
Properties - ZipOptions
|
Name |
Data Type |
Description |
Default Value |
|
CompressFiles |
Boolean |
Indicates if an Objects files should be compressed (zipped) prior to be attached |
false indicating files will not be compressed |
|
CompressionLevel |
integer |
An integer indicating the level of compression to apply to the files 0 = optimal compression 1 = fastest 2 = none |
default is 0 optimal compression level |