File: README

package info (click to toggle)
libnet-smtp-server-perl 1.1-3+lenny1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 96 kB
  • ctags: 27
  • sloc: perl: 250; makefile: 50
file content (146 lines) | stat: -rw-r--r-- 5,789 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
SMTP::Server
------------

This module is a complete, RFC 821 compliant, SMTP server implementation
written entirely in Perl.  It has powerful extensively and customization
facilities that allow for a variety of potential uses.

You can always find the most current version at:

http://www.macgyver.org/software/perl/

This software is Copyright(C) 1999, MacGyver (aka Habeeb J. Dihu).
All Rights Reserved.

You may distribute this package under the terms of either the GNU
General Public License or the Artistic License, as specified in the
Perl README file.

To install:

perl Makefile.PL

This will generate the necessary Makefiles for you.

make
make install

And you're all set.  If you really want to run a couple of tests, type
make check

You may not have 'make' available on Win32 platforms, if not, you can always
just copy the Server.pm file and the Server directory to your Perl library
underneath the Net/SMTP directory.

----
NAME
    Net::SMTP::Server - A native Perl SMTP Server implementation for
    Perl.

SYNOPSIS
      use Carp;
      use Net::SMTP::Server;
      use Net::SMTP::Client;
      use Net::SMTP::Relay;

      $server = new Net::SMTP::Server('localhost', 25) ||
        croak("Unable to handle client connection: $!\n");

      while($conn = $server->accept()) {
        # We can perform all sorts of checks here for spammers, ACLs,
        # and other useful stuff to check on a connection.

        # Handle the client's connection and spawn off a new parser.
        # This can/should be a fork() or a new thread,
        # but for simplicity...
        my $client = new Net::SMTP::Server::Client($conn) ||
            croak("Unable to handle client connection: $!\n");

        # Process the client.  This command will block until
        # the connecting client completes the SMTP transaction.
        $client->process || next;
        
        # In this simple server, we're just relaying everything
        # to a server.  If a real server were implemented, you
        # could save email to a file, or perform various other
        # actions on it here.
        my $relay = new Net::SMTP::Server::Relay($client->{FROM},
                                                 $client->{TO},
                                                 $client->{MSG});
      }

DESCRIPTION
    The Net::SMTP::Server module implements an RFC 821 compliant
    SMTP server, completely in Perl. It's extremely extensible, so
    adding in things like spam filtering, or more advanced routing
    and handling features can be easily handled. An additional
    module, Net::SMTP::Server::Relay has also been implemented as an
    example of just one application of this extensibility. See the
    pod for more details on that module. This extension has been
    tested on both Unix and Win32 platforms.

    Creating a new server is as trivial as:

      $server = new Net::SMTP::Server($host, $port);

    This creates a new SMTP::Server. Both $host and $port are
    optional, and default to the current hostname and the standard
    SMTP port (25). However, if you run on a multi-homed machine,
    you may want to explicitly specify which interface to bind to.

    The server loop should look something like this:

      while($conn = $server->accept()) {
        my $client = new Net::SMTP::Server::Client($conn) ||
            croak("Unable to handle client connection: $!\n");    

        $client->process;
      }

    The server will continue to accept connections forever. Once we
    have a connection, we create a new Net::SMTP::Server::Client.
    This is a new client connection that will now be handled. The
    reason why processing doesn't begin here is to allow for any
    extensibility or hooks a user may want to add in after we've
    accepted the client connection, but before we give the initial
    welcome message to the client. Once we're ready to process an
    SMTP session, we call $client->process. This may HANG while the
    SMTP transaction takes place, as the client and server are
    communicating back and forth (and if there's a lot of data to
    transmit, well...).

    Once $client->process returns, various fields have been filled
    in. Those are:

      $client->{TO}    -- This is an array containing the intended
                          recipients for this message.  There may be
                          multiple recipients for any given message.

      $client->{FROM}  -- This is the sender of the given message.
      $client->{MSG}   -- The actual message data. :)

    The SMTP::Server module performs no other processing for the
    user. It's meant to give you the building blocks of an
    extensible SMTP server implementation. For example, using the
    MIME modules, you can easily process $client->{MSG} to handle
    MIME attachments, etc. Or you could implement ACLs to control
    who can connect to the server, or what actions are taken.
    Finally, a suggested use that the author himself uses, is as an
    SMTP relay. There are lots of times I need access to an SMTP
    server just to send a message, but don't have access to one for
    whatever reason (firewalls, permissions, etc). You can run your
    own SMTP server whether under Unix or Win32 environments, and
    simply point your favorite mail client to it when sending
    messages. See the Net::SMTP::Server::Relay modules for details
    on that use.

AUTHOR AND COPYRIGHT
Net::SMTP::Server / SMTP::Server is Copyright(C) 1999,
  MacGyver (aka Habeeb J. Dihu) <macgyver@tos.net>.  ALL RIGHTS RESERVED.
    You may distribute this package under the terms of either the
    GNU General Public License or the Artistic License, as specified
    in the Perl README file.

SEE ALSO
    Net::SMTP::Server::Client, Net::SMTP::Server::Relay