Sietima::Subscriber - a subscriber to a mailing list
version 1.0.0
This class holds the primary email address for a mailing list subscriber, together with possible aliases and preferences.
All attributes are read-only.
primary
Required Email::Address object, coercible from a string.
Email::Address
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.
match
prefs
A hashref. Various preferences that may be interpreted by Sietima roles. Defaults to an empty hashref.
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.
Gianni Ceccarelli <dakkar@thenautilus.net>
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.
To install Sietima, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Sietima
CPAN shell
perl -MCPAN -e shell install Sietima
For more information on module installation, please visit the detailed CPAN module installation guide.