All Protocol Delivery Variables

Top  Previous  Next

This is the uncategorized and complete list of all protocol delivery variables.

NOTE: When referencing any non-printable character, such as a line feed, carriage return, horizontal tab or similar, you must use the ASCII code for that character and it must be prefixed by a backslash (\).

 

 

Variable

Description and Possible Values

UseAlternateDNS

Set this to True or False.

This variable tells PageGate to use an alternate method to get MX records from DNS servers.

Example: UseAlternateDNS = True

If this variable is not present, a False value is assumed.

InternetDomain

This variable sets the value of the %InternetDomain% macro used by the SMTPHelloHost and is also used by other protocols when certain values need to be transformed in to valid email addresses.

 

When configured for direct delivery, PageGate must declare an email domain name within the SPF record of the system's public IP address.

When configured for relayed delivery, PageGate must declare the email domain name required by the relaying SMTP server.

SMTPHelloHost

This variable should always be set to %InternetDomain%.

Example: SMTPHelloHost = %InternetDomain%

During the SMTP negotiation sequence, PageGate must declare the domain it is delivering traffic on behalf of in the EHLO/HELO statement. This value is specified by the previous InternetDomain variable.

SubjectDelimiter

This value determines what character PageGate will recognize as the delimiter (separator) for the subject part of a message.

 

PageGate looks for the SubjectDelimiter within the number of characters specified in the SubjectSearchLength (see below) value. If any character in the SubjectDelimiter string is found, PageGate uses everything before the delimiter as the subject. Multiple delimiters can be specified and you will need to separate each value by a pipe '|', which functions as an OR statement.

 

For example, let's say we wanted a colon (:) to be the SubjectDelimiter value. This is what we would use:

SubjectDelimiter = :

 

Let's also say we have a message that says "This is the subject: This is the message".

 

PageGate program would recognize "This is the subject" as the subject and use it as such because it was followed by a ':'.

 

As another example, let's say we have this specified:

SubjectDelimiter = \013\010|\013|\010

 

This configures PageGate to recognize a Carriage Return + Line Feed OR a Single Carriage Return OR a Single Line Feed as the subject delimiter.

SubjectSearchLength

This variable determines the number of characters within the message to look for the subject.

For example, SubjectSearchLength = 50 would tell PageGate to scan the first 50 characters of the message for any specified subject delimiter.

SubjectDefault

In the event that PageGate does not see any variables specified by SubjectDelimiter within the SubjectSearchLength string, this is the default text that will be used as the subject instead.

From

This variable overrides the value passed into PageGate by the APIs/modules/interfaces. By specifying this variable, you're telling PageGate to use a single, standardized sender's name for all traffic controlled by this template.

To

This variable overrides the ID/PIN or Email values. By specifying this variable, you're telling PageGate to send all traffic processed by this template to the specified ID or email address.

EnvelopeFrom

This variable is similar to the 'From' variable found above. However, this setting will only change who the message is reported to be from during the communication session with the carrier.  It has no effect the message content or values specified by any Macro.

EnvelopeTo

This variable is similar to the 'To' variable found above. However, this setting will only change who the message is set to during the communication session with the carrier. It has no effect the message content or values specified by any Macro.

EnvelopeFromAsEmail

Set to True or False. If this variable is not present in the template, a False value is assumed.

 

This variable forces the EnvelopeFrom value to be turned into an valid email address if it isn't already. This variable only applies to the SMTP and WCTP protocols.

InterMessageDelay

Set this to a number of milliseconds (1000 = 1 second).

 

This variable tells PageGate to delay for the specified number of milliseconds after delivering each message.

WCTPResponsesTo

This variable tells PageGate to include the sendResponsesToID field in the message envelope. A value of 'none' will instead send an allowResponse field with the value of 'false'

Example: WCTPResponsesTo = email@domain.com

 

Variable

Possible Values

Example Statement

Description

GSMUseCmgf

True

 

False

GSMUseCmgf = True

This variable specifies that the AT+CMGF=1 command should be used to enter text delivery mode.

 

If your modem supports AT+CMGF=1, set this variable to true for the carrier or connector using the IP capable cellular modem, router or gateway. If this variable is not present, a default value of False is assumed.

 

This variable should be used when configuring PageGate to use Multitech cellular hardware and any cellular hardware that uses the standard AT command set.

GSMUseWscl

True

 

False

GSMUseWscl = True

This variable specifies that the AT+WSCL=1,2 command should be used to enter text delivery mode.

 

If your modem supports AT+WSCL=1,2, set this variable to true for the carrier or connector using the IP capable cellular modem, router or gateway.If this variable is not present, a default value of False is assumed.

 

This variable is used for certain types of CDMA cellular hardware.

GSMUseCmgs

True

 

False

GSMUseCmgs = True

This variable specifies that the AT+CMGS command should be used to deliver text messages.

 

If your modem supports AT+CMGS, set this variable to true for the carrier or connector using the IP capable cellular modem, router or gateway.If this variable is not present, a default value of False is assumed.

GSMUseSmsm2m

True

 

False

GSMUseSmsm2m = True

This variable specifies that the AT*SMSM2M command should be used to deliver text messages.

 

If your modem supports AT*SMSM2M, set this variable to true for the carrier or connector using the IP capable cellular modem, router or gateway. If this variable is not present, a default value of False is assumed.

 

This variable should be used when configuring PageGate to use Airlink cellular hardware and any cellular hardware that requires the AT*SMSM2M command to deliver text messages.

GSMSetTextModeOnce

True

 

False

GSMSetTextModeOnce = True

Some cellular modem, routers and gateways only require a single instance of the "Enter Text Deliver Mode" command to be issued. This variable specifies that Pagegate should only send the command to enter text delivery mode once until Connector is restarted. This variable should not be used with cellular modems that require the "Enter Text Delivery Mode" command be issued in each session.

 

If this variable is not present, a default value of False is assumed.

InterMessageDelay

Milliseconds

InterMessageDelay = 1000

This variable tells PageGate to delay for the specified number of milliseconds (1000 = 1 second) after delivering each message.

GSMUseGT

True

 

False

GSMUseGT = True

This variable tells PageGate to wait for a '>' after sending phone number with CMGS command.

ModemWakeupCommand

Text

ModemWakeupCommand =

Custom Variable Here

If your cellular modem, router or gateway requires something other than AT<CR> to wake up, use this variable to specify the necessary command.

UseTelnet

True

 

False

UseTelnet = True

This variable tells PageGate to negotiate telnet terminal capabilities upon connection

From

Text

From = CAD

This variable overrides the value passed to PageGate by the input modules/APIs. By specifying this variable, you're telling PageGate to use a single, standardized sender's name for all traffic controlled by this template.

To

Text

To = 7818290500

This variable overrides the ID/PIN or Email values. By specifying this variable, you're telling PageGate to send all traffic processed by this template to the specified ID or Email address instead.

ResponseRecipient

Recipient

 

Group

ResponseRecipient = A recipient or group's name as it exists in the PG Admin

When the HTTP GET or POST transaction completes, the specified recipient or group will receive any responses from the receiving API/web host. For more information, please see the Two Way Messaging section of the documentation.

SNPPMessOnly

True

 

False

SNPPMessOnly = True

This variable tells PageGate to use the MESS command, instead of the DATA command, during the SNPP delivery sequence.

IgnoreCD

True

 

False

IgnoreCD = True

This variable tells PageGate to ignore the Carrier Detect signal when establishing a connection.