| quote | getCommID() | enquote
| quote | ri.reason | enquote
| quote | cid.number | enquote
+ | quote | cid.name | enquote
);
traceServer("RECV FAX: %s", (const char*) cmd);
setProcessPriority(BASE); // lower priority
.ds Fx \fIHyla\s-1FAX\s+1\fP
.TH CID ${MANNUM4_5} "May 28, 2001"
.SH NAME
-cid \- Caller-ID access control list
+cid \- Caller-ID and DNIS access control list
.SH DESCRIPTION
The \*(Fx configuration parameter
.B QualifyCID
-specifies whether or not the identity of an inbound call
+specifies whether or not the identity or identifier of an inbound call
should be checked against an access
control list before the telephone is answered.
-If a modem is attached to a phone line that has Caller-ID service, and
+This both enables call screening against those values and fax routing
+(in faxrcvd's FaxDispatch) based on those values.
+If a modem is attached to a phone line that has
+Caller-ID or DNIS service, and
.B QualifyCID
-is non-null, then only the callers identified
-in the file specified by the string (typically \fBetc/cid\fP)
-will be answered.
+is non-null, then only the calls identified by
+strings matching
+.B CIDNumber
+in the file
+(typically \fBetc/cid\fP) will be answered.
.PP
Patterns are specified one per line and must conform to the
regular expressions syntax specified by
Finally, note that regular expressions can be used to specify
many numbers with one pattern.
.SH NOTES
-The caller's telephone number is recognized by using the
+In the case of Caller-ID, the caller's identity, and in the case
+of DNIS, the called number,
+is recognized by using the
.B CIDNumber
configuration parameter described in
.IR hylafax-config (${MANNUM4_5}).
This parameter must be present in the per-modem configuration
-file for Caller-ID screening to function properly.
+file for Caller-ID or DNIS screening or routing to function properly.
If
.B QualifyCID
is defined, but no
.B CIDNumber
-is specified, then no phone numbers will be recognized and all
+is specified, then no match will occur and all
incoming calls will be ignored.
.PP
Caller-ID data is only sent once by the telco, and the timing of
.I commid
.I error-msg
.I cidnumber
+.I cidname
.SH DESCRIPTION
.B bin/faxrcvd
is the command script invoked by the facsimile server whenever
.B CIDNumber
when using
.B QualifyCID
+.TP
+.B cidname
+the value of
+.B CIDName
+when using
+.B QualifyCID
.SH NOTES
This script can route facsimile directly to the intended receipient.
To do this create a shell script
.sp
Note that you must match any embedded white space.
The facsimile will be sent as a MIME-encoded PostScript document
-as default. The attachment filetype is controlled by the
+as default.
+.TP
+.I CIDNAME
+is equivalent to
+.B CIDName
+above.
+.TP
+.I CIDNUMBER
+is equivalent to
+.B CIDNumber
+above.
+.TP
+.I DEVICE
+is equivalent to
+.B device
+above.
+.TP
.I FILETYPE
-shell variable, and can be controlled as shown above. Current
+controls the filetype of the image attachment. Current
filetype options are ``ps'', ``tif'', and ``pdf''.
-Consult the shell script for details.
+.TP
+.I MSG
+is equivalent to
+.B error-msg
+above.
+.TP
+.I SENDER
+is the received TSI of the fax sender.
+.TP
+.I SENDTO
+controls the recipient of the received fax notification. It is
+given as an e-mail address.
+.TP
+Other shell variables are available. Consult the faxrcvd script directly.
.SH FILES
.nf
.ta \w'${SBIN}/faxinfo 'u
AnswerRotary string \s-1Any\s+1 alternatives for answering calls
AnswerBias integer \- bias to apply to successful rotary answer
AreaCode\(S2 string \- local area code
-CIDName string \- Caller \s-1ID\s+1 name pattern string
-CIDNumber string \- Caller \s-1ID\s+1 number pattern string
+CIDName string \- Caller \s-1ID\s+1 or DNIS name pattern string
+CIDNumber string \- Caller \s-1ID\s+1 or DNIS number pattern string
ClocalAsRoot boolean \s-1No\s+1 set \s-1CLOCAL\s+1 using root \s-1UID\s+1
ContCoverCmd\(S1 string \s-1bin/mkcover\s+1 continuation cover page generation script
ContCoverPage\(S1 string \- continuation cover page template filename
PostScriptTimeout\(S1 integer \s-1300\s+1 timeout on \*(Ps interpreter runs (secs)
PriorityScheduling boolean \s-1\fIsee below\fP\s+1 use available priority job scheduling mechanism
PS2FaxCmd\(S1 string \s-1bin/ps2fax\s+1 \*(Ps \s-1RIP\s+1 command script
-QualifyCID string \- file of Caller-ID patterns for checking inbound calls
+QualifyCID string \- file of Caller-ID or DNIS patterns for checking inbound calls
QualifyTSI string \- file of \s-1TSI\s+1 patterns for qualifying senders
RecvDataFormat string \s-1adaptive\s+1 format for received facsimile data
RecvFileMode octal \s-10600\s+1 protection mode to use for received facsimile files
.TP
.B CIDName
A string that identifies the caller's identity in any Caller-ID
-status messages.
+status messages or the called identity in any DNIS messages.
The specified string is compared against any
unrecognized status messages received from the modem before the
phone is placed off-hook.
.TP
.B CIDNumber
A string that identifies the caller's phone number in any Caller-ID
-status messages.
+status messages or the called number in any DNIS messages.
The specified string is compared against any
unrecognized status messages received from the modem before the
phone is placed off-hook.
.TP
.B QualifyCID
A string that specifies whether or not \fICaller-ID information\fP
+and/or \fIDNIS information\fP
should be checked against an access control list before accepting
an inbound call.
If
.B QualifyCID
-is non-null and there is Caller-ID service,
-then only calls from phone numbers identified
+is non-null and there is Caller-ID or DNIS service,
+then only calls with data matching numbers identified
in the file specified by this string (typically \fBetc/cid\fP)
will be accepted; see
.IR cid (${MANNUM4_5}).
.B QualifyCID
is not specified in the configuration file, or the value is
null, then all incoming calls will be answered.
-Note that Caller-ID screening is only available when this
+Note that Caller-ID screening and DNIS routing are only available when this
service is enabled on the phone line and the modem is capable of
-presenting Caller-ID status information to the host.
+presenting Caller-ID status or DNIS data information to the host.
The
.B CIDNumber
and
.B CIDName
parameters must also be setup to reflect the manner in which
-the modem returns Caller-ID status information to the host.
+the modem returns Caller-ID status or DNIS data information to the host.
.TP
.B QualifyTSI
A string that specifies whether or not the identity of
#
# faxrcvd file devID commID error-msg
#
-if [ $# != 5 ]; then
- echo "Usage: $0 file devID commID error-msg CIDNumber "
+if [ $# != 6 ]; then
+ echo "Usage: $0 file devID commID error-msg CIDNumber CIDName "
exit 1
fi
COMMID="$3"
MSG="$4"
CIDNUMBER="$5"
+CIDNAME="$6"
FILENAME=`echo $FILE | $SED -e 's/\.tif//' -e 's/recvq\///'`
echo " CIDNumber: $CIDNUMBER"
echo ""
fi
+ if [ "$CIDNAME" ]; then
+ echo " CIDName: $CIDNAME"
+ echo ""
+ fi
if [ -n "$SENDTO" ]; then
echo ""
echo "The facsimile was automatically dispatched to: $SENDTO."
echo " CIDNumber: $CIDNUMBER"
echo ""
fi
+ if [ "$CIDNAME" ]; then
+ echo " CIDName: $CIDNAME"
+ echo ""
+ fi
echo ""
echo "--$MIMEBOUNDARY"
if [ "$FILETYPE" = "tif" ]; then
projects / thirdparty / HylaFAX.git / commitdiff
