aboutsummaryrefslogtreecommitdiff
path: root/lib/Sietima/Role/Headers.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/Sietima/Role/Headers.pm')
-rw-r--r--lib/Sietima/Role/Headers.pm25
1 files changed, 21 insertions, 4 deletions
diff --git a/lib/Sietima/Role/Headers.pm b/lib/Sietima/Role/Headers.pm
index 5ab0d58..794a5e9 100644
--- a/lib/Sietima/Role/Headers.pm
+++ b/lib/Sietima/Role/Headers.pm
@@ -32,10 +32,27 @@ $self->list_addresses->{return_path} >> value (which is normally the
same as the L<< C<return_path>|Sietima/return_path >> attribute).
Other C<List-*:> headers are built from the other values in the
-C<list_addresses> hashref. Those values can either be L<<
-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).
+C<list_addresses> hashref. Each of those values can be:
+
+=begin :list
+
+* an L<< C<Sietima::HeaderURI> >> object
+
+* a thing that can be passed to that class's constructor:
+
+=for :list
+* an L<< C<Email::Address> >> object
+* a L<< C<URI> >> object
+* a string parseable as either
+
+* an arrayref containing any mix of the above
+
+=end :list
+
+As a special case, if C<< $self->list_addresses->{post} >> exists and
+is false, the C<List-Post> header will have the value C<NO> to
+indicate that the list does not accept incoming messages (e.g. it's an
+announcement list).
=attr C<name>