xref: /netbsd-src/external/ibm-public/postfix/dist/proto/socketmap_table (revision f3bc92a4f25066883a5d85d66df30605583c883c)
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 endpoints 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#	each reply are sent as one netstring object.
29# REQUEST FORMAT
30# .ad
31# .fi
32#	The socketmap protocol supports only the lookup request.
33#	The request has the following form:
34#
35# .IP "\fB\fIname\fB <space> \fIkey\fR"
36#	Search the named socketmap for the specified key.
37# .PP
38#	Postfix will not generate partial search keys such as domain
39#	names without one or more subdomains, network addresses
40#	without one or more least-significant octets, or email
41#	addresses without the localpart, address extension or domain
42#	portion. This behavior is also found with cidr:, pcre:, and
43#	regexp: tables.
44# REPLY FORMAT
45# .ad
46# .fi
47#	The Postfix socketmap client requires that replies are not
48#	longer than 100000 characters (not including the netstring
49#	encapsulation). Replies must have the following form:
50# .IP "\fBOK <space> \fIdata\fR"
51#	The requested data was found.
52# .IP "\fBNOTFOUND <space>"
53#	The requested data was not found.
54# .IP "\fBTEMP <space> \fIreason\fR"
55# .IP "\fBTIMEOUT <space> \fIreason\fR"
56# .IP "\fBPERM <space> \fIreason\fR"
57#	The request failed. The reason, if non-empty, is descriptive
58#	text.
59# SECURITY
60#	This map cannot be used for security-sensitive information,
61#	because neither the connection nor the server are authenticated.
62# SEE ALSO
63#	http://cr.yp.to/proto/netstrings.txt, netstring definition
64#	postconf(1), Postfix supported lookup tables
65#	postmap(1), Postfix lookup table manager
66#	regexp_table(5), format of regular expression tables
67#	pcre_table(5), format of PCRE tables
68#	cidr_table(5), format of CIDR tables
69# README FILES
70# .ad
71# .fi
72#	Use "\fBpostconf readme_directory\fR" or
73#	"\fBpostconf html_directory\fR" to locate this information.
74# .na
75# .nf
76#	DATABASE_README, Postfix lookup table overview
77# BUGS
78#	The protocol limits are not yet configurable.
79# LICENSE
80# .ad
81# .fi
82#	The Secure Mailer license must be distributed with this software.
83# HISTORY
84#	Socketmap support was introduced with Postfix version 2.10.
85# AUTHOR(S)
86#	Wietse Venema
87#	IBM T.J. Watson Research
88#	P.O. Box 704
89#	Yorktown Heights, NY 10598, USA
90#
91#	Wietse Venema
92#	Google, Inc.
93#	111 8th Avenue
94#	New York, NY 10011, USA
95#--
96
97