SendCustomNotification Method

Description

Sends a notification for vault users or external parties.

Syntax

Visual Basic
Public Sub SendCustomNotification( _ ByVal UserOrUserGroupIDs As UserOrUserGroupIDs, _ ByVal IncludeSubstituteUsers As Boolean, _ ByVal ExternalRecipients As Strings, _ ByVal SendWithServerEmailIdentity As Boolean, _ ByVal Subject As String, _ ByVal Body As String _ )

Visual Basic

Public Sub SendCustomNotification( _
   ByVal UserOrUserGroupIDs As UserOrUserGroupIDs, _
   ByVal IncludeSubstituteUsers As Boolean, _
   ByVal ExternalRecipients As Strings, _
   ByVal SendWithServerEmailIdentity As Boolean, _
   ByVal Subject As String, _
   ByVal Body As String _
)

Parameters

UserOrUserGroupIDs: A collection of user and user group IDs.
IncludeSubstituteUsers: If true, the notification message is sent to the substitutes of the receiving users as well.
ExternalRecipients: A collection of external recipient email addresses.
SendWithServerEmailIdentity: True to send with the preconfigured identity on MFServer, false to use caller identity. The sender's identity is used as a reply-to address of the notification email.
Subject: The message subject.
Body: The message body. HTML content is supported.

Remarks

This method is available only if M-Files API is used in the server interface mode.

If the method does not use the caller's own identity, but instead the "SendWithServerEmailIdentity" argument, the caller is required to have server administrator rights. Sending with the caller's own identity makes the caller email address appear as a 'reply-to' address. The method fails if the sender's email address is not valid.

The notification email is sent only if the notification messages are enabled via the M-Files Server Administrator settings.