These variables containing Sender Option keywords appear only sender template files, and are never added to FS files generated by the Gateway.
For details of variables set in FS files by the Gateway, see Variables Set by the Gateway.
Sender templates may contain the special variables shown below. These variables, SMTP_BODY_OPTIONS, SMTP_SENDER_OPTIONS, SMTP_ERROR_OPTIONS, SMTP_NOTIFY_OPTIONS, and SMTP_PASSWORD are defined using $var_def commands in the FST file.
We recommend that you set these options using the Sender Options dialog in the Gateway Manager validation dialogs (right-click the sender name to access this) to avoid spelling the option names incorrectly on the template $var_def command.
In earlier releases, SMTP_OPTIONS were defined as a long string of 0 and 1 digits. Until further notice the Gateway still accepts this format, but if you edit a template in Gateway Manager the entries will be converted to the keyword format described below.
 | If you update only one of multiple Gateway nodes to this release, set the environment variable USE_SMTP_OPTIONS to a non-empty value using $environment in FAXFACTS.CFG, to continue using the SMTP_OPTIONS syntax until you are ready to upgrade all nodes. For example: $environment GW2 USE_SMTP_OPTIONS yes |
Variable SMTP_BODY_OPTIONS can contain one of the following keywords. See also the notes below.
| NoFaxBody | The body text in e-mails from this sender will not be sent as a fax page and will not be added to memo variables. When this option is set, then the plain text of the email body is saved to a file in the CALLBACK\TEMP folder if the plain text is available. Otherwise the rich content is saved. |
| FaxPlain | Body text of content-type text/plain from this sender will be converted to fax format and included in the fax. If the e-mail contains only a body of this type this option will always be used and the SMTP_BODY_OPTIONS variable will be ignored. |
| FaxHTML | Body text of a supporter content-type other than text/html will be converted to fax format and included in the fax. If the e-mail contains only a body of this type (e.g. HTML, Word, RTF) this option will always be used and the SMTP_BODY_OPTIONS variable will be ignored. |
| MemoPlain | Body text of content-type text/plain from this sender will be copied to MEMOnn variables for use on a cover sheet in the fax transmission. |
Variable SMTP_SENDER_OPTIONS can contain one or more of the following keywords:
| SaveHeaders | All the SMTP headers in the e-mail message will be written as SMTP_HEADERnn variables in an FS file generated from the Gateway. |
| NoFax | This sender is restricted to sending to 'special recipient' e-mail addresses. |
| NoCvrAttach | If a fax cover sheet format (GCT, GTT, CVR) is included in the e-mail attachments from the sender, it will be ignored. |
| NoCover | The default Gateway cover sheet, if specified, will not be used for fax transmissions from this sender. |
| AllowScripts | Scripts included in HTML bodies from this sender will not be stripped from the text. |
| SaveKeyAttach | For e-mails containing a public key as a normal attachment, not as part of an S/MIME signature, the file will be saved as the sender's public key. Note that such an e-mail has not been treated as signed and the signature will not have been verified. See also the notes below. |
| MatchEnvRecip, NoMatchEnv | Control whether the Recipient(s) named on To: headers in the incoming e-mail will be ignored unless they also appear on the RCPT TO command in the SMTP session. The default is now MatchEnvRecip but was formerly NoMatchEnv. This is an important option which should normally be enabled. Unchecking this option (to select NoMatchEnv) can result in multiple copies of the document being faxed to each recipient when multiple fax-number addresses are present on the To: header. However unchecking to select NoMatchEnv is usually the correct decision when the fax number is on the subject line. |
| OverrideTo | The Recipient(s) named on To: headers in the incoming e-mail will be overridden by that on the RCPT TO command in the SMTP session. See Using BCC addresses for more information. |
Variable SMTP_ERROR_OPTIONS can cause specified conditions to be treated as an error, and can contain one or more of the following keywords:
| NoSign | An e-mail will be rejected if it contains no S/MIME signature. |
| BadSign | An e-mail will be rejected if it contains an invalid S/MIME signature or if the signature verification fails. |
| NoEncrypt | An e-mail to a 'special recipient' for which the template contains an $email_decrypt_keyword command will be rejected if it was not encrypted. Of course if the decryption fails it is always an error. |
| NoTLS | An e-mail received by a Gateway configured for optional TLS and without the client sending STARTTLS, or resulting in a TLS failure, will be rejected. Note that if the Gateway is configured as 'TLS required', such an e-mail will already have been 'bounced' by the server with a 530 response. |
| NoDKIM | On a 'default' sender template (normally used for senders not known in advance), the absence of DomainKeys support in the sender domain will cause the e-mail to be rejected. |
| BadDKIM | On a 'default' sender template (normally used for senders not known in advance), the failure of DomainKeys verification for the sender domain will cause the e-mail to be rejected. |
Variable SMTP_NOTIFY_OPTIONS can contain one or both of the following keywords. When the variable is present in the template, both of the global notifications are overridden:
| Success | The sender will be notified on a successful fax transmission. |
| Failure | The sender will be notified on a failed fax transmission. |
| None | When present alone in the variable, no fax notification will be sent. This keyword is ignored if either of the other keywords is also used. |
In earlier releases, the success and failure notification overrides were indicated by a 1 in the first or position of the value; this syntax is still accepted, but is not written by GWMANAGER unless USE_SMTP_OPTIONS is used as described above.
Variable SMTP_PASSWORD can contain a password or passphrase which must appear within the text of the Subject header of the incoming e-mail from this sender. If not, the e-mail will be rejected.
Index:
|
Value 1 indicates:
|
Value 0 indicates:
|
1
|
drop email body from fax
|
use global option
|
2
|
disable attached cover sheet
|
allow attached cover sheet
|
3
|
save message headers to variables
|
do not save message headers
|
4
|
disable fax from this sender
|
allow fax from this sender
|
5
|
(used in recipient template only)
|
|
6
|
allow scripts in email message body
|
remove scripts from email message body
|
7
|
fax rich content of email body
|
use global option
|
8
|
fax plain text of email body
|
use global option
|
9
|
use plain text of email body in memo
|
use global option
|
10
|
no cover sheet
|
use cover sheet
|
11
|
(no longer used)
|
(required)
|
12
|
(no longer used)
|
(required)
|
13
|
(no longer used)
|
(required)
|
14
|
(no longer used)
|
(required)
|
15
|
(no longer used)
|
(required)
|
16
|
(no longer used)
|
(required)
|
17
|
only accept TLS e-mail
|
allow unsecured e-mail
|
18
|
treat DKIM verification failure as an error
|
allow mail with invalid DKIM
|
19
|
treat missing DKIM signature as an error
|
allow mail without DKIM
|
20
|
treat S/MIME signature verification failure as an error
|
accept mail with invalid S/MIME signatures
|
21
|
treat missing S/MIME signature as an error
|
allow mail if not S/MIME signed
|
22
|
treat unencrypted S/MIME messages as an error
|
allow unencrypted messages
|
Notes on Body Options
You may wish to specify that the email body be dropped if you wish to only fax the attachments of an email message. Dropping the email body only removes it from the list of faxed documents. The email body is still saved as a plain text file so that you can reference it in custom processing if desired. If the rich content of the email message is going to be faxed, it is first processed to remove scripts and to process embedded or inline attachments. Embedded attachments are never faxed separately, but are processed along with the HTML message body by the document converter to create a single document that includes the embedded attachments. The converted document gets faxed. If the plain text of the message body is faxed instead of the rich content the email body will not be processed then it is possible that some inline attachments may be faxed as attachments. The option to disable attached cover sheets prevents the sender from sending an attached cover sheet to override the cover sheet options for the message. If the sender does send an attached cover sheet when this option is set, it is dropped from the attachment list and ignored. If you do not want to have a cover sheet for a particular sender and you have specified a default cover sheet then you must set the no cover sheet option.
Unverified S/MIME signatures
Option SaveKeyAttach was added to enable public key certificates to be saved from a malformed incoming 'signed' e-mail where the signature is in a normal attachment and with an incorrect content type for the message. Note that CopiaFacts cannot verify such a signature, which does not conform with RFC3851. Use this feature only to accept trusted mail from a known problem sender, and test the .CER file after it has been saved.
