Page 2: Table Of Contents
Section Summary ... 4 Quick Start Guide 1: Sending e-Mail (demo3) Quick Start Guide 2: Receiving e-Mail (demo4) Introduction What is Crestron e-control Mail? ... 8 System Terminology and Topology ... 8 Leading Specifications ... 11 Requirements... 11 Installation... 12 Licensing ...
Page 3 Crestron e-control Mail Appendix A: Theory of Operation Server Protocol... 59 Signal Block Definition / Activation ... 59 Signal Block Enable / Disable ... 59 Signal Block Error Reporting ... 59 Appendix B: Intersystem Communications and Signal Space Considerations System Connections ... 61 Appendix C: Signal Reference Definition of Terms ...
Page 4: How To Use This Manual
The latest version is freely available from Adobe at http://www.adobe.com/acrobat/. Quick Start To see an “out-of-the-box” demonstration of Crestron e-control Mail as quickly as possible, turn to the Quick Start Guide(s) beginning on the next page. You will need: Follow the instructions in the guides precisely in the order given and you should be up and running in a matter of minutes.
Page 5 Crestron e-control Mail Then comes information about the e-Mail database file, including information about text substitution and file inclusion directives. After that, the examples (demos) are described and illustrated in detail. Appendices include Theory of Operation, along with a complete Signal Reference.
Page 6: Quick Start Guide 1: Sending E-Mail (Demo3)
Run the “server” The installer sets the server to Select shortcut e-control Mail Server from the Crestron folder in the Windows Start use the Configuration Settings Menu. If the title bar of the window does not read “e-control Mail Demos,” use the file demomail.ini.
Page 7: Quick Start Guide 2: Receiving E-Mail (Demo4)
Run the “server” The installer sets the server to Select shortcut e-control Mail Server from the Crestron folder in the Windows Start use the Configuration Settings Menu. If the title bar of the window does not read “e-control Mail Demos,” use the file demomail.ini.
Page 8: Introduction
Introduction What is Crestron e-control Mail? Crestron e-control Mail (SW-MAIL) empowers any Crestron control system with the ability to construct and transmit, and receive and view e-mail messages. Simply by asserting specific signals, your control systems can send arbitrary text, whole text files, canned messages, alerts, status updates, etc., to any e-mail address.
Page 9 The e-mail host is actually comprised of two separate pieces of software, one for incoming mail (a POP3 server ) and one for outgoing mail (an SMTP server). While these software generally reside on the same physical computer (host), this is not always the case.
Page 10 IP address of the other. This kind of connection also requires the use of the CNX Gateway which is separately licensed software that facilitates communication between the server and the control system. The CNX Gateway is typically installed on the server (when sufficient TCP/IP sockets are available) or it can be installed on any computer visible (i.e., pingable) on...
Page 11: Leading Specifications
Alternate means of contacting an e-mail host server via TCP/IP. (See Appendix F for configuration information.) (These are software constructs provided by your operating system. The maximum number of sockets is operating system dependent.) Server requires one socket per server–control system connection Required for EtherNet control system connections only.
Page 12: Installation
To install the Software Server, first download the installer package from the Downloads page can be found at: Crestron FTP site. To do this, first go to the Crestron website and select the Downloads page. New users must register. Proceed to the ECONTROL Library.
Page 13: Transferring An Existing License To Another Computer
Before closing the License Window, be sure to activate the components you plan to use. In the above example, the user has checked the box next to SW-MAIL. It is permissible to exit the program while waiting for a “Site Key” to be issued. The application can be restarted and the “Site Key”...
Page 14: Basic Server Setup
Basic Server Setup This product requires a proper physical connection between both “sides” of the system — the server and the control system. Furthermore, the software on both sides must be properly configured. As previously discussed, the connection can be either serial via RS-232 cable or Ethernet via Local Area Network (LAN).
Page 15: Communications Setup
Run server application by selecting Database Manager from the Crestron folder of your Start menu. Select config file. Specify a Configuration Settings file (.ini file) by selecting File | Configuration File….
Page 16 (and set the IP address and IP ID). Click OK to make the changes for each connection. The demos are pre-configured to use RS-232. : Serial communications requires neither the CNX Gateway software nor the use of an Ethernet network. Connect PC for programming purposes. For each control system to be...
Page 17 TCP/IP stack. Verify the versions per the “Leading Specifications” (page 11). To upgrade any of these files, retrieve a copy of the latest upgrade package from the Crestron website (OPSYS Library). These files have an extension of .upz which contains all three system components in one compacted file.
Page 18 Crestron e-control Mail Basic Server Setup Enter gateway address. Still in the Viewport, select Functions | Setup IP Table to open the IP Table window. Click on the Retrieve Current IP Table from Control System button to display the current listing. Verify that the IP address for the PC running the CNX Gateway (often but not necessarily the server itself) appears with an IP ID of 03.
Page 19: Test Communications
Crestron e-control Mail Test Communications At this point, test your connections. RS-232 Control Systems Use the Viewport to verify communications between the server and the CNX control system. Select Diagnostics | Establish Communications. If properly connected, the PC responds with the COM port and baud rate.
Page 20: Server Configuration In Depth
Crestron e-control Mail The Signal Analyzer is intended for debugging and demo purposes only. It should not normally be left opened because it does place additional processing demands on the server, creating a perceptible delay on slower systems. Server Configuration In Depth This section is a reference to all the options available in the Configuration Options window.
Page 21: Password Access
Crestron e-control Mail The installer registers the file demos\demomail.ini as the current Configuration Settings file. This file pre-configures the server for all four demos. The Quick Start Guides — which instruct you to upload demo3 or demo4 – depend on this file being set as the current config file. If you have changed the config file and wish to run the demos again, you must first change it back.
Page 22: E-Mail Options
Crestron e-control Mail Level 1 and 2 passwords may be changed from the General tab. Click on the Change Password button to open the Change Password window. Enter the old password and the new password twice. Click OK to complete the change.
Page 23 Crestron e-control Mail Options for Sending e-mail These options affect the behavior of all e-mailer signal blocks. SMTP Server URL Field Supply an SMTP server domain name. Typically, this is the organization’s domain name with the sub-domain smtp prefixed, as in smtp.organization.com, but quite often it could be something else.
Page 24: Com Settings Definition
Crestron e-control Mail Options for Receiving e-mail These options affect the behavior of all e-mailbox signal blocks. POP3 Server URL Field Supply a POP3 server domain URL. Typically, this is the organization’s domain name with the sub-domain pop, mailbox or postoffice prefixed, as in mailbox.organization.com, but quite often it could be something else.
Page 25 Crestron e-control Mail The Configuration Options window, COM Settings tab, showing the only connection defined in the demo configuration (selected). COM Settings definitions (connections) can be active or inactive. A check in the box next to the definition name indicates that the connection is activated. If not activated, it is ignored when the server protocol is started.
Page 26: Signal Block Definition
Control system generation Here you specify the type of control system. The server uses this information to take into account minor differences in the way the older generation of Crestron control systems functioned in terms of timing and data capacity.
Page 27 A “signal block” is a software The Signal Blocks tab (see below) displays a list of defined signal blocks. Three construct defined in the server types of signal blocks are available with an SW-MAIL license: which communicates with special symbols in the SIMPL program running in your control system.
Page 28 Crestron e-control Mail The Configuration Options window, Signal Blocks tab, showing all the signal blocks defined in the demo configuration. As shown, all seven signal blocks are active (checked); and the e-mailer signal block for demo3 is selected. Signal Blocks, once defined, can be active or inactive. A check in the box next to the signal block name indicates that the signal block is activated.
Page 29: Interface Definition
Crestron e-control Mail The highest numbered signal in the signal block’s input or output signal lists is shown in the box in the upper-right corner. This is based on the signal offset entered in the adjacent box and the current signal block definition. This value is updated synchronously as the user interacts with the window.
Page 30 Crestron e-control Mail The e-Mailer Signal Block Definition window, showing the definition of the DEMO3 e-mailer. A fictitious e-mail address has been entered into the Static “From:” Addr field. This window allows the user to assign a default “To:” name and a default “To:”...
Page 31 Crestron e-control Mail If the control system does not specify an address and this field has been left blank, the specific address is sent instead (subject to the following rules): Although, as noted, the “From:” address cannot be specified by the control system at run-time, the “From:”...
Page 32 Crestron e-control Mail messages table, eMail_Msg, and the canned recipients table, eMail_Addr. Binding these signal blocks in turn to the e-mailer signal block permits the signal block to: Once the signal block “knows about” the scrollers, simply picking items from the scrollers has the following effects: Picking an item from the “message”...
Page 33 Crestron e-control Mail In the above, signal block is replaced with the actual name of the e-mailer signal block carrying on the conversation. This option should normally remain off (unchecked). Optional signal definitions This frame lists optional signals which can be excluded from the signal block (and from the congruent Intersystem Communications symbol on the control system side).
Page 34 Crestron e-control Mail The e-Mailbox Signal Block Definition window, showing the definition of DEMO4, the e-mailbox signal block used in demo4, with the e-Mail account information frame filled in, and the Process control messages option checked. Mailbox Name and Password The Mailbox name is an account name established on the e-mail host.
Page 35 Crestron e-control Mail Intersystem Communications symbol). This option is checked in the figure above, which means that the optional signals are forced to the following definitions: None of these signals definitions can be altered so long as the Using “Receive e-Mail”...
Page 36 However, in a residential system, the end user may wish to have his Crestron system display messages from his existing e-mail account, which he presumably routinely checks when he is on- line as well.
Page 37: Server Windows And Menus
Crestron e-control Mail Server Windows and Menus This section contains descriptions of the server’s two main windows, the Server Monitor window and the Signal Analyzer window. The Server Monitor Window The Server Monitor window is the server’s main window. It appears upon starting up the server application, and remains open until the server application terminates.
Page 38 Exit terminates the server application. If the server protocol is running, a warning message appears. Server | License… opens the e-control Software Server – Upgrade/Transfer License window for licensing and activating the various server components. Server | Configure… opens the Configuration Options window described beginning on page 20.
Page 39 Crestron e-control Mail “Editing the Queries table” in the SW-DBM manual (Doc. 5823) for more information. The Signal Analyzer Window While the server protocol is running, the Server | Start w/Signal Analyzer command from the Server Monitor window opens the Signal Analyzer window. (If the server is already running, toggling Server | Signal Analyzer does the same thing.)
Page 40 Crestron e-control Mail Signal lists There are two lists which are displayed for all signal blocks (including system signal blocks for systems with signals defined), an incoming list on the left labeled CS to PC signals which contains all of the signals that go from the control system (CS) to the server (PC);...
Page 41 Crestron e-control Mail SIMPL Windows. To this end, the lists contain signal labels identical to the labels used in that symbol. The Simulate Menu This menu contains the following commands for simulating signals. Simulated signals are added to the Signal Log on the bottom portion of the window, just like real signals.
Page 42: Table Design
Crestron e-control Mail The e-Mail Database Tables The supplied sample e-Mail Database file (maildemo.mdb) contains 22 tables: The design of these tables have certain minimum requirements, particularly their names and the names of the required fields therein. [A future release may remove this constraint in order to accommodate pre-existing databases.]...
Page 43: The Queries Table
Crestron e-control Mail The Queries table The Queries table is used by scroller signal blocks to form queries which provide access to the data in the other tables. Using the Database | Queries Table… command, you can view this table’s data. As supplied, the Queries table in the sample database file is already set up for accessing the other tables.
Page 44 Crestron e-control Mail The eMail_Addr Table Each record in the eMail_Addr table must contain at least the following fields: ID, first, last, and addr. An entry with null addr field contents is still useful as a way of labeling an outgoing message which will be sent to the default recipient as described by the e-mailer signal block defaults.
Page 45 Crestron e-control Mail Message Display Table Like the IN box table, the message display table is completely maintained by the e-mailbox signal block. The structure of this table is simply a series of 80-character lines with an ID field for proper ordering. The contents of this table are transient; it emptied and repopulated every time the server opens a mail message.
Page 46: Editing The Existing Database
Crestron e-control Mail Editing the Existing Database It is not necessary to have Microsoft Access to view or edit the e-mail tables; they can be edited directly from within the server application. Open the server and select e-Mail | Tables. The e-Mail Tables window opens to display the contents of the eMail_Msg, eMail_Addr, and eMail_Subst tables of the database file named in the COM Settings tab of the Configuration Options window.
Page 47: Recipient Lookup
Crestron e-control Mail record from the interactive message scroller (see below). These values are replaced continually until the SendNow signal is issued. Note that the name and address are actually added to the list only when the SetAddr signal is issued. At that moment, the name most recently sent via SetRcptName is paired with the address and added to the recipient list.
Page 48: Manual Selection Of Recipient And/Or Message
Crestron e-control Mail The contents of the first and last If the Echo Lookups option is in effect, these data are echoed back to the control fields are concatenated together system as well (using the EchoRecp and EchoRcptAddr signals). when echoed by the EchoRecp If the Show Indirection option is also checked, a >...
Page 49: Text File Inclusion
Crestron e-control Mail An e-mailer signal block is All registers are undefined when the e-Mailer signal block is enabled. A register is enabled by assertion of its Enable defined by receipt of a SetParm and LookupParm signal. Register definitions are signal from the control system.
Page 50: Identification
Crestron e-control Mail Identification For the server to recognize control messages, the Process control messages option must be checked in the e-Mailbox Signal Block Definition window. Otherwise, none of the following applies, and messages which might have been interpreted as control messages are instead interpreted as normal messages.
Page 51: Example
Example The following example of a multi-signal control message can be sent to the control system’s mailbox for reading by Demo4. Using your usual mail client software, create a new e-mail message with in the subject header. Paste the following script into the body of the message. (Be...
Page 52: Demos
Crestron e-control Mail Demos Four demonstrations on the use of e-control Mail are included with the package. Each demo is described along with an accompanying “bird’s eye view” diagram of its SIMPL program. All demos use the following three files:...
Page 53: Demo 2: The Lookupmsg And Lookuprcpt Signals
Crestron e-control Mail table (using the first record with ID = the value of the message record’s defaultAddr field). Demo 1 Block Diagram Demo 1 SIMPL Windows Program Building this simplest example is trivial. Only two items need to be added to the control system in the Configuration Manager workspace in SIMPL Windows.
Page 54 Crestron e-control Mail example. Note that the Send e-Mail symbol’s rx and tx streams are connected to the (virtual) COM port symbol. Demo 2 Block Diagram LookupRcpt is an analog signal whose value represents a “key” (a record ID number) which is used to “look up” a name and address from an address book table.
Page 55: Demo 3: Interactive Scrollers
Crestron e-control Mail Demo 2 SIMPL Windows Program Two items need to be added to the control system in the Configuration Manager in SIMPL Windows. From the Control Systems folder in the Device Library select CNMSX-PRO; and also add a two-way serial driver to a COM port on the...
Page 56: Demo 4: Receiving E-Mail
Buffers are selected from the Analog Operations sub-folder; and Send e-Mail is selected from the e-Mail/Database sub-folder. The DBMScoller macros can be found in the Crestron Modules folder, e-Mail/Database sub-folder. Demo 3 VT Pro-e Program The structure of the demo 3 touchscreen pages echoes that of the demo 2 touchscreen pages (see above).
Page 57 Memory sub-folder; and Receive e-Mail is selected from the e-Mail/Database sub-folder. The DBMScoller macros can be found in the Crestron Modules folder, e-Mail/Database sub-folder. Demo 4 VT Pro-e Program Page 4: Receiving e-mail into an IN box: The first page of the VT Pro-e program has some introductory information about the demo and a button labeled “Go...
Page 58 Crestron e-control Mail (join= PageFlip signal. Demos ). Only after the desired data has been sent, the server issues the NONE Installation & Reference Guide — Doc. 5798 SW-MAIL...
Page 59: Appendix A: Theory Of Operation
68 for in-depth information on these signals. Server Protocol Run the Crestron Software Server application, swserver.exe, to license (Server | License…) and configure (Server | Configure…) server operation. Although the server application is now running, the server protocol must be manually started (Server | Start) t o establish the communications link.
Page 60 Crestron e-control Mail COM Settings definition which contains a similar set of error reporting signals.. These signals include ErrNumber, ErrString, and ErrTrigger. See the “Signal Reference” on page 68 for details. Appendices SW-MAIL Installation & Reference Guide — Doc. 5798...
Page 61: Appendix B: Intersystem Communications And Signal Space Considerations
Appendix B: Intersystem Communications and Signal Space Considerations The Send e-Mail SIMPL Windows The following discussion applies in general to all Crestron Software Server symbol is available from the components. Keep in mind while reading this section that use of the Intersystem Crestron FTP site.
Page 62 Crestron e-control Mail Encoding and Decoding the Serial Data Stream Analog, serial, and digital signals to be sent from the control to the server are fed into the input (left) side of an Intersystem Communications symbol which encodes the signals into a serial data stream, available as an output labeled tx$ (for transmitter).
Page 63 Crestron e-control Mail to the control system. All the symbols’ rx$ and tx$ streams are tied to the same serial driver symbol. The set of signals intended for a particular Intersystem Communications symbol are distinguished from the other sets by their offset and/or their channel number.
Page 64: Multiple Connections
Crestron e-control Mail Multiple channels Multiple channels apply to connections made through Virtual COM Ports only (i.e., TCP/IP connections only). Each Virtual COM Port can have up to 128 channels, where each channel can be thought of as a separate COM port. If a separate channel is used for each Intersystem Communications symbol, then all Intersystem Communications symbols can use an offset of zero (i.e., no offset).
Page 65: Appendix C: Signal Reference
Sender The e-mail account referred to by the address that appears in the “From:” header. Server The Crestron Software Server. That is, swserver.exe running on a Windows PC. Signal Block Active component within the Server which listens for and responds to signals from connected control systems. For example, each scroller requires its own signal block.
Page 66: Standard E-Mail Address Format
Crestron e-control Mail also true of base 2: The lowest order “bit,” (binary digit), on the far right, and are numbered starting from 0. Thus, when sixteen bits are available, they are numbered 0 to 15 from right to left — because each bit on its own represents the quantities 2 through 2 Bit patterns as used here do not represent quantities.
Page 67: Error Reporting
Crestron e-control Mail The sender’s “real” name is While most mail (SMTP) servers accept any account name (such as “anonymous”) specified by the SetFromName for outgoing mail, some servers only accept outgoing mail from a known account. In signal, or by the default specified these rare cases, the sender’s real name may be ignored by the SMTP server and...
Page 68: Signal Reference
Crestron e-control Mail Signal Reference The alphabetical reference proper begins on the next page. Appendices Signal Block(s) Signal Name e-mailer EchoRcptAddr e-mailer EchoRcptName e-mailer, EchoSubj e-mailbox e-mailer, Enable e-mailbox e-mailer, Enabled e-mailbox ErrNumber ErrString ErrTrigger e-mailbox KeepAsNew e-mailer LookupMsg e-mailer...
Page 69 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices e-Mailbox signal blocks Checks the e-mail host for waiting mail. system-to-server Digital Pulse (actually, leading edge is the trigger; trailing edge is ignored) Done pulse The server logs onto the POP3 (incoming e-mail ) host and retrieves waiting mail.
Page 70 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices ClearNames e-Mailer signal blocks Clears the recipient list. system-to-server Digital Pulse (actually, leading edge is the trigger; trailing edge is ignored) Done pulse Also clears any To: name which may have been previously sent with SetRcptName but has not yet actually been added to the recipient list with SetAddr.
Page 71 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices Delete e-Mailbox signal blocks Signals server to delete the message most recently picked from the IN box. server-to-system Digital Pulse None The message is deleted from both the e-mail host and the IN box database table —...
Page 72 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices Done System signal blocks e-Mailer signal blocks e-Mailbox signal blocks scroller signal blocks (“standard” or “custom”) Indicates requested operation completed successfully server-to-system Digital Pulse None Sent to control system in response to most system-to-server signals, indicating that the requested operation has been successfully completed.
Page 73 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices EchoBody e-mailer signal blocks String sent as feedback in response to setting a new subject header Server-to-system Serial New body text None Definition of this signal is optional.
Page 74 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices EchoDate e-mailbox signal blocks String sent as feedback in response to opening an e-mail message Server-to-system Serial Verbatim text from the message’s date header None Definition of this signal is optional.
Page 75 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices EchoFrom e-mailbox signal blocks String sent as feedback in response to opening an e-mail message Server-to-system Serial Name or address from the message’s sender (“From:”) header None Definition of this signal is optional.
Page 76 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices EchoRcpt e-Mailbox signal blocks String sent as feedback in response to opening an e-mail message Server-to-system Serial List of recipient names or addresses from the message’s recipient (“To:”) header None Definition of this signal is optional.
Page 77 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices EchoRcptAddr e-Mailer signal blocks String sent as feedback in response to setting a new recipient address Server-to-system Serial New recipient address None Definition of this signal is optional.
Page 78 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices EchoRcptName e-Mailer signal blocks String sent as feedback in response to setting a new recipient name Server-to-system Serial New recipient name None Definition of this signal is optional.
Page 79 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments Appendices EchoSubj e-Mailer signal blocks e-Mailbox signal blocks String sent as feedback in response to setting a new subject header Server-to-system Serial Text of subject header from selected message None Definition of this signal is optional.
Page 80 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices Enable e-Mailer signal blocks e-Mailbox signal blocks scroller signal blocks (“standard” or “custom”) This signal enables/disables the signal block. system-to-server Digital Assert to enable the signal block...
Page 81 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices Enabled e-Mailer signal blocks e-Mailbox signal blocks scroller signal blocks (“standard” or “custom”) “Handshake” response to the Enable signal. server-to-system Digital Asserted in response to assert of Enable signal.
Page 82 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices ErrNumber System signal blocks e-Mailer signal blocks e-Mailbox signal blocks scroller signal blocks (“standard” or “custom”) When the server encounters an error, it uses this signal to send an error number to the control system.
Page 83 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices ErrString System signal blocks e-Mailer signal blocks e-Mailbox signal blocks scroller signal blocks (“standard” or “custom”) Description of error Server-to-system Serial Error message for display...
Page 84 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices ErrTrigger System signal blocks e-Mailer signal blocks e-Mailbox signal blocks scroller signal blocks (“standard” or “custom”) Trigger for ErrNumber and ErrString Server-to-system Digital Pulse None This signal is sent after the ErrNumber and ErrString to indicate that an error condition has occurred.
Page 85 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices KeepAsNew e-Mailbox signal blocks Marks the opened e-mail message as new system-to-server Digital Pulse Pulse of Done signal Mail is immediately transferred to the IN box’s “old mail view” the first time it is opened.
Page 86 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices LookupMsg e-Mailer signal blocks Performs a lookup on a message in the database, and sets subj and body accordingly system-to-server Analog A number matching the contents of the ID field of a record in the eMail_Msg table of the database file.
Page 87 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices LookupParm e-Mailer signal blocks Sets a particular text substitution register system-to-server Analog A number matching the contents of the ID field of a record in the eMail_Msg table of the database file specified in the e-Mailer signal block definition.
Page 88 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices LookupRcpt e-Mailer signal blocks Performs a lookup on a recipient in the database, and adds it to the recipient list system-to-server Analog A number matching the contents of the ID field of a record in the eMail_Addr table of the database file.
Page 89 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices NewCount e-Mailbox signal blocks Number of messages in the “new mail view” of the IN box. system-to-server Analog Quantity intended for a digital gauge object Pulse of Done signal Definition of this signal is optional.
Page 90 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices NewMail e-Mailer signal blocks Resets all e-Mail data System-to-server Digital Pulse (actually, leading edge is the trigger; trailing edge is ignored) Done pulse Specifically: Clears the From: name back to the default specified in the e-Mailer signal block definition.
Page 91 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices OldCount e-Mailbox signal blocks Number of messages in the “old mail view” of the IN box. system-to-server Analog Quantity intended for a digital gauge object Pulse of Done signal Definition of this signal is optional.
Page 92 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices PageFlip e-Mailbox signal blocks A message has been “opened” server-to-system Digital Pulse None Definition of this signal is optional. A message is opened by a valid pick from the IN box scroller, i.e., a Pick signal on a non-null row of the scroller.
Page 93 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices Reply e-Mailbox signal blocks Prepares a reply message based on the currently opened message system-to-server Digital Pulse Pulse of Done signal If there is a bound e-mailer signal block, issues the following signals to same:...
Page 94 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices SendNow e-Mailer signal blocks Sends the e-Mail message. system-to-server Digital Pulse (actually, leading edge is the trigger; trailing edge is ignored) Done pulse You must select a name and a message before sending. If no value was specified...
Page 95 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices SetBody e-Mailer signal blocks Sets the body text of the message. System-to-server Serial (string) New value for the actual body of the e-Mail message. None Optional.
Page 96 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices SetFromName e-Mailer signal blocks Sets the sender’s real name. This name is included in quotes in the “From:” header of the e-Mail message, in front of the sender’s e-Mail address. It is not considered part of the address and may be set to anything —...
Page 97 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices SetParm e-Mailer signal blocks Sets a particular text substitution register system-to-server Serial (string) New value for register n. Can contain additional text substitution directives, or parts thereof.
Page 98 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices SetRcptAddr e-Mailer signal blocks Sets the recipient’s e-mail address. system-to-server Serial (string) New recipient address None This signal is not required to send e-mail. This signal is one of several methods of setting the recipient address.
Page 99 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices SetRcptName e-Mailer signal blocks Sets the recipient’s real name. This is included in quotes in the “To:” header of the e-Mail message, in front of the recipient’s e-Mail address. It is not considered part of the address and may be set to anything —...
Page 100 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices SetSubj e-Mailer signal blocks Sets the e-Mail message’s Subj: header. system-to-server Serial (string) New value for the Subj: header of the next e-Mail message to be sent.
Page 101 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices Shortcut e-Mailer signal blocks Sends message n to its default recipient system-to-server Digital Pulse (actually, leading edge is the trigger; trailing edge is ignored) Done pulse Definition of these signals is optional.
Page 102 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices SignalA e-mailbox signal block Analog signal received in an e-mail “control” message Server to System Analog Arbitrary 16-bit value None Definition of these signals is optional. The number of signals defined is controlled by the value in the A textbox, Control messages frame, e-Mailbox Signal Block Definition window.
Page 103 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices SignalD e-mailbox signal block Analog signal received in an e-mail “control” message Server to System Digital Arbitrary digital state None Definition of these signals is optional. The number of signals defined is controlled by the value in the A textbox in the e-Mail control message signals frame of the e-Mailbox Signal Block Definition window.
Page 104 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices SignalS e-mailbox signal block Analog signal received in an e-mail “control” message Server to System Serial Arbitrary serial data None Definition of these signals is optional. The number of signals defined is controlled by the value in the A textbox in the e-Mail control message signals frame of the e-Mailbox Signal Block Definition window.
Page 105 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices Status e-mailbox signal block Analog signal received in an e-mail “control” message Server to System Analog Progression of values representing check mail progress None Definition of this signal is optional.
Page 106 Crestron e-control Mail Applies to Description Direction Type Value Expected Reply Comments See Also Appendices ViewOldMail e-mailbox signal block Switches IN box scroller between the “new mail view” and the “old mail view.” Server to System Digital Assert: Requery IN box scroller recordset and display only old mail De-assert: Requery IN box scroller recordset and display only new mail Possible new data to IN box scroller’s List and Scrollbar signals...
Page 107: Appendix D: System Limitations
The XSIG format limits the number of signals to 4096, only the first 1024 of which may be analog or serial signals. Furthermore, the older generation of Crestron control systems has a limit of 512 analog/serial signals. (This is not an issue with the newer CNMSX and CNRACKX systems which allow a full 4096 analog/serial signals.)
Page 108: Appendix E: Standard Scroller / Custom Scroller Feature Comparison
Crestron e-control Mail Appendix E: Standard Scroller / Custom Scroller Feature Comparison Standard scroller options no license required Enable signal non-functional except in simulation (from Signal Analyzer window). Enabled signal sent by server as usual (but not available through DBMScroller macro).
Page 109: Appendix F: Dial-Up Tcp/Ip Configuration
Our experience is that the initial settings upon a fresh installation of Dial-Up Networking are usually already set to allow for dialing without user confirmation. If, however, you find this is not the case, you may be able to reconfigure the software by following these steps:...

This manual is also suitable for:

E-control mail

Crestron SW-MAIL User Manual

How to Use this Manual

Quick Start Guide 1: Sending E-Mail (Demo3)

Quick Start Guide 2: Receiving E-Mail (Demo4)

Introduction

Basic Server Setup

Server Configuration in Depth

The E-Mail Database Tables

Composing E-Mail

Text Substitution and File Inclusion

Control Messages

Demos

Appendix A: Theory of Operation

Appendix B: Intersystem Communications and Signal Space Considerations

Appendix C: Signal Reference

Appendix D: System Limitations

Appendix E: Standard Scroller / Custom Scroller Feature Comparison

Appendix F: Dial-Up TCP/IP Configuration

Quick Links

Need help?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Crestron SW-MAIL

Summary of Contents for Crestron SW-MAIL

This manual is also suitable for:

Table of Contents