Format Settings

Delivery Format and Filename Templates

In this area, you can specify whether a copy of the fax or audio message should be attached to the e-mail message, select the file format for the attached faxes and specify filename templates for attached faxes and audio messages to be used with the current rule.

On the Fax tab page, you can specify whether a copy of the fax should be attached to the e-mail message. You can select the file format (TIFF, PDF or SFF) and specify filename template for attached faxes.

Attach a copy of the sent fax in the following format

Check this box to attach a copy of the fax to the e-mail message. Select the file format in which you want to receive a copy of the fax. Can be TIFF, PDF or SFF.

The options below are responsible for how file names are generated for the attached faxes.

Use Default Filename Template (FAX...)

Select this option to use default filename template. When specifying the default filename template, the fax attachment name is FAX.tif, FAX.pdf or FAX.sff (depending on the selected format).

Use Custom Filename Template:

Select this option to specify custom filename template in the text box below. Filename template may contain arbitrary text, as well as so-called %variables% that are replaced by actual data (e.g. %RecipientFaxNumber%, %StartTime%, %PagesTransferred% etc.). Filename template can not contain any of the following characters: \ / : * ? " < > | ; An example of file name for the current filename template (taking into account the selected date and time formats) is shown below under Example.

Insert a variable

Use this button to insert a variable in the text box on the left, where the custom filename template is specified. To insert a variable into the text, place the cursor in the desired location (or select text segment that you want to replace), press the button and then select a variable from the drop-down menu.

The following variables can be used with custom fax filename template (replaced by actual data):

• %RecipientFaxNumber%. The fax number of the recipient.
• %DocumentName%. If the fax is generated by the Mail to Fax function, this is the original name of sender document including file extension. When sending multiple documents, they are comma separated. When sending a fax consisting only of a cover page, replaced with an empty string. Otherwise replaced with an empty string.
• %PagesTotal%. The total number of pages in the outgoing fax.
• %RemoteFaxID%. The Called Subscriber ID (CSID) received from the fax recipient.
• %LocalFaxID%. The transmitting station identifier (TSID) that identifies you as a fax sender, sent to the fax recipient.
• %SubmissionTime%. The time the outgoing fax was originally added for sending.
• %OriginalScheduledTime%. The time the outgoing fax was originally scheduled for sending.
• %StartTime%. The time when the outgoing fax call or fax transmission started.
• %EndTime%. The time when the outgoing fax call or fax transmission ended.
• %Duration%. The duration of the outgoing fax call or fax transmission.
• %Retries%. The number of times the system has tried to send the fax. The total number of possible retries depends on the limit set.
• %PagesTransferred%. The number of successfully sent fax pages.
• %BitRateEcm%. Transmission rate. The 'e' attribute is used to indicate Error Correction Mode (ECM).
• %FaxProtocol%. Fax protocol information. Can be one of the following values: T.38, G711-FAX - audio fax over G.711 codec via VOIP, ISDN - audio fax via ISDN CAPI 2.0 line, ISDN-FAX B3-4-SFF - fax via ISDN CAPI 2.0 line using B3 Protocol 4: T.30 for Group 3 fax, ISDN-FAX B3-5-SFF - fax via ISDN CAPI 2.0 line using B3 Protocol 5: T.30 for Group 3 fax extended.
• %Resolution%. Fax resolution. Can be one of the following values: 204x196 dpi (Fine), 204x98 dpi (Normal).
• %Status%. Operation completion code. OK in the case of a successful fax sending. In the case of a failed fax sending contains the error description (in English).

Format

Select the locale (region and language) to specify how to display date and time values for the current filename template. This selection affects the display of date and time values defined by the following variables: %SubmissionTime%, %OriginalScheduledTime%, %StartTime%, %EndTime%. By default, the date and time is formatted in accordance with operating system settings.

Use default date and time formats that match Windows display language

Click this button to select date and time formats that match Windows display language (for the current user).

Date

