r4523@g5: ask | 2006-02-27 13:42:54 -0800

Improve Qpsmtpd::Transaction documentation (Fred Moyer)


git-svn-id: https://svn.perl.org/qpsmtpd/branches/0.3x@622 958fd67b-6ff1-0310-b445-bb7760255be9
This commit is contained in:
Ask Bjørn Hansen 2006-02-27 21:43:08 +00:00
parent 00a73023c8
commit 3f8ab06a36
2 changed files with 34 additions and 0 deletions

View File

@ -3,6 +3,8 @@
Make the clamdscan plugin temporarily deny mail if if can't talk to clamd Make the clamdscan plugin temporarily deny mail if if can't talk to clamd
(Filippo Carletti) (Filippo Carletti)
Improve Qpsmtpd::Transaction documentation (Fred Moyer)
0.32 - 2006/02/26 0.32 - 2006/02/26

View File

@ -136,6 +136,14 @@ These API docs assume you already have a connection object. See the
source code if you need to construct one. You can access the connection source code if you need to construct one. You can access the connection
object via the C<Qpsmtpd> object's C<< $qp->connection >> method. object via the C<Qpsmtpd> object's C<< $qp->connection >> method.
=head2 new ( )
Instantiates a new Qpsmtpd::Connection object.
=head2 start ( %args )
Initializes the connection object with %args attribute data.
=head2 remote_host( ) =head2 remote_host( )
The remote host connecting to the server as looked up via reverse dns. The remote host connecting to the server as looked up via reverse dns.
@ -144,11 +152,25 @@ The remote host connecting to the server as looked up via reverse dns.
The remote IP address of the connecting host. The remote IP address of the connecting host.
=head2 remote_port( )
The remote port.
=head2 hello( )
=head2 remote_info( ) =head2 remote_info( )
If your server does an ident lookup on the remote host, this is the If your server does an ident lookup on the remote host, this is the
identity of the remote client. identity of the remote client.
=head2 local_ip( )
The local ip.
=head2 local_port( )
The local port.
=head2 hello( ) =head2 hello( )
Either C<"helo"> or C<"ehlo"> depending on how the remote client Either C<"helo"> or C<"ehlo"> depending on how the remote client
@ -168,4 +190,14 @@ set after a successful return from those hooks.
Connection-wide notes, used for passing data between plugins. Connection-wide notes, used for passing data between plugins.
=head2 clone( )
Returns a copy of the Qpsmtpd::Connection object.
=cut
=head2 relay_client( )
True if the client is allowed to relay messages.
=cut =cut