Variable
|
Possible Values
|
Description
|
BodyMaxChars
|
Numeric
|
Example: BodyMaxChars = 200
This parameter limits the length of the %Message% macro and does not override the carrier "Max Chars" setting.
|
EnvelopeFrom
|
Email Address
|
Example: EnvelopeFrom = your@sender.com
Every email has two sender values, one on the 'outer' envelope and one on the 'inner' envelope.
This setting will only change the outer envelope sender value. When this variable is not present, the outer and inner envelope sender value is the same. This variable provides a way to use a different outer envelope sender value, if required.
|
EnvelopeFromAsEmail
|
True
False
|
Example: EnvelopeFromAsEmail = True
This variable forces the EnvelopeFrom value to be turned into an valid email address, if it isn't already.
|
Filter
|
File path to and file name of the filter to run
|
Note: pgfilter.exe and pgfilter.dll must reside in the PageGate program directory to use this parameter.
Example: Filter = c:\PageGateData\Filters\yourfilter.xml
It is entirely possible to call on PageGate's filtering system when delivering an SMTP/Email message, allowing you to reformat messages that enter the queue to any data structure you need. As an example, you could have a filter take every message and put it in an XML payload for delivery.
|
FilterDebugFile
|
File path to and file name of the log to write
|
Example: FilterDebugFile = c:\PageGateData\Filters\outboundfilter1.log
When using a filter, you can use this variable to output this specific filter's log to the specific location and file name.
|
From
|
Email Address
|
Example: From = your@sender.com
This variable overrides any sender information passed in by the interfaces and APIs.
By specifying this variable, you're telling PageGate to use a single, standardized sender's name for all traffic controlled by this template.
|
InterMessageDelay
|
Number of Milliseconds
|
Example: InterMessageDelay = 1000
This variable inserts a pause, in milliseconds, in between each message that is delivered. This is sometimes required to stay below messaging thresholds for SMTP servers.
|
InternetDomain
|
Email domain
|
Example: InternetDomain = alternate.domain.org
This variable is used when carrier a should declare that messages are coming from a domain other than the one specified in the global template. Generally
speaking, this variable should be set at a global level unless an exception is being made.
|
ReplyTo
|
Email Address
|
Example: ReplyTo = YourEmail@domain.com
If the reply email address should be something other than the 'From' value, this variable allows you to specify the necessary address.
|
SmtpConnectTimeout
|
Number of Seconds
|
Example: SMTPConnectTimeout = 40
This variable specifies the number of seconds PageGate should wait for a response from an SMTP host.
|
SmtpForceAuth
|
login
plain
cram-md5
ntlm
|
Example: SmtpForceAuth = plain
This variable forces PageGate to only use the specified authentication method, rather than selecting from the list of supported authentication styles reported by the mail server. PageGate currently supports using LOGIN, PLAIN, CRAM-MD5 and NTLM authentication.
|
SmtpForceStartTls
|
True
False
|
Example: SmtpForceStartTls = True
This variable forces a carrier to use STARTTLS for its SMTP transactions, regardless of the value specified in the 'Port' field of the carrier settings.
|
SmtpFriendlyNames
|
True
False
|
Example: SmtpFriendlyNames = True
Some SMTP hosts use SMTP 'Friendly Names' as a part of anti-spam monitoring policy. Settings this value to true tells PageGate to include the SMTP 'Friendly Name' information in this carrier's transactions.
|
SmtpHelloHost
|
Email domain
|
Examples: SmtpHelloHost = %InternetDomain%, SmtpHelloHost = hardcodedvalue.org
During the SMTP negotiation, this value is used during the EHLO/HELO exchange. Typically speaking, you will want this value to mirror the InternetDomain value and this should also be set at a global level.
Implementing this at a carrier level is intended to create exceptions to the global rule, telling this carrier it should use a different value.
|
SmtpQpEncode
|
True
False
|
Example: SMTPQpEncode = False
By default, PageGate uses Quoted Printable encoding for SMTP/Email. However, some systems can't interpret this format and require plaintext, so 'QP Encoding' needs to be turned off.
|
SmtpSendReset
|
True
False
|
Example: SmtpSendReset = False
By default, PageGate issues the SMTP RSET command, which reset's the sessions values, between each message. This parameter provides the ability to turn that behavior off.
|
SmtpTLSVersion
|
Text
|
Example: SmtpTLSVersion = TLS 1.3 or higher
This parameter configures the version of TLS/SSL that should be used by this carrier. Valid values are:
•default •TLS 1.3 •TLS 1.2 •TLS 1.1 •TLS 1.0 •SSL 3.0 •TLS 1.3 or higher •TLS 1.2 or higher •TLS 1.1 or higher •TLS 1.0 or higher |
SmtpUseDkim
|
True
False
|
Example: SmtpUseDkim = True
If you have PageGate configured to deliver email as a mail server and have created a DKIM record, set this value to true to have PageGate include the DKIM signature in delivered traffic.
|
StripAlpha
|
True
False
|
Example: StripAlpha = True
Setting this value to true will remove any alphabetical character from messages delivered through this carrier. For example, if you tried to send the message 'Alert on node 127.0.0.1', the only thing delivered would be '127.0.0.1'
|
StripCharacters
|
See description
|
Example: StripCharacters = |\~
This parameter will remove all instance of any character(s) entered. In the above example, that would strip out all pipes (|), backslashes (\) and tildes (~).
|
StripNonPrintable
|
True
False
|
Example: StripNonPrintable = True
Settings this value to true will remove any non-printable ASCII characters, like carriage returns, line feeds, horizontal tabs and similar, from messages delivered through this carrier.
|
SubjectDefault
|
Text
|
Example: SubjectDefault = Dispatch Alert
This parameter is used to set the subject line of all messages delivered through this carrier to a single, standard value.
|
SubjectDelimiter
|
Text
|
Example: SubjectDelimiter = \013\010|~|:
This parameter tells PageGate to look in the message text for subject line information. Multiple objects may be searched for and you'll want to separate each search parameter with a pipe. ASCII values may be scanned for but you must prefix any ASCII code with a backslash (\).
In the above example, that would scan for a carriage return+line feed or a tilde (~) or a colon (:) within the specified SubjectSearchLength.
Subjects parsed by this parameter are overridden by the SubjectDefault parameter.
|
SubjectFilter
|
File path to and file name of the filter to be run
|
Note: pgfilter.exe and pgfilter.dll must reside in the PageGate program directory to use this parameter.
Example: SubjectFilter = c:\PageGateData\Filters\yourfilter.xml
This parameter allows you to specify a filter that will only be run on the subject line of traffic delivered through this carrier.
|
SubjectFilterDebugFile
|
File path to and file name of the log to be written
|
Example: FilterDebugFile = c:\PageGateData\Filters\CarrierSubjectFilterLog.log
When using a filter, you can use this variable to output this specific filter's log to the specific location and file name.
|
SubjectMaxChars
|
Numeric
|
Example: SubjectMaxChars = 20
This parameter determines the maximum number of characters the subject line may contain.
|
SubjectSearchLength
|
Numeric
|
Example: SubjectSearchLength = 10
This parameter determines how many characters in to the message PageGate should look for the configured delimiting character(s).
|
To
|
Email address
|
Example: To = email@address.gov
This parameter forces all traffic to go to a single email address, overriding any interface or recipient values for the delivery address.
|
UseAlternateDNS
|
True
False
|
Example: UseAlternateDNS = True
PageGate has a few methods of performing DNS lookups. If you are experiencing issues with standard DNS lookups, setting this parameter to true will tell the program to use an alternate method for performing them.
|
UseFilterDll
|
True
False
|
Note: pgfilter.exe and pgfilter.dll must reside in the PageGate program directory to use this parameter.
Example: UseFilterDll = True
Setting this parameter to true tells PageGate to use the filter dll, which is a more efficient method of running the filter.
|