descriptionkartero -- a mail submission client
ownerzakame@spunge.org
last changeSun, 4 Mar 2007 17:43:16 +0000 (5 01:43 +0800)
content tags
add:
README
kartero -- a mail submission client
===================================

Kartero is a program that relays outgoing mail from a Mail User Agent
(MUAs such as KMail, Gnus, or Icedove) to a ``smart host'' that does the
actual transport to the mail's destination.  It uses the bundled
Net::SMTP::Server::SmartHost module to spawn a local SMTP server that
the user's MUA can talk to, and relay, outgoing mail.

Kartero is geared towards users who do not want to run a full-fleged
Mail Transport Agent (MTA) on their machine or local network, yet
require a means to transport outgoing mail to the Internet.

Net::SMTP::Server::SmartHost is a simple helper module for the
Net::SMTP::Server framework written by MacGyver (aka Habeeb J. Dihu.)
It provides the means of connecting to the remote smarthost and relay
outgoing mail to that smarthost.

INSTALLATION

To install this module type the following:

   perl Makefile.PL
   make
   make test
   make install

DEPENDENCIES

This module requires these other modules and libraries:

   Carp
   Config::IniFiles
   Date::Format
   MIME::Base64
   Net::SMTP
   Net::SMTP::Server
   Sys::Hostname
   Test::More

USAGE

To use kartero, first make a `.karterorc' configuration file and put it
in your home directory.  It should look like this:

  [server]
  host = localhost
  port = 2525

  [relay]
  name = yahoo
  smarthost = smtp.bizmail.yahoo.com:587
  auth = yes
  username = zak
  passwd = idontknow

If your remote smarthost does not need authentication, you may ignore
including the `auth', `username', and `passwd' lines.  You may want to
`~/.karterorc' access restriction to yourself only by doing `chmod 600
~/.karterorc`.

Then, when your `~/.karterorc' is all set, just run the `kartero'
program.  You may wish to run it as a background process by invoking it
as `kartero &` instead.  If you run kartero with the above
configuration, it will start a server running on localhost port 2525 and
relay mails using the smarthost at smtp.bizmail.yahoo.com port 587,
authenticating with the provided credentials.

After doing so, you will have to configure your MUA to send mails to the
kartero server.  This differs across MUAs, but the thing to remember
here is that your MUA should be able to connect to the (local) kartero
server and send mails via SMTP.

COPYRIGHT AND LICENCE

Put the correct copyright and licence information here.

Copyright (C) 2007 by Zak B. Elep

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.
shortlog
2007-03-04 Zak B. Elepkartero v0.02masterv0.02
2007-03-04 Zak B. ElepRelicense the kartero script as GPL, but keep SmarHost...
2007-03-04 Zak B. ElepPrepare for releasing v0.02
2007-03-04 Zak B. ElepDescribe what kartero is, instead of just saying its...
2007-03-04 Zak B. ElepRefactor a bit
2007-03-04 Zak B. ElepGenerate a `Received' header using Date::Format
2007-03-03 Zak B. ElepStart writing about kartero usage
2007-03-03 Zak B. ElepUse some defaults, remove `port' variable in configuration
2007-03-03 Zak B. ElepAdd some initial documentation on configuring kartero
2007-03-03 Zak B. ElepGet basic user configuration working
2007-03-03 Zak B. ElepDon't add new `To' header when sending mail
2007-02-22 Zak B. ElepAdd forgotten TODO in MANIFEST
2007-02-22 Zak B. ElepAdd TODO
2007-02-21 Zak B. ElepMake kartero the primary, add missing files to MANIFEST...
2007-02-19 Zak B. ElepAdjust build-dependencies to Perl v5.8
2007-02-17 Zak B. ElepRemove forgotten build dependency on Tie::File
...
tags
17 years ago v0.02 kartero v0.02
17 years ago v0.01 kartero v0.01
heads
17 years ago master