NAME

Mail::SimpleList::Aliases - manages Mail::SimpleList::Alias objects

SYNOPSIS

    use Mail::SimpleList::Aliases;
    my $aliases = Mail::SimpleList::Aliases->new( '.aliases' );

DESCRIPTION

Mail::SimpleList::Aliases manages the creation, loading, and saving of Mail::SimpleList::Alias objects. If you'd like to change how these objects are managed on your system, subclass or reimplement this module.

METHODS

• new( [ $alias_directory ] )

  Creates a new Mail::SimpleList::Aliases object. The single argument is optional but highly recommended. It should be the path to where Alias data files are stored. Beware that in filter mode, relative paths can be terribly ambiguous.

  If no argument is provided, this will default to ~/.aliases for the invoking user.

• storage_dir()

  Returns the directory where this object's Alias data files are stored.

• exists( $alias_name )

  Returns true or false if an alias with this name exists.

• fetch( $alias_name )

  Creates and returns a Mail::SimpleList::Alias object represented by this alias name. This can return nothing if the alias does not exist.

• create( $owner )

  Creates and returns a new Mail::SimpleList::Alias object, setting the owner. Note that you will need to save() the object yourself, if that's important to you.

• save( $alias, $alias_name )

  Saves a Mail::SimpleList::Alias object provided as $alias with the given name in $alias_name.

AUTHOR

chromatic, chromatic@wgz.org, with helpful suggestions from friends, family, and peers.

BUGS

None known.

TODO

No plans. It's pretty nice as it is.

SEE ALSO

Mail::Action::Storage, the parent class.

COPYRIGHT

Copyright (c) 2003 - 2016 chromatic. All rights reserved. This module is distributed under the same terms as Perl 5.30, in the hope that it is useful but under no warranty.