NAME

Sietima::Subscriber - a subscriber to a mailing list

VERSION

version 1.0.3

DESCRIPTION

This class holds the primary email address for a mailing list subscriber, together with possible aliases and preferences.

ATTRIBUTES

All attributes are read-only.

primary

Required Email::Address object, coercible from a string.

This is the primary address for the subscriber, the one where they will receive messages from the mailing list.

aliases

Arrayref of Email::Address objects, each coercible from a string. Defaults to an empty arrayref.

These are secondary addresses that the subscriber may write from. Subscriber-only mailing lists should accept messages from any of these addresses as if they were from the primary. The "match" simplifies that task.

prefs

A hashref. Various preferences that may be interpreted by Sietima roles. Defaults to an empty hashref.

METHODS

match

if ($subscriber->match($address)) { ... }

Given a Email::Address object (or a string), this method returns true if the address is equivalent to the "primary" or any of the "aliases".

This method should be used to determine whether an address belongs to a subscriber.

address

name

original

These methods delegate to Email::Address's methods of the same name, invoked on the primary address.

AUTHOR

Gianni Ceccarelli <dakkar@thenautilus.net>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Gianni Ceccarelli <dakkar@thenautilus.net>.

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