README

   1 kartero -- a mail submission client
   2 ===================================
   3
   4 Kartero is a program that relays outgoing mail from a Mail User Agent
   5 (MUAs such as KMail, Gnus, or Icedove) to a ``smart host'' that does the
   6 actual transport to the mail's destination.  It uses the bundled
   7 Net::SMTP::Server::SmartHost module to spawn a local SMTP server that
   8 the user's MUA can talk to, and relay, outgoing mail.
   9
  10 Kartero is geared towards users who do not want to run a full-fleged
  11 Mail Transport Agent (MTA) on their machine or local network, yet
  12 require a means to transport outgoing mail to the Internet.
  13
  14 Net::SMTP::Server::SmartHost is a simple helper module for the
  15 Net::SMTP::Server framework written by MacGyver (aka Habeeb J. Dihu.)
  16 It provides the means of connecting to the remote smarthost and relay
  17 outgoing mail to that smarthost.
  18
  19 INSTALLATION
  20
  21 To install this module type the following:
  22
  23    perl Makefile.PL
  24    make
  25    make test
  26    make install
  27
  28 DEPENDENCIES
  29
  30 This module requires these other modules and libraries:
  31
  32    Carp
  33    Config::IniFiles
  34    Date::Format
  35    MIME::Base64
  36    Net::SMTP
  37    Net::SMTP::Server
  38    Sys::Hostname
  39    Test::More
  40
  41 USAGE
  42
  43 To use kartero, first make a `.karterorc' configuration file and put it
  44 in your home directory.  It should look like this:
  45
  46   [server]
  47   host = localhost
  48   port = 2525
  49
  50   [relay]
  51   name = yahoo
  52   smarthost = smtp.bizmail.yahoo.com:587
  53   auth = yes
  54   username = zak
  55   passwd = idontknow
  56
  57 If your remote smarthost does not need authentication, you may ignore
  58 including the `auth', `username', and `passwd' lines.  You may want to
  59 `~/.karterorc' access restriction to yourself only by doing `chmod 600
  60 ~/.karterorc`.
  61
  62 Then, when your `~/.karterorc' is all set, just run the `kartero'
  63 program.  You may wish to run it as a background process by invoking it
  64 as `kartero &` instead.  If you run kartero with the above
  65 configuration, it will start a server running on localhost port 2525 and
  66 relay mails using the smarthost at smtp.bizmail.yahoo.com port 587,
  67 authenticating with the provided credentials.
  68
  69 After doing so, you will have to configure your MUA to send mails to the
  70 kartero server.  This differs across MUAs, but the thing to remember
  71 here is that your MUA should be able to connect to the (local) kartero
  72 server and send mails via SMTP.
  73
  74 COPYRIGHT AND LICENCE
  75
  76 Put the correct copyright and licence information here.
  77
  78 Copyright (C) 2007 by Zak B. Elep
  79
  80 This library is free software; you can redistribute it and/or modify
  81 it under the same terms as Perl itself, either Perl version 5.8.8 or,
  82 at your option, any later version of Perl 5 you may have available.