NAME

App::Addex - generate mail tool configuration from an address book

VERSION

version 0.025

DESCRIPTION

Achtung! The API to this code may very well change. It is almost certain to be broken into smaller pieces, to support alternate sources of entries, and it might just get plugins.

This module iterates through all the entries in an address book and produces configuration file based on the entries in the address book, using configured output plugins.

It is meant to be run with the addex command, which is bundled as part of this software distribution.

METHODS

new

  my $addex = App::Addex->new(\%arg);

This method returns a new Addex.

Valid parameters are:

  classes    - a hashref of plugin/class pairs, described below

Valid keys for the classes parameter are:

  addressbook - the App::Addex::AddressBook subclass to use (required)
  output      - an array of output producers (required)

For each class given, an entry in %arg may be given, which will be used to initialize the plugin before use.

addressbook

  my $abook = $addex->addressbook;

This method returns the App::Addex::AddressBook object.

output_plugins

This method returns all of the output plugin objects.

entries

This method returns all the entries to be processed. By default it is delegated to the address book object. This method may change a good bit in the future, as we really want an iterator, not just a list.

run

  App::Addex->new({ ... })->run;

This method performs all the work expected of an Addex: it iterates through the entries, invoking the output plugins for each one.

AUTHOR

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2006 by Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.