NAME
    FML::Confirm - manipulate confirmation database.

SYNOPSIS
        use FML::Confirm;
        my $confirm = new FML::Confirm $curproc, {
                keyword   => $keyword,
                cache_dir => $cache_dir,
                class     => 'subscribe',
                address   => $address,
                buffer    => $command,
            };
        my $id = $confirm->assign_id;
        $curproc->reply_message_nl('command.confirm');
        $curproc->reply_message("\n$id\n");

DESCRIPTION
    This module provides several utilitiy functions for confirmation: assign
    id store id expire id database manipulation utility

METHODS
  new($cargs)
    constructor. The argument follows:

        $cargs = {
            keyword   => "confirm",
            class     => "subscribe",
            address   => "mail@address",
            buffer    => $buffer,
            cache_dir => "/some/where",
        };

    This class uses journaled database FML::Cache::Journal as database
    internally.

  assign_id()
    assign a new id for the current object.

  store_id($id, $comment)
    save id into databse with comment if specified.

  find($id)
    find database value for $id.

  get_request($id)
    get request info for id $id.

  get_address($id)
    get address for $id.

  set($id, $key, $value)
    set $value for the key $key-$id.

  get($id, $key)
    get value for the key $key-$id.

  is_expired($id, $howold)
    check if request for $id is expired or not. The expiration limit can be
    specified by $howold parameter. If not specified, expiration limit is 14
    days.

Cache database
    This cache uses "FML::Cache::Journal" based on "Tie::JournaledDir".

    These are private methods.

CODING STYLE
    See "http://www.fml.org/software/FNF/" on fml coding style guide.

AUTHOR
    Ken'ichi Fukamachi

COPYRIGHT
    Copyright (C) 2001,2004,2005,2006 Ken'ichi Fukamachi

    All rights reserved. This program is free software; you can redistribute
    it and/or modify it under the same terms as Perl itself.

HISTORY
    FML::Confirm first appeared in fml8 mailing list driver package. See
    "http://www.fml.org/" for more details.

