Specifications

Crestron e-control Mail SW-MAIL

86 •• Appendices Installation & Reference Guide — Doc. 5798

LookupMsg

Applies to

e-Mailer signal blocks

Description

Performs a lookup on a message in the database, and sets subj and body

accordingly

Direction

system-to-server

Type

Analog

Value

A number matching the contents of the ID field of a record in the eMail_Msg table

of the database file. Both the subj and body fields from the matching record are

added to the recipient list.

Expected Reply

None

Comments

Use of this signal is optional.

If no matching record is found whose ID field matches this signal value, the

following error is displayed:

No such record.

If the record is found but contains a null subj field, the e-Mail message is

considered incomplete and is not sent. However, the following error message is

sent back to the control system:

No message specified – mail cannot be sent.

(Note that a null body field is acceptable.)

The message record also contains a reference to a record in the recipient name

and address table. That record is used to provide an implicit recipient name and

address — but only when no recipient is explicitly specified.

The eMail_Msg table must contain at least these three fields (ID, subj, body, and

defaultAddr). However, it is perfectly permissible for additional fields to be included

in the table (for list display purposes, for example). An example of such a field is

abbr which is often used in the list display of a bound scroller. The abbr field is

used only if it is listed in the Queries table. No direct reference to such a field is

made in the application code. For more information on the Queries table, refer to

the latest revision of documentation for e-control Database Manager (SW-DBM),

Doc. 5823.