mail::srs::daemon(3pm) [debian man page]
Mail::SRS::Daemon(3pm) User Contributed Perl Documentation Mail::SRS::Daemon(3pm) NAME
Mail::SRS::Daemon - modular daemon for Mail::SRS SYNOPSIS
my $daemon = new Mail::SRS::Daemon( SecretFile => $secretfile, Separator => $separator, ); $daemon->run(); DESCRIPTION
The SRS daemon listens on a socket for SRS address transformation requests. It transforms the addresses and returns the new addresses on the socket. It may be invoked from exim using ${readsocket ...}, and probably from other MTAs as well. See http://www.anarres.org/projects/srs/ for examples. METHODS
$daemon = new Mail::SRS::Daemon(...) Construct a new Mail::SRS object and return it. All parameters which are valid for Mail::SRS are also valid for Mail::SRS::Daemon and will be passed to the constructor of Mail::SRS verbatim. The exception to this rule is the Secret parameter, which will be promoted to a list and will have all secrets from SecretFile included. New parameters are documented here. See Mail::SRS for the rest. SecretFile => $string A file to read for secrets. Secrets are specified once per line. The first specified secret is used for encoding. Secrets are written one per line. Blank lines and lines starting with a # are ignored. If Secret is not given, then the secret file must be nonempty. Secret will specify a primary secret and override SecretFile if both are specified. However, secrets read from SecretFile still be used for decoding if both are specified. Socket => $socket An instance of IO::Socket, presumed to be a listening socket. This may be provided in order to use a preexisting socket, rather than have Mail::SRS::Daemon construct a new socket. $daemon->run() Run the daemon. This method will never return. Errors and exceptions are caught, and error messages are returned down the socket. EXPORTS
Given :all, this module exports the following variables. $SRSSOCKET The filename of the default socket created by Mail::SRS::Daemon. PROTOCOL
The daemon waits for a single line of text from the client, and will respond with a single line. The lines are all of the form "COMMAND args...". Currently, two commands are supported: forward and reverse. A forward request looks like: FORWARD sender@source.com alias@forwarder.com A reverse request looks like: REVERSE srs0+HHH=TT=domain=local-part@forwarder.com In either case, the daemon will respond with either a translated address, or a line starting "ERROR ", followed by a message. TODO
Add more daemon-related options, such as path to socket, or inet socket address. SEE ALSO
Mail::SRS, srsd, http://www.anarres.org/projects/srs/ AUTHOR
Shevek CPAN ID: SHEVEK cpan@anarres.org http://www.anarres.org/projects/ COPYRIGHT
Copyright (c) 2004 Shevek. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. perl v5.10.1 2004-06-23 Mail::SRS::Daemon(3pm)
Check Out this Related Man Page
Coverage(3pm) User Contributed Perl Documentation Coverage(3pm) NAME
Test::Pod::Coverage - Check for pod coverage in your distribution. VERSION
Version 1.08 SYNOPSIS
Checks for POD coverage in files for your distribution. use Test::Pod::Coverage tests=>1; pod_coverage_ok( "Foo::Bar", "Foo::Bar is covered" ); Can also be called with Pod::Coverage parms. use Test::Pod::Coverage tests=>1; pod_coverage_ok( "Foo::Bar", { also_private => [ qr/^[A-Z_]+$/ ], }, "Foo::Bar, with all-caps functions as privates", ); The Pod::Coverage parms are also useful for subclasses that don't re-document the parent class's methods. Here's an example from Mail::SRS. pod_coverage_ok( "Mail::SRS" ); # No exceptions # Define the three overridden methods. my $trustme = { trustme => [qr/^(new|parse|compile)$/] }; pod_coverage_ok( "Mail::SRS::DB", $trustme ); pod_coverage_ok( "Mail::SRS::Guarded", $trustme ); pod_coverage_ok( "Mail::SRS::Reversable", $trustme ); pod_coverage_ok( "Mail::SRS::Shortcut", $trustme ); Alternately, you could use Pod::Coverage::CountParents, which always allows a subclass to reimplement its parents' methods without redocu- menting them. For example: my $trustparents = { coverage_class => 'Pod::Coverage::CountParents' }; pod_coverage_ok( "IO::Handle::Frayed", $trustparents ); (The "coverage_class" parameter is not passed to the coverage class with other parameters.) If you want POD coverage for your module, but don't want to make Test::Pod::Coverage a prerequisite for installing, create the following as your t/pod-coverage.t file: use Test::More; eval "use Test::Pod::Coverage"; plan skip_all => "Test::Pod::Coverage required for testing pod coverage" if $@; plan tests => 1; pod_coverage_ok( "Pod::Master::Html"); Finally, Module authors can include the following in a t/pod-coverage.t file and have "Test::Pod::Coverage" automatically find and check all modules in the module distribution: use Test::More; eval "use Test::Pod::Coverage 1.00"; plan skip_all => "Test::Pod::Coverage 1.00 required for testing POD coverage" if $@; all_pod_coverage_ok(); FUNCTIONS
All functions listed below are exported to the calling namespace. all_pod_coverage_ok( [$parms, ] $msg ) Checks that the POD code in all modules in the distro have proper POD coverage. If the $parms hashref if passed in, they're passed into the "Pod::Coverage" object that the function uses. Check the Pod::Coverage manual for what those can be. The exception is the "coverage_class" parameter, which specifies a class to use for coverage testing. It defaults to "Pod::Coverage". pod_coverage_ok( $module, [$parms, ] $msg ) Checks that the POD code in $module has proper POD coverage. If the $parms hashref if passed in, they're passed into the "Pod::Coverage" object that the function uses. Check the Pod::Coverage manual for what those can be. The exception is the "coverage_class" parameter, which specifies a class to use for coverage testing. It defaults to "Pod::Coverage". all_modules( [@dirs] ) Returns a list of all modules in $dir and in directories below. If no directories are passed, it defaults to blib if blib exists, or lib if not. Note that the modules are as "Foo::Bar", not "Foo/Bar.pm". The order of the files returned is machine-dependent. If you want them sorted, you'll have to sort them yourself. BUGS
Please report any bugs or feature requests to "bug-test-pod-coverage at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Pod-Coverage>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. SUPPORT
You can find documentation for this module with the perldoc command. perldoc Test::Pod::Coverage You can also look for information at: * AnnoCPAN: Annotated CPAN documentation <http://annocpan.org/dist/Test-Pod-Coverage> * CPAN Ratings <http://cpanratings.perl.org/d/Test-Pod-Coverage> * RT: CPAN's request tracker <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-Pod-Coverage> * Search CPAN <http://search.cpan.org/dist/Test-Pod-Coverage> AUTHOR
Written by Andy Lester, "<andy at petdance.com>". ACKNOWLEDGEMENTS
Thanks to Ricardo Signes for patches, and Richard Clamp for writing Pod::Coverage. COPYRIGHT &; LICENSE Copyright 2006, Andy Lester, All Rights Reserved. You may use, modify, and distribute this package under the same terms as Perl itself. perl v5.8.8 2008-03-04 Coverage(3pm)