xref: /netbsd-src/external/ibm-public/postfix/dist/proto/socketmap_table (revision f89f6560d453f5e37386cc7938c072d2f528b9fa)
1#++
2# NAME
3#	socketmap_table 5
4# SUMMARY
5#	Postfix socketmap table lookup client
6# SYNOPSIS
7#	\fBpostmap -q "\fIstring\fB" socketmap:inet:\fIhost\fB:\fIport\fB:\fIname\fR
8# .br
9#	\fBpostmap -q "\fIstring\fB" socketmap:unix:\fIpathname\fB:\fIname\fR
10#
11#	\fBpostmap -q - socketmap:inet:\fIhost\fB:\fIport\fB:\fIname\fB <\fIinputfile\fR
12# .br
13#	\fBpostmap -q - socketmap:unix:\fIpathname\fB:\fIname\fB <\fIinputfile\fR
14# DESCRIPTION
15#	The Postfix mail system uses optional tables for address
16#	rewriting. mail routing or policy lookup.
17#
18#	The Postfix socketmap client expects TCP endpoint names of
19#	the form \fBinet:\fIhost\fB:\fIport\fB:\fIname\fR, or
20#	UNIX-domain endponts of the form \fBunix:\fIpathname\fB:\fIname\fR.
21#	In both cases, \fIname\fR specifies the name field in a
22#	socketmap client request (see "REQUEST FORMAT" below).
23# PROTOCOL
24# .ad
25# .fi
26#	Socketmaps use a simple protocol: the client sends one
27#	request, and the server sends one reply.  Each request and
28#	reply are sent as one netstring object.
29# REQUEST FORMAT
30# .ad
31# .fi
32#	The socketmap protocol supports only the lookup request.
33#
34#	Postfix will not generate partial search keys such as domain
35#	names without one or more subdomains, network addresses
36#	without one or more least-significant octets, or email
37#	addresses without the localpart, address extension or domain
38#	portion. This behavior is also found with cidr:, pcre:, and
39#	regexp: tables.
40# .IP "\fB\fIname\fB <space> \fIkey\fR"
41#	Search the named socketmap for the specified key.
42# REPLY FORMAT
43# .ad
44# .fi
45#	The Postfix socketmap client requires that replies are not
46#	longer than 100000 characters (not including the netstring
47#	encapsulation). Replies must have the following form:
48# .IP "\fBOK <space> \fIdata\fR"
49#	The requested data was found.
50# .IP "\fBNOTFOUND <space>"
51#	The requested data was not found.
52# .IP "\fBTEMP <space> \fIreason\fR"
53# .IP "\fBTIMEOUT <space> \fIreason\fR"
54# .IP "\fBPERM <space> \fIreason\fR"
55#	The request failed. The reason, if non-empty, is descriptive
56#	text.
57# SECURITY
58#	This map cannot be used for security-sensitive information,
59#	because neither the connection nor the server are authenticated.
60# SEE ALSO
61#	http://cr.yp.to/proto/netstrings.txt, netstring definition
62#	postconf(1), Postfix supported lookup tables
63#	postmap(1), Postfix lookup table manager
64#	regexp_table(5), format of regular expression tables
65#	pcre_table(5), format of PCRE tables
66#	cidr_table(5), format of CIDR tables
67# README FILES
68# .ad
69# .fi
70#	Use "\fBpostconf readme_directory\fR" or
71#	"\fBpostconf html_directory\fR" to locate this information.
72# .na
73# .nf
74#	DATABASE_README, Postfix lookup table overview
75# BUGS
76#	The protocol limits are not yet configurable.
77# LICENSE
78# .ad
79# .fi
80#	The Secure Mailer license must be distributed with this software.
81# HISTORY
82#	Socketmap support was introduced with Postfix version 2.10.
83# AUTHOR(S)
84#	Wietse Venema
85#	IBM T.J. Watson Research
86#	P.O. Box 704
87#	Yorktown Heights, NY 10598, USA
88#--
89
90