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     Received: from totalrecall.rs.itd.umich.edu by terminator.cc.umich.edu
  33             id AA26151; Wed, 16 Sep 92 11:26:18 -0400
  34     Received: by umich.edu (5.65/2.2)
  35             id AA12041; Wed, 16 Sep 92 11:26:17 -0400
  36     Message-Id: <9209161526.AA12041@umich.edu>
  37     Date: Wed, 16 Sep 92 11:26:17 -0400
  38     From: "X.500 Query Program" <X500-Query@umich.edu>
  39     Subject: Re: find tim howes
  40     In-Reply-To: Your message of "Wed, 16 Sep 92 11:26:12 -0400"
  41                  <9209161526.AA26144@terminator.cc.umich.edu>
  42     To: "Mark Smith" <mcs@terminator.cc.umich.edu>
  43
  44     One exact match was found for 'tim howes':
  45     "Timothy A Howes, Information Technology Division, Faculty and Staff"
  46       Also known as:
  47                         Timothy Howes
  48                         Timothy A Howes 1
  49                         Timothy A Howes
  50                         Tim Howes
  51       E-mail address:
  52                         tim@terminator.cc.umich.edu
  53       Fax number:
  54                         +1 313 764 5140 (argus building)
  55       Business phone:
  56                         +1 313 747-4454
  57       Business address:
  58                         ITD Research Systems
  59                         535 W William St.
  60                         Ann Arbor, MI 48103-4943
  61       Title:
  62                         Systems Research Programmer II, Research Systems
  63       Uniqname:
  64                         tim
  65
  66 If you want to try out rcpt500 yourself before installing it at your site,
  67 send a message to x500-query@umich.edu (we have a server running
  68 there that serves University of Michigan white pages information).
  69
  70
  71 CONFIGURING AND RUNNING rcpt500 AT YOUR LOCAL SITE
  72 You will probably need to make changes to the file ldapconfig.h.edit to
  73 configure rcpt500 for your local site.  There are comments in the file
  74 describing each variable you might need to change.  Then type make in
  75 the rcpt500 directory to make sure things are up to date.  You will
  76 need to install the rcpt500 binary and help files (make install).  This
  77 all assumes you have built the LDAP libraries already.  If in doubt,
  78 just do a make from the top of the LDAP distribution.
  79
  80 You will then need to set up an alias that your users can send mail
  81 to that will feed the messages to rcpt500.  At our site, we run sendmail
  82 so the alias is in /usr/lib/aliases and looks like:
  83
  84         x500-query:     "|/usr/local/etc/rcpt500 -l"
  85
  86 The available command line options for rcpt500 are:
  87     -l                  enable logging of requests via the syslog
  88                           LOG_DAEMON facility
  89     -h ldaphost         specify LDAP server host to connect to
  90     -b searchbase       specify starting point of X.500 searches
  91     -a                  don't deference aliases during searches
  92     -s stripcount       remove "stripcount" DN components from user
  93                           friendly form names that are displayed
  94     -z sizelimit        return at most "sizelimit" entries
  95     -u dapuser          DN to bind to X.500 as when searching
  96
  97 The search and display behavior is defined in the ldapfilter.conf and
  98 ldaptemplates.conf files.
  99
 100
 101 SUPPORT
 102
 103     The software is provided as is without any express or implied
 104     warranty, but there is a bug reporting mail address which is
 105     responded to on a best-effort basis:
 106
 107             ldap-support@terminator.cc.umich.edu
 108
 109
 110 BUG REPORTING
 111
 112     Bug reports should be sent to bug-ldap@terminator.cc.umich.edu.
 113
 114
 115 README Last updated 10 November 1994 Mark Smith