SendFax.exe command line options
SendFax.exe is a command line utility that allows you to automatically create and track a fax job. Can be used in different scenarios, such as bat-files or in the custom applications. Helps to automate the process of fax sending.
SendFax.exe can be found in the Fax Voip FSP installation folder. This tool uses Fax Voip FSP libraries and should be placed in the Fax Voip FSP installation folder. You should not move SendFax.exe to other folder.
To generate a command line and test SendFax.exe, open Fax Voip FSP Control Panel, click Fax in the tree, and then click SendFax.exe, see in the To Configure and Run SendFax.exe using Fax Voip FSP Control Panel chapter of this user manual.
The example of usage with bat-file can be found in the following file: *{CommonAppDataFolder}\FaxVoip FSP\SendFax\Sample\SendFax_test.bat.
usage (GUI mode): SendFax.exe [options]
usage (console mode): SendFax_c.exe [options]
Fax Recipient options:
To specify single recipient, use /FaxNumber and /RecipientName options. To specify multiple recipients, use /RecipientList option.
/FaxNumber=value
The fax number of the person you want to send the fax to.
/RecipientName=value
The name of the person you want to send the fax to. Can be displayed on the cover page.
/RecipientList=value
The full path to the text file in which the list of fax recipients is stored. Each line corresponds to a single recipient. You can specify not only the fax number, but also the name of the recipient e.g. 3068811245<Robert>.
Fax Document options:
To send a single document, use /FileName option. To send multiple documents, use /FileList option. To send a fax consisting only of a cover page, skip these options and specify '/CoverPage=true'.
/FileName=value
The full path to the document to be sent as a fax.
/FileList=value
The full path to the text file in which the list of documents is stored. Each line corresponds to a single document. Full paths to the files should be specified.
/DocumentName=value
The user-friendly name to display for the fax document. Overrides the default value, which lists the original names of documents to be sent.
Cover Page options:
/CoverPage=value
Overrides the 'Include cover pages with faxes' option specified in the Cover Pages Settings (SendFax.exe).
/CoverPage=true
Include cover page with fax. Required option when sending a fax consisting only of the cover page.
/CoverPage=false
Don't Include cover page with fax.
/CoverInfo=value
The full path to the custom ini-file that contains information for creating the cover page. Overrides the default Cover Pages Settings (SendFax.exe) and Sender Information Settings (SendFax.exe).
The ini-file structure is as follows:
[Template]
Overrides the default cover page template. If the section does not exist, default template is used.
UseServerCoverPage=
1 - use common template; 0 - use personal template
CoverPageName=
Cover page name (confident, fyi, generic, urgent) or full path to the template file.
[Sender]
Overrides the default sender information. If the section does not exist, default values are used.
SdrName=
The name of the sender.
SdrFaxNumber=
Fax number associated with the sender.
SdrEmail=
The e-mail address associated with the sender. Can be overridden by the /SdrEmail option. The e-mail address can be processed by Mail to Fax function (e-mail receipts to the specified address).
SdrCompany=
The company name associated with the sender. Displayed at the top of each faxed page. Can be overridden by the /FaxHeader option.
SdrDepartment=
The department name associated with the sender.
SdrTitle=
The title associated with the sender.
SdrOfficeLocation=
The office location of the sender.
SdrHomePhone=
The home telephone number associated with the sender.
SdrOfficePhone=
The office telephone number.
SdrAddress=
The street address associated with the sender. To wrap lines, use '\n' character.
SdrBillingCode=
The billing code associated with the sender.
SdrTsid=
The transmitting station identifier (TSID) for the sender's device. Displayed at the top of each faxed page. Can be overridden by the /FaxStationID option.
[Content]
Overrides default cover page subject and note. If the section does not exist, default values are used.
CoverPageSubject=
The cover page subject.
CoverPageNote=
The cover page note. To wrap lines, use '\n' character.
Fax options (overrides):
/FaxStationID=value
The transmitting station identifier (TSID) for the sender's device. Displayed at the top of each faxed page. Overrides the TSID specified in the 'Sender Information', including the default Windows Fax Service settings.
/FaxHeader=value
Fax HeadLine string. Displayed at the top of each faxed page. Overrides the 'Company name' value, specified in the 'Sender Information', including the default Windows Fax Service settings.
/SdrEmail=value
The e-mail address associated with the sender. Overrides the e-mail address specified in the 'Sender Information', including the default Windows Fax Service settings. The e-mail address can be processed by Mail to Fax function (e-mail receipts to the specified address).
Schedule and Priority options:
/Priority=value
Specifies the priority to use when sending the fax.
/Priority=Low
The fax will be sent with a low priority.
/Priority=Normal
The fax will be sent with a normal priority (default).
/Priority=High
The fax will be sent with a high priority.
/Discount
Send the fax during the discount rate period.
/Schedule=value
Send the fax no sooner than the specified date and time. The date and time format should match the settings of your computer, e.g. 10.07.2019 22:15:30 If this option is not used or the date and time can not be recognized, the current date and time are used.
TIFF options (applied if only Direct Converting is used):
/AutoRotate=value
Overrides the default value specified in the Fax Converter settings.
/AutoRotate=true
Apply automatic orientation selection algorithm.
/AutoRotate=false
Don't use automatic orientation selection algorithm.
/A4Page=value
Overrides the default value specified in the Fax Converter settings.
/A4Page=true
Set the page width and height to A4 page format.
/A4Page=false
Do not control the page height.
/HALFTONE=value
Overrides the default value specified in the Fax Converter settings.
/HALFTONE=true
Apply HALFTONE Effect to the fax.
/HALFTONE=false
Don't apply HALFTONE Effect to the fax.
Converting options (forced modes):
/ForceDirectConvert
Create the fax using Direct Converting function. Fax Converter settings are ignored. Can be applied only with the following file types: pdf, tif(tiff), sff, qfx, bmp, jpg(jpeg), gif, png, ico, wmf(emf).
/ForcePrint
Create the fax using fax printer. Fax Converter settings are ignored. If printing fails, the utility will attempt to create the fax using Direct Converting function.
E-mail Delivery Receipts options (native):
Native E-mail Delivery Receipts are part of Windows Fax Service software and only available in Windows Server OS. This functionality does not support SSL when sending e-mails.
/EmailReceiptMS=value
Overrides the default value specified in the E-mail Delivery Receipts (native) Settings (SendFax.exe).
/EmailReceiptMS=true
Send a delivery report through SMTP mail.
/EmailReceiptMS=false
Do not send a delivery report through SMTP mail.
/ReceiptAddressMS=value
The e-mail address to which the fax service should send a delivery receipt when the fax job reaches a final state. Overrides the default address specified in the E-mail Delivery Receipts (native) Settings (SendFax.exe).
/GroupReceiptMS=value
Overrides the default value specified in the E-mail Delivery Receipts (native) Settings (SendFax.exe).
/GroupReceiptMS=true
Send a summary receipt for all the recipients of the broadcast.
/GroupReceiptMS=false
Send an individual delivery receipt for each recipient of the broadcast.
/ReceiptAttachFaxMS=value
Overrides the default value specified in the E-mail Delivery Receipts (native) Settings (SendFax.exe).
/ReceiptAttachFaxMS=true
Attach a fax to the receipt.
/ReceiptAttachFaxMS=false
Do not attach a fax to the receipt.
Fax Track options:
/Track
Track fax activity after creating a job. This option is ignored when sending a fax to multiple recipients.
/JobID=value
Do not create new fax job. Only track previously created fax. Valid outbound fax job ID should be specified. When using this option, all the above options are ignored.
Console options:
To operate in console mode, run the SendFax_c.exe application.
/DoNotCloseConsole
Do not close console after execution. 'Press any key to continue . . .' message is displayed.
/Console
Using this option, you can run SendFax.exe application (GUI version) in console mode. Please note that the calling application does not wait for the console to terminate in this case. Instead, run SendFax_c.exe application.
Debug and log options:
/DebugLog
Enable debug log containing detailed information about SendFax.exe operations. Log file path: *{CommonAppDataFolder}\FaxVoip FSP\log\SendFax_Debug.txt
/Log
Enable simple log containing brief information about SendFax.exe operations. Log file path: *{CommonAppDataFolder}\FaxVoip FSP\log\SendFax_Log.txt
e.g.
SendFax.exe /FaxNumber=13607451257 /RecipientName=Andre Hedges /CoverPage=true /CoverInfo=C:\ProgramData\FaxVoip FSP\SendFax\Sample\coverpage_test.ini /Track /DebugLog /Log
SendFax_c.exe /FaxNumber=14251234567 /RecipientName=Bob Linkermann /CoverPage=true /FileName=C:\ProgramData\FaxVoip FSP\SendFax\Sample\testPDF.pdf /Priority=High /ForceDirectConvert /Track /DoNotCloseConsole /DebugLog /Log
SendFax_c.exe /RecipientList=C:\ProgramData\FaxVoip FSP\SendFax\Sample\Recipients_test.txt /FileList=C:\ProgramData\FaxVoip FSP\SendFax\Sample\FileList_test.txt /FaxStationID=1(425)987-6543 /FaxHeader=This is my company /DoNotCloseConsole /DebugLog /Log
Notes