summaryrefslogtreecommitdiff
path: root/lib/Net/Plesk/Method/mail_remove.pm
blob: 49804abc587ab0a6226f30a277d8c2f35e9e2d81 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
package Net::Plesk::Method::mail_remove;

use strict;

use vars qw( $VERSION @ISA $AUTOLOAD $DEBUG );

@ISA = qw( Net::Plesk::Method );
$VERSION = '0.01';

$DEBUG = 0;

=head1 NAME

Net::Plesk::Method::mail_remove - Perl extension for Plesk XML Remote API mail removal

=head1 SYNOPSIS

  use Net::Plesk::Method::mail_remove

  my $p =
    new Net::Plesk::Method::mail_remove ( $domainID, $mailbox );

  $request = $p->endcode;

=head1 DESCRIPTION

This module implements an interface to construct a request for a mailbox
removal using SWSOFT's Plesk.

=head1 METHODS

=over 4

=item init args ...

Initializes a Plesk mail_remove object.  The I<domainID> and I<mailbox>
options are required.

=cut

sub init {
  my ($self, $domainid, $mailbox ) = @_;
  $$self = join ( "\n", (
	            '<mail>',
	            '<remove>',
	            '<filter>',
	            '<domain_id>',
	            $self->encode($domainid),
	            '</domain_id>',
	            '<name>',
	            $self->encode($mailbox),
	            '</name>',
	            '</filter>',
	            '</remove>',
	            '</mail>',
	          ));
}

=back

=head1 BUGS

  Creepy crawlies.

=head1 SEE ALSO

SWSOFT Plesk Remote API documentation (1.4.0.0 or later)

=head1 AUTHOR

Jeff Finucane E<lt>jeff@cmh.netE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2006 Jeff Finucane

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=cut

1;