1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
# Copyright © 2025 Guillem Jover <guillem@debian.org>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
=encoding utf8
=head1 NAME
Dpkg::Email::Address - manage an email address
=head1 DESCRIPTION
It provides a class which is able to manage an email address,
as used in L<deb822(5)> data.
=cut
package Dpkg::Email::Address 0.01;
use v5.36;
use Exporter qw(import);
use Dpkg::Gettext;
use Dpkg::ErrorHandling;
use overload
'""' => sub { return $_[0]->as_string(); };
my $addr_name_regex = qr{
# Composed of possibly multiple quoted and not-quoted parts.
(?:
# Either non-quoted name, without comma.
[^<>"\cK,]+
|
# Or quoted name, with optional comma.
" [^<>"\cK]+ "
)*
}x;
my $addr_email_regex = qr{
# Local part.
[^@<>"\s\cK]+
# Separator.
@
# Domain part.
[^@<>"\s\cK]+
}x;
my $addr_regex = qr{
\s*
# Address name.
(
$addr_name_regex
)
# Separated by at least one space.
\s+
# Address email in angle brackets.
<
(
$addr_email_regex
)
>
\s*
}x;
=head1 FUNCTIONS
=over 4
=item $regex = REGEX()
Returns the regex used to parse and validate an email address.
It matches two parts, the name and the email.
=cut
sub REGEX()
{
return $addr_regex;
}
=back
=head1 METHODS
=over 4
=item $addr = Dpkg::Email::Address->new($string)
Create a new object that can hold an email address.
=cut
sub new($this, $str = undef)
{
my $class = ref($this) || $this;
my $self = {};
bless $self, $class;
$self->parse($str) if defined $str;
return $self;
}
=item $bool = $addr->is_valid()
Check whether the current object contains a valid email address.
=cut
sub is_valid($self)
{
return defined $self->{name} && defined $self->{email};
}
=item $name = $addr->name([$name])
Get and optionally set the email address name.
Returns the current or new email name.
=cut
sub name($self, $name = undef)
{
$self->{name} = $name if defined $name;
return $self->{name};
}
=item $email = $addr->email([$email])
Get and optionally set the email address email.
Returns the current or new email.
=cut
sub email($self, $email = undef)
{
$self->{email} = $email if defined $email;
return $self->{email};
}
=item $bool = $addr->parse($string)
Parses $string into the current object replacing the current address.
Returns true if an email could be parsed, otherwise false.
=cut
sub parse($self, $str)
{
if ($str =~ m{^$addr_regex$}) {
$self->{name} = $1;
$self->{email} = $2;
return 1;
}
warning("cannot parse email address '$str'");
return 0;
}
=item $string = $addr->as_string()
Returns the email address formatted as a string.
=cut
sub as_string($self)
{
return "$self->{name} <$self->{email}>";
}
=item $hashref = $addr->as_struct()
Returns the email address in a hashref with name and email keys.
=cut
sub as_struct($self)
{
return {
name => $self->{name},
email => $self->{email},
};
}
=back
=head1 CHANGES
=head2 Version 0.xx
This is a private module.
=cut
1;
|
