11.13 MapiMail

Use this Knowledge Script to send a MAPI email message with AppManager event information to a specified list of recipients.

By default, the event information includes the computer name of the managed client and the event severity. You can select additional information to include. You can also construct a custom message to send to recipients.

This script raises an event if you select the custom message format but neglect to enter any text for the custom message body. Under these circumstances, the script continues to execute and uses the standard message format.

You can attach a file to the email message by entering the path to the file.

The email message is sent using the Microsoft MAPI mechanism. The recipients can be one or many MAPI clients.

NOTE:Because Microsoft tightened security in recent versions of Microsoft Outlook, the MapiMail script works only with Outlook 2000 and Outlook 2003 SP1. This script is not supported on the following versions of Outlook:

Outlook 2003 without service packs
Outlook 2003 SP2
Outlook 2007
Outlook 2010

As an alternative, consider using the SMTPMail Knowledge Script.

11.13.1 Setting Parameter Values

Set the following parameters as needed:

Parameter	How to Set It
Event Notification
Event severity -- Action warning	Set the severity level, from 1 to 40, to indicate the importance of an event in which the MapiMail job returns a warning. The default is 35 (magenta event indicator).
Event severity -- Action failure	Set the severity level, from 1 to 40, to indicate the importance of an event in which the MapiMail job fails. The default is 5 (red event indicator).
Severity Configuration
Minimum event severity for Action	Set the minimum severity level, from 1 to 40, for an event that triggers this Action. The default is 1.
Maximum event severity for Action	Set the maximum severity level, from 1 to 40, for an event that triggers this Action. The default is 40.
Action
Profile name	Provide the profile name of the managed client, such as the default netiq account or an account set up specifically for the client. The profile must be an account with Mail capability.
List of recipients (in address book)	Provide the email address for the recipient of the message, using names in the address book. Separate multiple names with semicolons (;). For example: Chris Lin;pat@bigcorp.com;gwest. NOTE:Be sure the names you enter are not ambiguous. If the script cannot definitively identify the recipient, mail is not sent.
Full path to mail attachment	Provide the full path to the attachment you want to send. If you are not attaching a file, leave this field blank.
Message format	Select the format you want to use for the message sent by this script: Standard format generates a message based upon the selections you make from the Standard Message Options parameters. Custom format generates a message based upon the subject and message body you supply in the Custom Message Options parameters. The default is Standard.
Standard Message Options
Include date/timestamp?	Select Yes to include the date/timestamp in the standard message. The default is unselected.
Include JobID?	Select Yes to include the job ID in the standard message. The default is unselected.
Include agent computer name?	Select Yes to include the name of the agent computer in the standard message (the computer hosting the agent that initiated the action). The default is Yes.
Include event severity?	Select Yes to include the severity of the event in the standard message. The default is Yes.
Include Knowledge Script name?	Select Yes to include the Knowledge Script name in the standard message (the Knowledge Script that initiated the Action). The default is unselected.
Include AppManager object name?	Select Yes to include the AppManager resource object name in the standard message (the AppManager resource object where the event was raised). The default is unselected.
Include AppManager event ID (only on MS Action)?	Select Yes to include the AppManager event ID in the standard message (possible only in cases when the Action is carried out by the management server). The default is unselected.
Include event detail message?	Select Yes to include the event detail message. The default is unselected.
Custom Message Options
Custom message subject	Provide the text you want to use for the custom message subject line.
Custom message body	Provide the text you want to include in your custom message. You can use the keywords listed below to indicate the information you want to include in the body of your custom message. Add a space before and after keywords to ensure that the keywords display properly. $ShortMsg$ (short event message) $DetailMsg$ (detailed event message) $Time$ (date and time of the event) $JobID$ (ID of the job that raised the event) $MachineName$ (name of the computer where the event was raised) $Severity$ (severity of the event) $KSName$ (name of the Knowledge Script that raised the event) $ObjectName$ (name of the AppManager resource object where the event was raised) $EventID$ (event ID) For $ShortMsg$ and $DetailMsg$ you can use number and wildcard options to indicate specific portions of the text string to include. For example: $DetailMsg$[5] includes the fifth word of the detailed event message $ShortMsg$[1-5] includes the first through fifth words of the short message event $DetailMsg$[5] includes the first through fifth words of the detailed event message $ShortMsg$[5] includes the fifth through last words of the short event message If you do not enter a word specifier, AppManager returns the entire string. The following are examples of the types of messages you can construct using these keywords: Event from $MachineName$: The $ShortMsg$[1-3] has failed. The last command was $DetailMsg$[4*]. A severity $Severity$ event has occurred! Call the owner of $MachineName$ immediately!