diff options
author | dakkar <dakkar@thenautilus.net> | 2017-02-07 19:59:04 +0000 |
---|---|---|
committer | dakkar <dakkar@thenautilus.net> | 2017-02-07 19:59:04 +0000 |
commit | 4a90832ad9b1436dce84e3ac0d8cb67a8fb33102 (patch) | |
tree | 6ab7e449555ce75fef2fc5befe62cd88595cbbda /lib/Sietima/Role | |
parent | POD for ::MailStore::FS (diff) | |
download | Sietima-4a90832ad9b1436dce84e3ac0d8cb67a8fb33102.tar.gz Sietima-4a90832ad9b1436dce84e3ac0d8cb67a8fb33102.tar.bz2 Sietima-4a90832ad9b1436dce84e3ac0d8cb67a8fb33102.zip |
use more Pod::Weaver
Diffstat (limited to 'lib/Sietima/Role')
-rw-r--r-- | lib/Sietima/Role/AvoidDups.pm | 4 | ||||
-rw-r--r-- | lib/Sietima/Role/Debounce.pm | 4 | ||||
-rw-r--r-- | lib/Sietima/Role/Headers.pm | 8 | ||||
-rw-r--r-- | lib/Sietima/Role/NoMail.pm | 4 | ||||
-rw-r--r-- | lib/Sietima/Role/ReplyTo.pm | 8 | ||||
-rw-r--r-- | lib/Sietima/Role/SubjectTag.pm | 8 | ||||
-rw-r--r-- | lib/Sietima/Role/SubscriberOnly.pm | 12 | ||||
-rw-r--r-- | lib/Sietima/Role/SubscriberOnly/Drop.pm | 4 | ||||
-rw-r--r-- | lib/Sietima/Role/SubscriberOnly/Moderate.pm | 16 | ||||
-rw-r--r-- | lib/Sietima/Role/WithMailStore.pm | 4 | ||||
-rw-r--r-- | lib/Sietima/Role/WithOwner.pm | 4 | ||||
-rw-r--r-- | lib/Sietima/Role/WithPostAddress.pm | 4 |
12 files changed, 22 insertions, 58 deletions
diff --git a/lib/Sietima/Role/AvoidDups.pm b/lib/Sietima/Role/AvoidDups.pm index c6a5cdd..e0a5bae 100644 --- a/lib/Sietima/Role/AvoidDups.pm +++ b/lib/Sietima/Role/AvoidDups.pm @@ -18,9 +18,7 @@ message to a subscriber, if that subscriber is already mentioned in the C<To:> or C<Cc:> header fields, because they can be assumed to be already receiving the message directly from the sender. -=head1 MODIFIED METHODS - -=head2 C<subscribers_to_send_to> +=modif C<subscribers_to_send_to> Filters out subscribers that L<match|Sietima::Subscriber/match> the addresses in the C<To:> or C<Cc:> headers of the incoming email. diff --git a/lib/Sietima/Role/Debounce.pm b/lib/Sietima/Role/Debounce.pm index b128422..e6bd087 100644 --- a/lib/Sietima/Role/Debounce.pm +++ b/lib/Sietima/Role/Debounce.pm @@ -18,9 +18,7 @@ have that same header. This prevents messages bounced by other services from being looped between the mailing list and those other services. -=head1 MODIFIED METHODS - -=head2 C<munge_mail> +=modif C<munge_mail> If the incoming email contains our C<X-Been-There:> header, this method will return an empty list (essentially dropping the message). diff --git a/lib/Sietima/Role/Headers.pm b/lib/Sietima/Role/Headers.pm index 320ab93..92a24f7 100644 --- a/lib/Sietima/Role/Headers.pm +++ b/lib/Sietima/Role/Headers.pm @@ -34,9 +34,7 @@ C<Email::Address> >> objects (in which case the header will have a C<mailto:> URI as value) or strings (which will be used literally for the value of the header). -=head1 ATTRIBUTES - -=head2 C<name> +=attr C<name> Optional string, the name of the mailing list. If this attribute is set, a C<List-Id:> header will be added, with a value built out of the @@ -88,9 +86,7 @@ sub _add_headers_to($self,$message) { return; } -=head1 MODIFIED METHODS - -=head2 C<munge_mail> +=modif C<munge_mail> This method adds list-management headers to each message returned by the original method. diff --git a/lib/Sietima/Role/NoMail.pm b/lib/Sietima/Role/NoMail.pm index 2d129a8..10071d6 100644 --- a/lib/Sietima/Role/NoMail.pm +++ b/lib/Sietima/Role/NoMail.pm @@ -22,9 +22,7 @@ A L<< C<Sietima> >> list with this role applied will not send messages to subscribers that have the C<wants_mail> preference set to a false value. -=head1 MODIFIED METHODS - -=head2 C<subscribers_to_send_to> +=modif C<subscribers_to_send_to> Filters out subscribers that have the C<wants_mail> preference set to a false value. diff --git a/lib/Sietima/Role/ReplyTo.pm b/lib/Sietima/Role/ReplyTo.pm index 1e10420..6b21f20 100644 --- a/lib/Sietima/Role/ReplyTo.pm +++ b/lib/Sietima/Role/ReplyTo.pm @@ -40,9 +40,7 @@ C<WithPostAddress>|Sietima::Role::WithPostAddress >>. with 'Sietima::Role::WithPostAddress'; -=head1 ATTRIBUTES - -=head2 C<munge_reply_to> +=attr C<munge_reply_to> Optional boolean, defaults to false. If set to a true value, all messages will have their C<Reply-To:> header set to the value of the @@ -57,9 +55,7 @@ has munge_reply_to => ( default => 0, ); -=head1 MODIFIED METHODS - -=head2 C<munge_mail> +=modif C<munge_mail> For each message returned by the original method, this method partitions the subscribers, who are recipients of the message, diff --git a/lib/Sietima/Role/SubjectTag.pm b/lib/Sietima/Role/SubjectTag.pm index dd72562..7602405 100644 --- a/lib/Sietima/Role/SubjectTag.pm +++ b/lib/Sietima/Role/SubjectTag.pm @@ -19,9 +19,7 @@ use namespace::clean; A L<< C<Sietima> >> list with this role applied will prepend the given tag to every outgoing message's C<Subject:> header. -=head1 ATTRIBUTES - -=head2 C<subject_tag> +=attr C<subject_tag> Required string. This string, enclosed by square brackets, will be prepended to the C<Subject:> header of outgoing messages. For example, @@ -40,9 +38,7 @@ has subject_tag => ( required => 1, ); -=head1 MODIFIED METHODS - -=head2 C<munge_mail> +=modif C<munge_mail> The subject of the incoming email is modified to add the tag (unless it's already there). The email is then processed normally. diff --git a/lib/Sietima/Role/SubscriberOnly.pm b/lib/Sietima/Role/SubscriberOnly.pm index d2edf6b..6524d39 100644 --- a/lib/Sietima/Role/SubscriberOnly.pm +++ b/lib/Sietima/Role/SubscriberOnly.pm @@ -29,9 +29,7 @@ with messages from non-subscribers. See L<< C<Sietima::Role::SubscriberOnly::Drop> >> and L<< C<Sietima::Role::SubscriberOnly::Moderate> >> for useable roles. -=head1 REQUIRED METHODS - -=head2 C<munge_mail_from_non_subscriber> +=require C<munge_mail_from_non_subscriber> sub munge_mail_from_non_subscriber($self,$mail) { ... } @@ -48,9 +46,7 @@ requires 'munge_mail_from_non_subscriber'; our $let_it_pass=0; ## no critic(ProhibitPackageVars) -=head1 MODIFIED METHODS - -=head2 C<munge_mail> +=modif C<munge_mail> If the incoming email's C<From:> header contains an address that L<matches|Sietima::Subscriber/match> any of the subscribers, the email @@ -70,9 +66,7 @@ around munge_mail => sub ($orig,$self,$mail) { } }; -=head1 METHODS - -=head2 C<ignoring_subscriberonly> +=method C<ignoring_subscriberonly> $sietima->ignoring_subscriberonly(sub($s) { $s->handle_mail($mail); diff --git a/lib/Sietima/Role/SubscriberOnly/Drop.pm b/lib/Sietima/Role/SubscriberOnly/Drop.pm index dea742b..d9de94e 100644 --- a/lib/Sietima/Role/SubscriberOnly/Drop.pm +++ b/lib/Sietima/Role/SubscriberOnly/Drop.pm @@ -25,9 +25,7 @@ C<SubscribersOnly>|Sietima::Role::SubscriberOnly >>. with 'Sietima::Role::SubscriberOnly'; -=head1 METHODS - -=head2 C<munge_mail_from_non_subscriber> +=method C<munge_mail_from_non_subscriber> Does nothing, returns an empty list. diff --git a/lib/Sietima/Role/SubscriberOnly/Moderate.pm b/lib/Sietima/Role/SubscriberOnly/Moderate.pm index 13bc541..c4d62c9 100644 --- a/lib/Sietima/Role/SubscriberOnly/Moderate.pm +++ b/lib/Sietima/Role/SubscriberOnly/Moderate.pm @@ -38,9 +38,7 @@ with 'Sietima::Role::SubscriberOnly', 'Sietima::Role::WithMailStore', 'Sietima::Role::WithOwner'; -=head1 METHODS - -=head2 C<munge_mail_from_non_subscriber> +=method C<munge_mail_from_non_subscriber> L<Stores|Sietima::MailStore/store> the email with the C<moderation> tag, and forwards it to the L<list @@ -69,7 +67,7 @@ sub munge_mail_from_non_subscriber ($self,$mail) { return; } -=head2 C<resume> +=method C<resume> $sietima->resume($mail_id); @@ -89,7 +87,7 @@ sub resume ($self,$mail_id) { $self->mail_store->remove($mail_id); } -=head2 C<drop> +=method C<drop> $sietima->drop($mail_id); @@ -102,7 +100,7 @@ sub drop ($self,$mail_id) { $self->mail_store->remove($mail_id); } -=head2 C<list_mails_in_moderation_queue> +=method C<list_mails_in_moderation_queue> $sietima->list_mails_in_moderation_queue($sietima_runner); @@ -129,7 +127,7 @@ sub list_mails_in_moderation_queue ($self,$runner,@) { } } -=head2 C<show_mail_from_moderation_queue> +=method C<show_mail_from_moderation_queue> $sietima->show_mail_from_moderation_queue($sietima_runner); @@ -149,9 +147,7 @@ sub show_mail_from_moderation_queue ($self,$runner,@) { $runner->out($mail->as_string =~ s{\r\n}{\n}gr); } -=head1 MODIFIED METHODS - -=head2 C<command_line_spec> +=modif C<command_line_spec> This method adds the following sub-commands for the command line: diff --git a/lib/Sietima/Role/WithMailStore.pm b/lib/Sietima/Role/WithMailStore.pm index e139965..7ca4b4e 100644 --- a/lib/Sietima/Role/WithMailStore.pm +++ b/lib/Sietima/Role/WithMailStore.pm @@ -25,9 +25,7 @@ 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 object that can persistently store messages. -=head1 ATTRIBUTES - -=head2 C<mail_store> +=attr C<mail_store> Required instance of an object that consumes the L<< C<Sietima::MailStore> >> role. Instead of passing an instance, you can diff --git a/lib/Sietima/Role/WithOwner.pm b/lib/Sietima/Role/WithOwner.pm index 0677f90..5a11d05 100644 --- a/lib/Sietima/Role/WithOwner.pm +++ b/lib/Sietima/Role/WithOwner.pm @@ -23,9 +23,7 @@ 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. -=head1 ATTRIBUTES - -=head2 C<owner> +=attr C<owner> Required instance of L<< C<Email::Address> >>, coercible from a string. This is the address of the owner of the list. diff --git a/lib/Sietima/Role/WithPostAddress.pm b/lib/Sietima/Role/WithPostAddress.pm index daa483a..333c5e3 100644 --- a/lib/Sietima/Role/WithPostAddress.pm +++ b/lib/Sietima/Role/WithPostAddress.pm @@ -24,9 +24,7 @@ On its own, this role is not very useful, but other roles (like L<< C<ReplyTo>|Sietima::Role::ReplyTo >>) can have uses for a post address. -=head1 ATTRIBUTES - -=head2 C<post_address> +=attr C<post_address> An L<< C<Email::Address> >> object, defaults to the value of the L<< C<return_path>|Sietima/return_path >> attribute. This is the address |