Skip to main content

Need Help Using Spok Knowledge?

Internet Explorer is not supported. Please reload in Chrome, Edge, Firefox, or Safari.
Spok

Spok Messenger Gateways: Email

A single Email Gateway is defined that can send and receive email messages. As email is sent via TCP/IP, no serial port needs to be associated with the Email Gateway. 

The Email Gateway sends email messages to contacts defined as such, with the destination email address appearing in the Address field of the contact details.

It can also receive messages for recipients via email. In this case, the message should be sent to "Local ID@Paging Domain". 

 

A description of the fields is shown below:

Email Gateway is enabled

Should only be disabled if you want to temporarily stop the normal operation of incoming and outgoing email messages.

Paging domain

Represents the sender domain for outgoing email and the destination for incoming email. A special DNS entry probably needs to be established to allow incoming email to work correctly. The network administrator of your organization should set this up.

Outgoing Email enabled

Allows Spok Messenger email contacts to initiate an email message.

Incoming SMTP Port

The IP port number used to listen for incoming email.

Incoming connection timeout

Sets the number of seconds before disconnecting an incoming connection if no data is received.

Reject incoming larger than

Sets the maximum packet size of incoming email that is forwarded to Spok Messenger recipients.  It takes into account all header information, not just the length of the message.  In the event that a message larger than this is sent to Spok Messenger, a message is automatically returned to the initiating email address informing them that the message was too long.

Direct all messages via

When set to DEFAULT MAPPING, this looks up recipients based on the target address of the incoming email. When set to a gateway, all incoming email messages are forwarded to that gateway and directly addressed with the email's recipient.

Ignore sender domain

Allows Spok Messenger to receive email messages from any email address when selected.

Reject from domains in list

Stops Spok Messenger from receiving messages on certain domains. To add a new domain, enter it in the adjacent field and click Add.  To remove a domain from the list, select the domain to remove and click on Delete.  Please note that any subdomains are also rejected.

Only accept from domains in list

Performs the inverse function to the above setting and hence Spok Messenger only receives messages from domains in the list when selected.

Forward Subject

Includes the subject line of the incoming email as part of the message when checked.

Forward Body

Includes the actual message of the incoming email when checked.

Forward Sender

Includes the email address of the email originator when checked.

Port

Refers to the IP port used to send email messages to the SMTP Relay host defined above.  It should be set to 25, unless you know that your network is set up to use a different port for SMTP traffic.

Connection timeout

Sets the number of seconds before disconnecting if no response is received from the SMTP Relay Host.

Subject format

This is a string which defines how the subject is formatted for output. You can have up to 240 characters, which may be:

A normal character, which is output in every message

%[mod len]Field which inserts message information to a specific format

 

Field (case sensitive) determines the data to be inserted:

%a - the message's target address

%m - the message text is inserted

%n - product name

%t - the type (0 for tone only, 1 numeric, 2 alpha, 3 email etc.) is inserted as a digit

%p - the priority (0 for normal, 1 for priority)

%b - the beep code (A through J) is inserted as a character.

%s - the sequence number of the message from this gateway

%u - the username that generated the message, otherwise "System"

