submitfax - High-Level Fax Applications Interface
SYNOPSIS
submitfax [-d] [-k] [-m] [-v] commandfile
DESCRIPTION
Submitfax accepts a high-level request for a fax transmission and
converts it (by reference to the configuration and database files)
into a low-level request that is handed off to sendfax.
OPTIONS
- -d
- Enables debug mode which will generate additional output describing
the internal operation of the program.
- -k
- Deletes the commandfile after processing is complete.
- -m
- Mails errors to the current user instead of sending them to standard error.
- -v
- Enables verbose mode which will generate additional output describing the operation of the program.
PARAMETERS
The commandfile contains a list of parameter definitions of the form
parameter = value, one per line. The value may optionally be enclosed in
double quotation marks, which are required only if the value starts with
a blank or contains a double quotation mark.
The following parameters are currently supported (they may appear in any
order in the commandfile):
- account
- The name of the account (from the account database) to use for
any destination that has no destination-specific account (the account
database provides information used for the accounting of fax calls).
If this parameter is not specified, the value in the environment
variable FAXACCOUNT (if any) will be used. Optional (but one of account,
dest_accountn, or FAXACCOUNT must be specified if accounting is required
by your system).
- class
- The name of the class (from the class database) to use for any
destination that has no destination-specific class (the class database
controls the scheduling of the fax transmission).
If this parameter is not specified, the value in the environment
variable FAXCLASS (if any) will be used. Optional (but one of dest_classn,
class, or FAXCLASS must be set).
- dest_account1
-
The name of the account (from the account database) to use for this
destination (the account database provides information used for the
accounting of fax calls). If this parameter is not specified, the value
for the parameter account or in the environment variable FAXACCOUNT
(if any) will be used. See the account parameter above for more information.
The same parameter for subsequent destinations is named dest_account2,
dest_account3, etc. Optional (but one of account, dest_account1, or
FAXACCOUNT must be specified if accounting is required by your system).
- dest_altfax1
- The alternate telephone number of the destination fax,
used if the primary
number (dest_faxn) is not successful within the number of attempts specified
in the class database. See dest_fax1 (below) for information on the required
format. The same parameter for subsequent destinations is named dest_altfax2,
dest_altfax3, etc. Optional.
- dest_class1
- The name of the class (from the class database) to use for
this destination (the class database controls the scheduling of the fax
transmission). If this parameter is not specified, the value for the
parameter class or in the environment variable FAXCLASS (if any) will
be used. See the class parameter above for more information.
The same parameter for subsequent destinations is named dest_class2,
dest_class3, etc. Optional (but one of dest_class1, class, or FAXCLASS
must be set).
- dest_cc1
- The list of people who have also received this fax (note,
this is an information field only and does not cause the fax to be sent
to other destinations).
This information is only for the cover sheet, if present.
The same parameter for subsequent destinations is named dest_cc2,
dest_cc3, etc. Optional.
- dest_company1
- The name of the company to which this fax is addressed
(to be placed on the cover sheet, if present).
The same parameter for subsequent destinations is named dest_company2,
dest_company3, etc. Optional.
- dest_dept1
- The department of (or other identifying information about)
the person to whom this fax is addressed (to be placed on the cover sheet,
if present). The same parameter for subsequent destinations is named
dest_dept2, dest_dept3, etc. Optional.
- dest_fax1
- The telephone number of the destination fax.
The same parameter for subsequent destinations is named dest_fax2,
dest_fax3, etc. At least dest_fax1 is required. If any other dest_
parameters are specified for the second (or subsequent) destinations,
then a dest_faxn must also be specified. (In other words, one may not
specify dest_company2 unless dest_fax2 is also specified.)
- dest_name1
- The name of the person to whom this fax is addressed
(to be placed on the cover sheet, if present). The same parameter
for subsequent destinations is named dest_name2, dest_name3, etc. Optional.
- dest_time1
- The time to delay the fax until. See the time parameter
for more information. The same parameter for subsequent destinations
is named dest_time2, dest_time3, etc. Optional.
- dest_title1
- The title of (or other identifying information about)
the person to whom this fax is addressed (to be placed on the cover sheet,
if present). The same parameter for subsequent destinations is named
dest_title2, dest_title3, etc. Optional.
- file_delete1
- Indicates whether the file that contains the first attachment to this
fax is to be deleted once it has been converted to fax format.
Subsequent deletion parameters are named file_delete2, file_delete3,
etc. Permitted values are yes or no. Optional. Default value is no.
If specified, then the corresponding file_namen parameter must be specified.
- file_name1
- The pathname of the file that contains the first attachment
to this fax. Subsequent attachments are named file_name2, file_name3, etc.
Optional.
- file_style1
- The style to use for the first attachment to this fax
(see also the style parameter below). The style for subsequent
attachments are named file_style2, file_style3, etc. Optional.
If specified, then the corresponding file_namen parameter must
be specified. If not specified, then the value from the style
parameter or the FAXSTYLE environment variable will be used.
- file_type1
- The file type of the first attachment to this fax (this
controls the conversion program used to convert this file into fax format).
Supported values include ASCII,
PCL,
POSTSCRIPT,
and
TIFF
(case is not significant).
The type for subsequent attachments are named file_type2, file_type3, etc.
Optional. If specified, then the corresponding file_name
n parameter
must be specified. If not specified, then the file itself will be
examined and the file type determined by an examination of the first few
bytes of the file
(TIFF
files start with the distinctive TIFF header tag;
PCL files must start with an ESC escape sequence;
PostScript files must start with the two-character sequence `%!',
preceded optionally by white space;
everything else is considered to be ASCII).
- from_dept
- The department of (or other identifying information about)
the person sending this fax (to be placed on the cover sheet). Optional.
- from_name
- The name of the person sending this fax (to be placed on the
cover sheet). If this parameter is not specified, the value in the
environment variable FAXFROM (if any) will be used. Optional.
- from_title
- The title of (or other identifying information about) the
person sending this fax (to be placed on the cover sheet). Optional.
- mailaddr
- The e-mail address to use for notification (see the notify
parameter below). Optional. If not specified e-mail will be sent to the
name in the environment variable FAXMAILADDR. If this variable is not set,
then e-mail will be sent to the login name (as returned by the getlogin
library call) associated with the user who ran submitfax.
- message
- The actual text of the coversheet message (to be placed on the
cover sheet). See also messagefile below. Optional.
- messagefile
- The path name of the file that contains the text of the
coversheet message (to be placed on the cover sheet). See also message
above. Both message and messagefile may be specified, in which case the
message precedes the text in the messagefile on the cover sheet. Optional.
- notify
- Enables e-mail notification of successful transmissions
(unsuccessful transmissions always cause e-mail notification.
See mailaddr parameter above for information on e-mail addressee.
Permitted values are yes or no. Optional. Default value is no.
- preview
- Specifies that the fax ought to be previewed on the display
before being transmitted. Only supported when the standard-output is
connected to a console display adapter or the TERM environment variable
starts with wy160 or wyse160. If the user cancels the fax during the
preview operation (by pressing CTRL-C) then the fax will not be sent.
If more than one destination has been specified, only the cover sheet
and attachments for the first destination will be previewed.
Permitted values are yes or no. Optional (default is no).
- print
- Specifies that the fax ought to be sent to the printer before
being transmitted. It is possible to specify any or all of the cover
sheet (COVER), attachments (FILES
or ATTACHMENTS), or confirmation
(CONFIRM). The case of the keywords is not important.
For example, print = Cover + Confirm.
The confirmation print-out consists of a reduced-size image of the
first page of the fax along with information confirming the successful
transmission of the fax.
If more than one destination has been specified, only the cover sheet
and attachments for the first destination will be printed (confirmations,
if requested, will be printed for each destination).
If set, then the printer parameter (below) must be specified.
Optional (default is no).
- printer
- The name of the printer (from the printer database) to use to
print the fax (the printer database specifies the command to use to
access a printer on your UNIX system). Required if the print parameter
(above) is set.
- signature
- The path name of the file that contains the TIFF image of
the sender's signature (to be placed on the cover sheet, if present). Optional.
- subject
- The subject of (or other identifying information about) the fax
(to be placed on the cover sheet).
If not specified the value of the environment variable FAXSUBJECT will be
used (if any). Optional.
- style
- The name of the style (from the style database) to use for the cover
sheet and the fax as a whole (the style database controls things like the
page length, resolution, letterhead overlay, etc.). If this parameter is
not specified, the value in the environment variable FAXSTYLE (if any)
will be used. Required.
xxyyzz time needs to be changed
- time
- The earliest time to send a fax for any destination that has no
destination-specific time. Permitted values include any string that
specifies a time and/or date. Time may be specified in 24-hour notation,
either with an h suffix or a colon as punctuation (e.g. 2300h or 23:00);
or using a.m./p.m. notation (e.g. 4:30pm). Date may be specified using
month names or numbers. In the case of ambiguous specifications (e.g.
is 5/7 May 7th or July 5th?) the order of the day and month number will be
taken from the Date Input Format specified in the system configuration
settings. Special English words are also recognised (e.g. midnight, noon,
etc.). Optional.
EXAMPLE
This is an example of the minimal submitfax commandfile that faxes a single
ASCII file (the account parameter need not be specified if accounting is not
required).
file_name1 = /tmp/document
style = No Coversheet (Fine)
account = overhead
class = Rush (Highest Cost)
dest_fax1 = 1 (604) 926-8182
The following example shows the use of several submitfax parameters.
from_name = Jane Doe
from_title = President
from_dept = ACME Cement
notify = yes
mailaddr = jane@acme.com
subject = New Price List
messagefile = /docs/cover.letter
signature = /usr/jane/fax/signature
style = No Coversheet (Fine)
account = overhead
class = Rush (Highest Cost)
dest_fax1 = 1 (604) 926-8182
dest_name1 = Bert Smith
dest_title1 = Senior Buyer
dest_dept1 = Purchasing
dest_company1 = AJAX Construction
dest_time1 = midnight
file_name1 = /docs/pricelist
file_type1 = PostScript
file_style1 = Company Letterhead
SEE ALSO
asciitiff, convert,
fxm