Elements

The probe breaks event data down into tokens and parses them into elements. Elements are used to assign values to ObjectServer fields; the field values contain the event details in a form that the ObjectServer understands.

The following tables describe the elements that the Probe for Microsoft EWS generates for all emails that it receives.

Table 1. Elements

Element name

Element description

$AlarmCount

This element indicates the total number of events in the email body.

Note: The probe generates elements for each of the events in the email body.

$AlarmIndex

This element contains numeric index of this current event among all events in the enclosing email, starting from 1.

$BccRecipients

This element contains the Bcc recipients of the email. They appear in the following format:

name1 <address1>; name2 <address2>; ... and so forth.

$Body

This element contains the body of the email.

$Body_nn

This element identifies a single line within the body of the email, where nn indicates the line number.

$Body_LineCount

This element indicates the total number of lines in the body of the email.

$CcRecipients

This element contains the Cc recipients of the email. They appear in the following format:

name1 <address1>; name2 <address2>; ... and so forth.

$Date

This element shows the date and time at which the email was sent out by sender.

$DateCreated

This element shows the date and time at which the email was created in the Microsoft Exchange folder currently being monitored.

$DateReceived

This element shows the date and time at which the email was received by Microsoft Exchange.

$From

This element indicates the sender of the email in the format: name <email address>, for example: John Smith <jsmith@my.ibm.com>.

Note: This is different from on-behalf sender.

$FromAddress

This element indicates the email address of the sender of the email.

$From Name

This element indicates the name of the sender of the email, for example: John Smith.

$Header

This element contains the full header details of the email.

$Header_nn

This element identifies a single line within the header of the email, where nn indicates the line number.

$Header_LineCount

This indicates the total number of lines in the header of the email.

$HeaderField_<field name>

This element contains the content of the specified field in email header.

$Importance

This element indicates the importance of email as set by the sender.

$InternetMessageId

This element contains the Internet message ID of the email.

$IsRead

This element indicates whether the email has been read.

$ItemId

This element contains the unique ID for the email in Microsoft Exchange.

$ReplyTo

This element contains the email addresses to which replies should be addressed. They appear in the following format: name1 <address1>; name2 <address2>; ... and so forth.

$SenderOnBehalf

This element contains on-behalf sender of the email. If the email was not sent on behalf of another person, this element will be empty.

$Subject

This element indicates the subject of the email.

$Severity

This element indicates the severity level of the event.

Note: This element is available only when the email body contains a line in the format: Severity:<severity_value>.

$To

This element indicates the email addresses of the recipients of the email.

This element has the following format: name1 <address1>; name2 <address2>; and so forth.

$Topic

This element indicates the conversation topic of related emails.

$Topic excludes conversation prefixes like Re or Fwd. For example: If the email Subject is Re: Meeting Agenda, $Topic contains Meeting agenda.

The following tables describe the elements that the Probe for Microsoft EWS may generate for the events within an email.

Table 2. Elements

Element name

Element description

$ALARM_START

This element indicates the start of the current event indexed by the $AlarmIndex element in the email body.

$ALARM_END

This element indicates the end of the current event indexed by the $AlarmIndex element in the email body.

$ALARM_HEADER

This element contains the line the precede first line actual tokens, after $ALARM_STARTin the current event indexed by the $AlarmIndex element in the email body.

$line_n

This element contains Total of lines in content of

the current event indexed by the $AlarmIndex element in the email body.

$line<n>

This element contains the nth line of content of the current event indexed by the $AlarmIndex element in the email body.

$NVP_<name of NVP>

This element contains a named-value-pair (if one exists) in the current event indexed by the $AlarmIndex element in the email body.

$TokenCount

This element indicates the total number of tokens in the current event indexed by the $AlarmIndex element in the email body.

$Token<n>

This element contains the nth token in the current event indexed by the $AlarmIndex element in the email body.