WebService :: MIAB - MIAB (Mail in a Box) helps you manage user and aliasaddressen
version 0.01
use WebService::MIAB;
my $MIAB = WebService::MIAB->new( username => 'Email@domain.com', pass => 'ThisIsThePassword', host => 'example.com', );
my $users = $MIAB->get_users(); my $result = $MIAB->create_user( { email => 'bart.simpson@springfield.com', password => 'EatMyShorts', });
WebService::MIAB is a Perl module that manages user and alias addresses from the mail server MIAB (Mail in a Box). The module is based on the WebService::Client module that is written from Naveed Massjouni. You can list, create and remove user and alias addresses.
The get_user function returns all users which are defined in JSON format. The function only need the Uri for gets the Users. MIAB->get_user()
sub get_users{ my ($self) = @_; my $result = $self->get($self->user_get_uri); return $result; }
The create_user function create a new User. The function receives the parameters email and password in form of a hash reference for creating an user. The create_user function consists only a post command that create the user. $MIAB->create_user(email => 'bart.simpson@springfield.com',password => 'EatMyShorts')
sub create_user{ my ($self,$param) = @_; my $result = $self->post($self->user_add_uri, { email => $param->{email}, password => $param->{password}, }, headers => { 'Content-Type' => 'application/x-www-form-urlencoded' }, ); return $result; }
The remove_user function delete a User. The function receives the parameters email in form of a hash reference for deleting an user. The remove_user function consists only a post command that delete an user. $MIAB->remove_user(email => bart.simpson@springfield.com)
sub remove_user{ my ($self, $param) = @_; my $result = $self->post($self->user_remove_uri, { email => $param->{email}, }, headers => { 'Content-Type' => 'application/x-www-form-urlencoded' }, ); return $result; }
The find_user function search an user. The function receives the parameters E-Mail and Domain to search the user. The function is_regexp checks if the given parameter are a regular expression. The function gets with get_users () all users that are present and then filters them according to the passed parameters. $MIAB->remove_user(email => bart.simpson@springfield.com)
sub find_user { my ($self, $email_pattern, $domain_pattern) = @_; my @result; if ( !is_regexp($email_pattern) ) { $email_pattern = qr/$email_pattern/mxs; } if ($domain_pattern && !is_regexp($domain_pattern)) { $domain_pattern = qr/$domain_pattern/mxs; }
my $users = $self->get_users(); foreach ( @{$users} ) { if (!$domain_pattern || $_->{'domain'} =~ $domain_pattern) { foreach (@{$_->{'users'}}) { my $value = $_->{'email'}; # filter list push( @result, grep { $_ && $_ =~ $email_pattern } ($value && 'ARRAY' eq ref $value) ? @{$value} : ( $value ) ); } } } return @result; }
The get_aliases function returns all Aliasaddresses for all domains which exist in Json format. $MIAB->get_aliases()
sub get_aliases{ my ($self) = @_; my $result = $self->get($self->alias_get_uri); return $result; }
The get_domains function returns all Domains which are defined. $MIAB->get_domains()
sub get_domains{ my ($self) = @_; my $aliases = $self->get_aliases(); my @result; map { push( @result, $_->{'domain'} ); } @{$aliases}; return @result; }
The function receives the parameters alias_pattern and domain_pattern. The find_forward_to_aliases function contains only one function call and a transfer of parameters MIAB->find_forward_to_aliases($alias_pattern, $domain_pattern)
sub find_forward_to_aliases { my ($self, $alias_pattern, $domain_pattern) = @_; return $self->_find_aliases_generic('forwards_to', $alias_pattern, $domain_pattern); }
The function receives the parameters alias_pattern and domain_pattern. The find_permitted_sender_aliases function contains only one function call and a transfer of parameters MIAB->find_permitted_sender_aliases($alias_pattern, $domain_pattern)
sub find_permitted_sender_aliases { my ($self, $alias_pattern, $domain_pattern) = @_; return $self->_find_aliases_generic('permitted_senders', $alias_pattern, $domain_pattern); }
The function receives the parameters alias_pattern and domain_pattern. The find_aliases function contains only one function call and a transfer of parameters MIAB->find_aliases($alias_pattern, $domain_pattern)
sub find_aliases { my ($self, $alias_pattern, $domain_pattern) = @_; return $self->_find_aliases_generic('address', $alias_pattern, $domain_pattern); }
The create_alias function create a new Aliasaddress. The function receives the parameters address and forwards_to or permitted_senders in form of a hash reference for create a Aliasaddress. The create_alias function consists a post command that create the Aliasaddress. $param = { address => 'bart.simpson@springfield.com', forwards_to => ['lisa.simpson@springfield.com','Maggie.simpson@springfield.com'], # One of permitted_senders => ['Homer.simpson@springfield.com','Marge.simpson@springfield.com'], # these }; $MIAB->create_alias($param);
sub create_alias{ my ($self,$param) = @_; my $empty = q{}; my $point = q{,}; # Parameters normalizee if (defined $param->{forwards_to} && ref $param->{forwards_to} ne 'ARRAY') { $param->{forwards_to} = [$param->{forwards_to}]; } if (defined $param->{permitted_senders} && ref $param->{permitted_senders} ne 'ARRAY') { $param->{permitted_senders} = [$param->{permitted_senders}]; } # Rest-Interface Paramter generieren my $forward_address_for_request = defined $param->{forwards_to} ? join ($point, @{$param->{forwards_to}}) : $empty; my $permittet_senders_for_request = defined $param->{permitted_senders} ? join ($point, @{$param->{permitted_senders}}) : $empty;
# At least one alias parameter must exist if(!length($forward_address_for_request.$permittet_senders_for_request)) { croak 'forwardsaddress and permitted_sender are required'; } my $result = $self->post($self->alias_add_uri, { address => $param->{address}, forwards_to => $forward_address_for_request, permitted_senders => $permittet_senders_for_request, }, headers => { 'Content-Type' => 'application/x-www-form-urlencoded' }, ); return $result; }
The remove_alias function delete a Aliasaddress. The function gets in form of a hash reference the parameter address for delete a Aliasaddress. The remove_alias function consists only a post command that delete a Aliasaddress. $MIAB->remove_alias(address => bart.simpson@springfield.com)
sub remove_alias{ my ($self, $param) = @_; my $result = $self->post($self->alias_remove_uri, { address => $param->{address}, }, headers => { 'Content-Type' => 'application/x-www-form-urlencoded' } ); return $result; }
Alexander Schneider, <alexander.schneider at minati.de>
<alexander.schneider at minati.de>
Please report any bugs or feature requests to bug-webservice-miab at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebService-MIAB. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-webservice-miab at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc WebService::MIAB
You can also look for information at:
RT: CPAN's request tracker (report bugs here)
http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-MIAB
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/WebService-MIAB
CPAN Ratings
http://cpanratings.perl.org/d/WebService-MIAB
Search CPAN
http://search.cpan.org/dist/WebService-MIAB/
Copyright 2018 Alexander Schneider.
This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:
http://www.perlfoundation.org/artistic_license_2_0
Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
To install WebService::MIAB, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WebService::MIAB
CPAN shell
perl -MCPAN -e shell install WebService::MIAB
For more information on module installation, please visit the detailed CPAN module installation guide.