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

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