Crestron
e-control Mail SW-MAIL
88
••
Appendices
Installation & Reference Guide — Doc. 5798
LookupRcpt
Applies to
e-Mailer signal blocks
Description
Performs a lookup on a recipient in the database, and adds it to the recipient list
Direction
system-to-server
Type
Analog
Value
A number matching the contents of the
ID
field of a record in the
eMail_Addr
table of the database file. The name and address from the matching record are
added to the recipient list.
Expected Reply
None
Comments
Use of this signal is optional.
If the
Allow multiple recipients
option is checked in the e-Mailer signal block
definition,
LookupRcpt
(or
SetAddr
) may be used repeatedly to add (names and)
addresses to the recipient list. Otherwise, when
Allow multiple recipients
is
unchecked, mail can only be sent to a single name and address. That is, each
additional
LookupRcpt
(or
SetAddr)
signal simply replaces the previously
specified (name and) address with the most recently specified address (and
name).
If no matching record is found whose
ID
field matches this signal value, nothing is
added to the recipient list.
If the
SendNow
signal is issued but no address has been set (by any method), the
following error message is sent back to the control system:
No recipient specified -- mail cannot be sent.
If the record is found but contains a null
addr
field, the default recipient address
specified in the e-Mailer signal block definition will be used instead. In this case,
the name is also checked, and if it too is null, the default recipient name is utilized.
If the default is also null (and all other addresses in the recipient list are also null),
attempts to send the mail are rejected by the SMTP server (a message is posted to
the log).
Note that the default’s initial value (for a newly-defined e-mailer signal block) is
null. Fill the default to send all (unaddressed) mail to a single address.
The recipient list is reset to the default by the
ClearNames, NewMail,
and
SendNow
signals.
If a recipient name had previously been specified with a
SetRcptName
signal, this
signal overwrites it with the contents of the
first
[name] and
last
[name] fields of the
matching record.
The
eMail_Addr
table must contain at least four fields
(ID, first, last,
and
addr).
However, it is perfectly permissible for additional fields to be included in the table
(for list display purposes, for example).
See Also
Other methods of setting the name and address are: The
SetRcptName
signal, the
SetAddr
signal, and manually picking a recipient from the bound recipient scroller.
