NAME

CPAN::Index::API::File::MailRc - Interface to 01mailrc.txt

VERSION

version 0.005

SYNOPSIS

  my $mailrc = CPAN::Index::File::MailRc->parse_from_repo_uri(
    'http://cpan.perl.org'
  );

  foreach my $author ($mailrc->sorted_authors) {
    ... # do something
  }

DESCRIPTION

This is a class to read and write 01mailrc.txt

METHODS

authors

List of hashres containing author data. The structure of the hashrefs is as follows:

authorid

CPAN id of the author. This should be a string containing only capital latin letters and is at least 2 characters long.

name

Author's full name.

email

Author's email. The string CENSORED may appear where the email address is not available or onot to be displayed publicly.

sorted_authors

List of authors sorted by pause id.

parse

Parses the file and reurns its representation as a data structure.

default_location

Default file location - authors/01mailrc.txt.gz.

METHODS FROM ROLES

<CPAN::Index::API::Role::Readable/read_from_string>

<CPAN::Index::API::Role::Readable/read_from_file>

<CPAN::Index::API::Role::Readable/read_from_tarball>

<CPAN::Index::API::Role::Readable/read_from_repo_path>

<CPAN::Index::API::Role::Readable/read_from_repo_uri>

"tarball_is_default" in CPAN::Index::API::Role::Writable

"repo_path" in CPAN::Index::API::Role::Writable

"template" in CPAN::Index::API::Role::Writable

"content" in CPAN::Index::API::Role::Writable

"write_to_file" in CPAN::Index::API::Role::Writable

"write_to_tarball" in CPAN::Index::API::Role::Writable

"clone" in CPAN::Index::API::Role::Clonable

AUTHOR

Peter Shangov <pshangov@yahoo.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Venda, Inc..

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