git.sur5r.net Git - openldap/blob - clients/rcpt500/README

   1 LDAP rcpt500 mail query server README
   2
   3 OVERVIEW
   4 This is a mail-query server that answers X.500 white pages queries.
   5 It is designed to be run out of your mail systems alias file, or the
   6 equivalent.  It expects to be fed the entire contents (including
   7 headers) of an RFC822 message via standard input.  It parses the
   8 message, looking in the Subject: field or the body of the message
   9 for a command that it recognizes.
  10
  11 The commands currently recognized are listed in the file cmd.c.  They
  12 all map into two actual operations the server performs: an X.500 query
  13 or a help command.  If no recognizable command is found in the
  14 Subject:  or body of the message, help is assumed.  An appropriate
  15 reply is sent to the sender of the message in response to the command.
  16
  17 The help command returns the contents of the file rcpt500.help.  You
  18 can modify the contents as appropriate for your local site.
  19
  20 The query command performs a series of X.500 searches to try to find
  21 a person that matches the object of the query.  If more than one
  22 X.500 entry matches, a list is returned.  If exactly one is matched,
  23 detailed information is returned. Here is an example message and rcpt500
  24 generated reply:
  25
  26 Query message:
  27         Mail x500-query@umich.edu
  28         Subject: find tim howes
  29         .
  30
  31 Reply from rcpt500:
  32     Message-Id: <199209161526.AA12041@umich.edu>
  33     Date: Wed, 16 Sep 1992 11:26:17 -0400
  34     From: "X.500 Query Program" <X500-Query@umich.edu>
  35     Subject: Re: find tim howes
  36     In-Reply-To: Your message of "Wed, 16 Sep 1992 11:26:12 -0400"
  37                  <199209161526.AA26144@terminator.cc.umich.edu>
  38     To: "Mark Smith" <mcs@terminator.cc.umich.edu>
  39
  40     One exact match was found for 'tim howes':
  41     "Timothy A Howes, Information Technology Division, Faculty and Staff"
  42       Also known as:
  43                         Timothy Howes
  44                         Timothy A Howes 1
  45                         Timothy A Howes
  46                         Tim Howes
  47       E-mail address:
  48                         tim@terminator.cc.umich.edu
  49       Fax number:
  50                         +1 313 764 5140 (argus building)
  51       Business phone:
  52                         +1 313 747-4454
  53       Business address:
  54                         ITD Research Systems
  55                         535 W William St.
  56                         Ann Arbor, MI 48103-4943
  57       Title:
  58                         Systems Research Programmer II, Research Systems
  59       Uniqname:
  60                         tim
  61
  62 If you want to try out rcpt500 yourself before installing it at your site,
  63 send a message to x500-query@umich.edu (we have a server running
  64 there that serves University of Michigan white pages information).
  65
  66
  67 CONFIGURING AND RUNNING rcpt500 AT YOUR LOCAL SITE
  68 You will probably need to make changes to the file ldapconfig.h.edit to
  69 configure rcpt500 for your local site.  There are comments in the file
  70 describing each variable you might need to change.  Then type make in
  71 the rcpt500 directory to make sure things are up to date.  You will
  72 need to install the rcpt500 binary and help files (make install).  This
  73 all assumes you have built the LDAP libraries already.  If in doubt,
  74 just do a make from the top of the LDAP distribution.
  75
  76 You will then need to set up an alias that your users can send mail
  77 to that will feed the messages to rcpt500.  At our site, we run sendmail
  78 so the alias is in /usr/lib/aliases and looks like:
  79
  80         x500-query:     "|/usr/local/etc/rcpt500 -l"
  81
  82 The available command line options for rcpt500 are:
  83     -l                  enable logging of requests via the syslog
  84                           LOG_DAEMON facility
  85     -h ldaphost         specify LDAP server host to connect to
  86     -b searchbase       specify starting point of X.500 searches
  87     -a                  don't deference aliases during searches
  88     -s stripcount       remove "stripcount" DN components from user
  89                           friendly form names that are displayed
  90     -z sizelimit        return at most "sizelimit" entries
  91     -u dapuser          DN to bind to X.500 as when searching
  92
  93 The search and display behavior is defined in the ldapfilter.conf and
  94 ldaptemplates.conf files.
  95
  96
  97 SUPPORT
  98
  99     The software is provided as is without any express or implied
 100     warranty, but you can send questions and suggestions to the
 101     mailinglist
 102
 103             OpenLDAP-general@OpenLDAP.org
 104
 105
 106 BUG REPORTING
 107
 108     Bug reports should be sent to OpenLDAP-its@OpenLDAP.org.
 109
 110
 111 README Last updated August 1999 by Hallvard Furuseth