lib/Sietima/Role/WithOwner.pm


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

package Sietima::Role::WithOwner; 
use Moo::Role;
use Sietima::Policy;
use Sietima::Types qw(Address AddressFromStr);
use namespace::clean;
 
# VERSION 
# ABSTRACT: role for lists with an owner 
 
=head1 SYNOPSIS
 
  my $sietima = Sietima->with_traits('WithOwner')->new({
    %args,
    owner => 'listmaster@example.com',
  });
 
=head1 DESCRIPTION
 
This role adds an L<< /C<owner> >> attribute, and exposes it via the
L<< C<list_addresses>|Sietima/list_addresses >> method.
 
On its own, this role is not very useful, but other roles (like L<<
C<SubscriberOnly::Moderate>|Sietima::Role::SubscriberOnly::Moderate
>>) can have uses for an owner address.
 
=attr C<owner>
 
Required instance of L<< C<Email::Address> >>, coercible from a
string. This is the address of the owner of the list.
 
=cut
 
has owner => (
    is => 'ro',
    isa => Address,
    required => 1,
    coerce => AddressFromStr,
);
 
=modif C<list_addresses>
 
This method declares the C<owner> address.
 
=cut
 
around list_addresses => sub($orig,$self) {
    return +{
        $self->$orig->%*,
        owner => $self->owner,
    };
};
 
1;