NAME

API::MailboxOrg::API::Mail - MailboxOrg::API::Mail

VERSION

version 1.0.2

SYNOPSIS

use API::MailboxOrg;

my $user     = '1234abc';
my $password = '1234abc';

my $api      = API::MailboxOrg->new(
    user     => $user,
    password => $password,
);

METHODS

add

Adds an e-mail address

Available for admin, account, domain

Parameters:

  • mail

  • password

  • password_hash

  • plan

  • additional_mail_quota

  • additional_cloud_quota

  • first_name

  • last_name

  • inboxsave

  • forwards

  • memo

  • catchall

  • create_own_context

  • title

  • birthday

  • position

  • department

  • company

  • street

  • postal_code

  • city

  • phone

  • fax

  • cell_phone

  • recover

  • skip_welcome_mail

returns: array

$api->mail->add(%params);

del

Deletes an e-mail address

Available for admin, reseller, account, domain

Parameters:

  • mail

returns: boolean

$api->mail->del(%params);

get

Returns e-mail address details

Available for admin, reseller, account, domain, mail

Parameters:

  • mail

returns: array

$api->mail->get(%params);

list

Returns a list of e-mail addresses + configuration information

Available for admin, reseller, account, domain

Parameters:

  • domain

returns: array

$api->mail->list(%params);

register

Adds an e-mail address (using a predefined token)

Parameters:

  • token

  • mail

  • password

  • alternate_mail

  • first_name

  • last_name

  • lang

returns: boolean

$api->mail->register(%params);

set

Modifies e-mail address properties

Available for admin, reseller, account, domain, mail, domain

Parameters:

  • mail

  • password

  • password_hash

  • plan

  • additional_mail_quota

  • additional_cloud_quota

  • first_name

  • last_name

  • inboxsave

  • forwards

  • aliases

  • alternate_mail

  • memo

  • active

  • title

  • birthday

  • position

  • department

  • company

  • street

  • postal_code

  • city

  • phone

  • fax

  • cell_phone

returns: array

$api->mail->set(%params);

AUTHOR

Renee Baecker <reneeb@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2022 by Renee Baecker.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)