Check this box to use the date part of DateTime value. Select date format from the drop-down list. Available date formats depend on the selected locale (region and language). Slashes ' / ' that cannot be used in file names are replaced with dashes ' - '. An example of the formatting for the current selection is shown on the right under Example.

Time

Check this box to use the time part of DateTime value. Select time format from the drop-down list. Available time formats depend on the selected locale (region and language). Colon characters ' : ' that cannot be used in file names are replaced with dashes ' - '. An example of the formatting for the current selection is shown on the right under Example.

Example

An example of file name for the current filename template (taking into account the selected date and time formats, as well as the selected fax format).

On the Audio tab page, you can specify whether a copy of the audio message should be attached to the e-mail message. You can specify filename template for attached audio files.

Attach a copy of the sent audio message

Check this box to attach a copy of the audio message (WAV file) to the e-mail message.

The options below are responsible for how file names are generated for the attached audio messages.

Use Default Filename Template (MESSAGE.wav)

Select this option to use default filename template. When specifying the default filename template, the audio attachment name is MESSAGE.wav.

Use Custom Filename Template:

Select this option to specify custom filename template in the text box below. Filename template may contain arbitrary text, as well as so-called %variables% that are replaced by actual data (e.g. %RecipientPhoneNumber%, %StartTime% etc.). Filename template can not contain any of the following characters: \ / : * ? " < > | ; An example of file name for the current filename template (taking into account the selected date and time formats) is shown below under Example.

Insert a variable

Use this button to insert a variable in the text box on the left, where the custom filename template is specified. To insert a variable into the text, place the cursor in the desired location (or select text segment that you want to replace), press the button and then select a variable from the drop-down menu.

The following variables can be used with custom audio message filename template (replaced by actual data):

• %RecipientPhoneNumber%. The phone number of the recipient.
• %DocumentName%. If the audio message is generated by the Mail to Audio function, this is the name of the original audio file including file extension. Otherwise replaced with an empty string.
• %WavLength%. The length of the audio message in seconds.
• %SubmissionTime%. The time the outgoing audio message was originally added for sending.
• %OriginalScheduledTime%. The time the outgoing audio message was originally scheduled for sending.
• %StartTime%. The time when the outgoing call or audio message transmission started.
• %EndTime%. The time when the outgoing call or audio message transmission ended.
• %Duration%. The duration of the outgoing call or audio message transmission.
• %Retries%. The number of times the system has tried to send the audio message. The total number of possible retries depends on the limit set.
• %Status%. Operation completion code. OK in the case of a successful sending of audio message. In the case of a failed sending of audio message contains the error description (in English).

The following variable is deprecated and supported only for compatibility with previous versions, do not use it in your new templates:

• %WavLenth%. (typo in versions prior to Fax Voip 8.3.1) The length of the audio message in seconds. Instead, use %WavLength%.

Format

Select the locale (region and language) to specify how to display date and time values for the current filename template. This selection affects the display of date and time values defined by the following variables: %SubmissionTime%, %OriginalScheduledTime%, %StartTime%, %EndTime%. By default, the date and time is formatted in accordance with operating system settings.

Use default date and time formats that match Windows display language

Click this button to select date and time formats that match Windows display language (for the current user).

Date

Check this box to use the date part of DateTime value. Select date format from the drop-down list. Available date formats depend on the selected locale (region and language). Slashes ' / ' that cannot be used in file names are replaced with dashes ' - '. An example of the formatting for the current selection is shown on the right under Example.

Time

Check this box to use the time part of DateTime value. Select time format from the drop-down list. Available time formats depend on the selected locale (region and language). Colon characters ' : ' that cannot be used in file names are replaced with dashes ' - '. An example of the formatting for the current selection is shown on the right under Example.

Example

An example of file name for the current filename template (taking into account the selected date and time formats).

Notes

• When using CDO.Message method for sending e-mail messages (see more details in the SMTP Settings chapter) and the presence of unicode characters in the name of the attached file (usually when using a non-standard locale to format date and time), these characters can be replaced by underlining ' _ '. To fix the problem, use SecureSmtpClient or System.Net.Mail method for sending e-mail messages.