mod allows padding (space for left padding with spaces, - for right padding with spaces, 0 for left padding with zeroes.
len is the total length of the field

If the data is longer than len then no padding is inserted.
(mod and len only apply to fields a, m and s)

 

For example: %06a with address 123 would output 000123, whereas %-6a would output 123 _ _ _

\n, \r, \t are (case sensitive) line feed, carriage return and tab, respectively

\xnn inserts the byte defined by hex code nn

\\ and \% insert the \ and % characters, respectively

Message Width

The formatted width of the email.  Carriage returns and line feeds are removed from the original message, and new formatting is applied with this width.  Adding a 0 disables formatting.

Use DNS to deliver email

If selected, email is sent directly to the destination mail server without the need of a relaying mail server.

Primary DNS

The primary domain name server used for looking up the IP address of the destination mail server.

Secondary DNS

The secondary domain name server used for looking up the IP address of the destination mail server.

SMTP Relay host

The address of the email server used to send messages. This may be a computer on the local network or the mail server on your Internet Service Provider.

Use SMTP Authentication

If selected, an attempt is made to login to the relaying mail server.

Username

The username needed to login to the relaying mail server.

Password

The password needed to login to the relaying mail server.

 

Adding an Email Gateway

  1. Choose Interfaces > Email. The Email Gateway Settings – Edit dialog displays.
  2. Click the General tab. The General tab displays.
  3. Edit the desired fields. A description of each field is shown below.

Email Gateway is enabled

Should only be disabled if you want to temporarily stop the normal operation of incoming and outgoing email messages.

Paging domain

Represents the sender domain for outgoing email, and the destination domain for incoming email. A special DNS entry probably needs to be established to allow incoming email to work correctly. The network administrator of your organization should set this up.

Outgoing Email enabled

Allows Spok Messenger email contacts to initiate an email message. 

  1. Click the Incoming tab. The Incoming tab displays.

  1. Edit the information as desired. A description of each field is shown below.

Incoming SMTP Port

The IP port number used to listen for incoming email. It should be set to 25 under normal circumstances.

Incoming connection timeout

Sets the number of seconds before disconnecting an incoming connection if no data is received.

Reject incoming larger than…

Sets the maximum packet size of incoming email that is forwarded to Spok Messenger recipients. It takes into account all header information, not just the length of the message. In the event that a message larger than this is sent to Spok Messenger, a message is automatically returned to the initiating email address informing them that the message was too long.

Direct all messages via

When set to DEFAULT MAPPING looks up recipients based on the target address of the incoming email. When set to a gateway, all incoming email messages are forwarded to that gateway and are directly addressed with the email's recipient.

Ignore sender domain

Allows Spok Messenger to receive email messages from any email address when selected.

Reject from domains in list

Stops Spok Messenger from receiving messages on certain domains. To add a new domain, enter it in the adjacent field and click Add. To remove a domain from the list, select the domain to remove and click on Delete. Please note that any subdomains are also rejected.

Only accept from domains in list

Performs the inverse function to the above setting, and hence Spok Messenger only receives messages from domains in the list when selected.

Forward Subject

Includes the Subject line of the incoming email as part of the message when checked.

Forward Body

Includes the actual message of the incoming email when checked.

Forward Sender

Includes the email address of the email originator when checked.

  1. Click the Outgoing tab. The Outgoing tab displays.

Edit the desired information. A description of each field is shown below.

 

Port

Refers to the IP port used to send email messages to the SMTP Relay host defined above. It should be set to 25, unless you know that your network is set up to use a different port for SMTP traffic.

Connection timeout

Sets the number of seconds before disconnecting if no response is received from the SMTP Relay Host.

Subject Format

This is a string which defines how the subject is formatted for output. You can have up to 240 characters, which may be:

A normal character is output in every message.

%[mod len]Field inserts message information to a specific format. Some options are shown below:

 

%a

The message's target address.

%m

The message text is inserted.

%n

Product name.

%t

The type (0 for tone only, 1 numeric, 2 alpha, 3 email etc.) is inserted as a digit.

%p

The priority (0 for normal, 1 for priority).

%b

The beep code (A through J) is inserted as a character.

%s

The sequence number of the message from this gateway.

%u

The username that generated the message, otherwise "System".

 

 

  • Mod allows padding:

Space

For left padding with spaces.

-

For right padding with spaces.

0

For left padding with zeroes.

 

  • Len is the total length of the field (if the data is longer than len then no padding is inserted)
  • mod and len only apply to fields a, m, and s
    • For example: %06a with address 123 would output 000123, whereas %-6a would output 123 _ _ _
  • \n, \r, \t are (case sensitive) line feed, carriage return and tab, respectively
  • \xnn inserts the byte defined by hex code nn
  • \\ and \% insert the \ and % characters, respectively

Message Width

The formatted width of the email. Carriage returns and line feeds are removed from the original message and new formatting is applied with this width. Adding a 0 disables formatting.

Use DNS to deliver email

If selected, email is sent directly to the destination mail server, without the need of a relaying mail server.

SMTP Relay host

The address of the email server used to send messages. This may be a computer on the local network or the mail server on your Internet Service Provider.

Primary DNS

The primary domain name server used for looking up the IP address of the destination mail server.

Secondary DNS

The secondary domain name server used for looking up the IP address of the destination mail server.

Use SMTP Authentication

If selected, an attempt is made to login to the relaying mail server.

Username

The username needed to login to the relaying mail server.

Password

The password needed to login to the relaying mail server.

 

After the desired changes have been made, click on the Save button to commit the changes to the database. In order to send email via Spok Messenger, you must set up contacts to use this gateway.

 

Editing an Email Gateway

An existing Email Gateway can be edited.

  1. Choose Interfaces > Email. The Emails Gateway dialog displays.
  2. Select the gateway to be edited from the list on the left.
  3. Change the desired information.
  4. Click Save. The changes to the gateway are saved.

 

Deleting an Email Gateway

Existing Email Gateways can be deleted.

  1. Choose Interfaces > Email.
  2. Select the Email menu option. The Email Gateways dialog displays.
  3. Select the gateway to be deleted from the list.
  4. Click Delete or press the delete key on the keyboard. The gateway is deleted.