Alert method

Sends a mail message alerting people that the specified Principle Item has been added or has changed.

Syntax

C++
HRESULT Alert(
   BSTR To,
   BSTR Cc,
   BSTR Subject,
   BSTR Body)
Scripting languages
Object.Alert
   To as String,
   Cc as String,
   Subject as String,
   Body as String

Parameters

To

A string containing the list of email addresses, separated by commas.

Cc

A string containing the list of email addresses, separated by commas.

Subject

The subject of the alert mail message. The default subject will be used if an empty string is passed in.

Body

The body of the alert mail message. The default body will be used if an empty string is passed in.

Return value

C++

The return code.
Scripting languages

None.

Remarks

Alert sends the alert message as follows:

  • If the logged-in user is the server administrator, the "From" field of the email will be "eRoom". Otherwise, the "From" field in the email is taken from the logged-in users's email address.

  • If the logged-in user has no email address specified, the error EROOM_E_NOUSER is returned.

Home

Applies to
IERUPrincipalItem