NAME

WWW::Yandex::PDD - Perl extension for Yandex mailhosting

SYNOPSIS

use WWW::Yandex::PDD;

my $pdd = WWW::Yandex::PDD->new( token => 'abcdefghijklmnopqrstuvwxyz01234567890abcdefghijklmnopqrs' );
$pdd->create_user( 'mynewuser', 'mysecretpassword' );

DESCRIPTION

WWW::Yandex::PDD allows to manage user mail accounts on Yandex mailhosting

METHODS

$pdd->new( token => $token );

$pdd->new( token => $token, cert_file => $cert_file );

Construct a new WWW::Yandex::PDD object

$token A string obtained at L<http://api.yandex.ru/pdd/doc/api-pdd/reference/get-token.xml#get-token>

$cert_file New $ENV{HTTPS_CA_FILE} value

$pdd->create_user( $login, $password );

$pdd->create_user( $login, $encrypted_password, 'encrypted' );

$encrypted_password is MD5-CRYPT password hash: "$1$" + 8 character salt [a-zA-Z0-9./] + "$" + 22 character checksum [a-zA-Z0-9./]

$pdd->update_user( $login, password => $password, iname => $iname, fname => $fname, sex => $sex, hintq => $hintq, hinta => $hinta )

See $pdd-get_user> for parameters meaning

Returns UID if success, undef otherwise

$pdd->delete_user( $login ) =item $pdd->delete_user( $login, $domain )

Optional $domain if $login is in another domain

Returns 1 if success

$pdd->get_unread_count($login)

Returns number of unread messages, undef if error

$pdd->get_user( $login )

Returns undef if fail, or the following structure if success:

$result = {
	domain      => 'mydomain.org',
	login       => 'username',
	birth_date  => '1900-01-01',
	iname       => 'John',
	fname       => 'Doe',
	hintq       => 'Your mother\'s maiden name?', # utf-8
	hinta       => '*****',
	mail_format => '', # preferred mail format
	charset     => '', # preferred charset
	nickname    => 'johnny',
	sex         => 1, # 0 - N/A, 1 - male, 2 - female
	enabled     => 1, # 1 - normal, mail accepted; 0 - locked, mail rejected
	signed_eula => 1, # user accepted EULA: 1 - yes, 0 - no
};

$pdd->get_user_list($page, $per_page)

Returns domain information and user list, undef if error

$page Page number.

$per_page Number of mailbox records on a single page; cannot be more than 100; 100 records by default.

$result = {
	'action-status'    =>  '',				# error message
	'found'            =>  18, 				# number of users returned
	'total'            =>  18, 				# total number of users in this domain
	'domain'           =>  'mydomain.org',
	'status'           =>  'added', 		# added, mx-activate, domain-activate
	'emails-max-count' =>  1000,			# maximum users for this domain
	'emails'           =>  [ 'jdoe', 'mkay' ], # user list
}

$pdd->import_user( $login, $password, ext_login => $ext_login, ext_password => $ext_password, forward_to => $forward, save_copy => $save_copy )

$ext_login login on the source server, defaults to $login $ext_password user's password on the source server, defaults to $password $forward_to optional, set forwarding for this new mailbox $save_copy works only if forwarding is on; 0 - do not save copies in the local mailbox, 1 - save copies and forward

$pdd->is_user_exists( $login )

Returns 0 if exists, 1 if doesn't exist, undef if error

$pdd->set_forward( $login, $forward_to, $save_copy )

Sets forwarding to $forward_to

$save_copy: "yes", "no"