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/MailStore.pm | |
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/MailStore.pm')
-rw-r--r-- | lib/Sietima/MailStore.pm | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/lib/Sietima/MailStore.pm b/lib/Sietima/MailStore.pm index c529e3e..5e6fc7f 100644 --- a/lib/Sietima/MailStore.pm +++ b/lib/Sietima/MailStore.pm @@ -11,9 +11,7 @@ use namespace::clean; This role defines the interface that all mail stores must adhere to. It does not provide any implementation. -=head1 REQUIRED METHODS - -=head2 C<store> +=require C<store> my $id = $ms->store($email_mime_object,@tags); @@ -23,7 +21,7 @@ tags (which must be strings). Must return a unique identifier for the stored message. It is acceptable if identical messages are indistinguishable by the storage. -=head2 C<retrieve_by_id> +=require C<retrieve_by_id> my $email_mime_object = $ms->retrieve_by_id($id); @@ -34,7 +32,7 @@ C<Email::MIME> >> object). If the message has been deleted, or the identifier is not recognised, this method must return C<undef> in scalar context. -=head2 C<retrieve_ids_by_tags> +=require C<retrieve_ids_by_tags> my @ids = $ms->retrieve_ids_by_tags(@tags)->@*; @@ -57,7 +55,7 @@ For example: $ms->retrieve_ids_by_tags('t1','t2') ==> [ $id3 ] $ms->retrieve_ids_by_tags('t3') ==> [ ] -=head2 C<retrieve_by_tags> +=require C<retrieve_by_tags> my @email_mime_objects = $ms->retrieve_by_tags(@tags)->@*; @@ -73,7 +71,7 @@ return an arrayref of hashrefs. For example: { id => $id1, mail => $msg1 }, ] -=head2 C<remove> +=require C<remove> $ms->remove($id); @@ -81,7 +79,7 @@ This method must remove the message corresponding to the given identifier from the persistent storage. Removing a non-existent message must succeed, and do nothing. -=head2 C<clear> +=require C<clear> $ms->clear(); |