- NAME
- SYNOPSIS
- DESCRIPTION
- METHODS
  - _new
  - service_infos
  - name
  - properties
  - allowed_account_size
  - creation_date
  - filerz
  - status
  - redirections
  - redirection
  - new_redirection
  - accounts
  - account
  - new_account
  - mailing_lists
  - mailing_list
  - new_mailing_list

# NAME

Webservice::OVH::Email::Domain::Domain

# SYNOPSIS

use Webservice::OVH;

my $ovh = Webservice::OVH->new_from_json("credentials.json");

my $email_domain = $ovh->email->domain->domain('testdomain.de');

# DESCRIPTION

Provides access to api email-domain methods like mailinglists, accounts and redirections.

# METHODS

## _new

Internal Method to create the domain object. This method is not ment to be called external.

- Parameter: $api_wrapper - ovh api wrapper object, $module - root object

- Return: Webservice::OVH::Email::Domain

- Synopsis: Webservice::OVH::Email::Domain->_new($ovh_api_wrapper, $zone_name, $module);

## service_infos

Retrieves additional infos about the email-domain. Not part of the properties

- Return: HASH

- Synopsis: my $info = $email_domain->service_infos;

## name

Name is the unique identifier.

- Return: VALUE

- Synopsis: my $name = $email_domain->name;

## properties

Retrieves properties of the email-domain. This method updates the intern property variable.

- Return: HASH

- Synopsis: my $properties = $email_domain->properties;

## allowed_account_size

Exposed Property Value. Readonly.

- Return: VALUE

- Synopsis: my $allowed_account_size = $email_domain->allowed_account_size;

## creation_date

Exposed Property Value. Readonly.

- Return: DateTime

- Synopsis: my $creation_date = $email_domain->creation_date;

## filerz

Exposed Property Value. Readonly.

- Return: VALUE

- Synopsis: my $filerz = $email_domain->filerz;

## status

Exposed Property Value. Readonly.

- Return: VALUE

- Synopsis: my $status = $email_domain->status;

## redirections

Produces an array of all available redirections that are connected to the email-domain.

- Return: ARRAY

- Synopsis: my $redirections = $email_domain->redirections();

## redirection

Returns a single redirection by id

- Parameter: $redirection_id - id

- Return: Webservice::OVH::Email::Domain::Domain::Redirection

- Synopsis: my $service = $email_domain->redirection(12345);

## new_redirection

Creates a new redirection.

- Parameter: %params - key => value from to local_copy

- Return: Webservice::Email::Domain::Domain::Redirection

- Synopsis: my $redirection = $email_domain->new_redirection(from => 'test@test.de', to => 'test2@test.de', local_copy => 'false');

## accounts

Produces an array of all available accounts that are connected to the email-domain.

- Return: ARRAY

- Synopsis: my $accounts = $email_domain->accounts();

## account

Returns a single account by name

- Parameter: $account_name - name

- Return: Webservice::OVH::Email::Domain::Domain::Account

- Synopsis: my $account = $email_domain->account('testaccount');

## new_account

Creates a new account.

- Parameter: %params - key => value account_name password description size

- Return: Webservice::Email::Domain::Domain::Account

- Synopsis: my $account = $email_domain->new_account(account_name => 'testaccount', password => $password, description => 'a test account', size => 5000000 );

## mailing_lists

Produces an array of all available mailing_lists that are connected to the email-domain.

- Return: ARRAY

- Synopsis: my $mailing_lists = $email_domain->mailing_lists();

## mailing_list

Returns a single account by name

- Parameter: $mailing_list_name - name

- Return: Webservice::OVH::Email::Domain::Domain::MailingList

- Synopsis: my $mailing_list = $email_domain->mailing_list('subscriber_list');

## new_mailing_list

Creates a new mailing list.

- Parameter: %params - key => value language name options owner_email reply_to

- Return: Webservice::Email::Domain::Domain::MailingList

- Synopsis: my $mailing_list = $email_domain->new_mailing_list(language 'DE', name => 'infos', options => {}, owner_email => 'owner@test.de', reply_to => 'test@test.de' );