Webservice::OVH::Email::Domain::Domain::Account
use Webservice::OVH; my $ovh = Webservice::OVH->new_from_json("credentials.json"); my $email_domain = $ovh->email->domain->domain('testdomain.de'); my $account = $email_domain->new_account( account_name => 'testaccount', password => $password, description => 'a test account', size => 50000000 );
Provides access to email accounts.
Internal Method to create an Account object. This method should never be called directly.
Parameter: $api_wrapper - ovh api wrapper object, $module - root object, $domain - parent domain Objekt, $account_name => unique name
Return: Webservice::OVH::Email::Domain::Domain::Account
Synopsis: Webservice::OVH::Email::Domain::Domain::Account->_new_existing($ovh_api_wrapper, $domain, $account_name, $module);
Internal Method to create the Account object. This method should never be called directly.
Parameter: $api_wrapper - ovh api wrapper object, $module - root object, $domain - parent domain, %params - key => value
Synopsis: Webservice::OVH::Email::Domain::Domain::Account->_new($ovh_api_wrapper, $domain, $module, account_name => $account_name, password => $password, description => $description, size => $size );
When this account is deleted on the api side, this method returns 0.
Return: VALUE
Synopsis: print "Valid" if $account->is_valid;
Unique identifier.
Synopsis: my $name = $account->name;
Returns the raw properties as a hash. This is the original return value of the web-api.
Return: HASH
Synopsis: my $properties = $account->properties;
Exposed property value.
Synopsis: my $is_blocked = $account->is_blocked;
Synopsis: my $email = $account->email;
Returns the email-domain this account is attached to.
Return: Webservice::Email::Domain::Domain
Synopsis: my $email_domain = $account->domain;
Synopsis: my $description = $account->description;
Synopsis: my $size = $account->size;
Changes the account
Parameter: %params - key => value description size
Synopsis: $account->change(description => 'authors account', size => 2000000 );
Deletes the account api sided and sets this object invalid.
Synopsis: $account->delete;
Parameter: $password - new password
Synopsis: $account->change_password($password);
Synopsis: $account->usage;
Get all associated tasks
Synopsis: $account->tasks;
To install Webservice::OVH, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Webservice::OVH
CPAN shell
perl -MCPAN -e shell install Webservice::OVH
For more information on module installation, please visit the detailed CPAN module installation guide.