Alex Muntada > App-backimap-0.00_13 > App::backimap::Storage

Download:
App-backimap-0.00_13.tar.gz

Dependencies

Annotate this POD

Module Version: 0.00_13   Source  

NAME ^

App::backimap::Storage - manages backimap storage

VERSION ^

version 0.00_13

ATTRIBUTES ^

dir

Sets pathname to the storage (defaults to ~/.backimap).

init

Tells that storage must be initialized.

clean

Tells that storage must be cleaned if dirty.

resume

Tells that storage should try to resume from a dirty state: preserve previous scheduled files and purge unknown ones before performing a commit.

author

Name of the committing author in local storage.

The name is configured on the storage initialization.

email

Author email address that will be used along with the author name as the committing author.

The email is configured on the storage initialization.

METHODS ^

find( $file, ... )

Returns a list of files that are found in storage.

list( $dir )

Returns a list of files in a directory from storage.

get( $file )

Retrieves file from storage.

put( $file => $content, ... )

Adds files to storage.

explode( $dir => $content, ... )

Explodes content MIME parts in several files and adds them to storage.

delete( $file, ... )

Removes files from storage.

move( $from, $to )

Renames or moves files and directories from one place to another in storage.

commit( $change, [$file] ... )

Commits pending storage actions with a description of change. If a list of files is provided, only those will be committed. Otherwise all pending actions will be performed.

reset()

Rolls back any storage actions that were performed but not committed. Returns storage back to last committed status.

AUTHOR ^

Alex Muntada <alexm@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by Alex Muntada.

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

syntax highlighting: