NAME

Value::Object::EmailAddressCommon - A value object representing a valid email address.

VERSION

This document describes Value::Object::EmailAddressCommon version 0.11

SYNOPSIS

    use Value::Object::EmailAddressCommon;

    my $email = Value::Object::EmailAddressCommon->new( 'webmaster@example.com' );
    my $me    = Value::Object::EmailAddressCommon->new( 'gwadej@cpan.org' );

DESCRIPTION

A Value::Object::EmailAddressCommon value object represents a valid common email address. That email address may not represent an address that can actually receive an email, but the form of the address is at least valid.

The only difference between the common email address and the specification of the email address as given by RFC 5322 is that the common email address only supports the dotted form. In many practical applications, programmers do not seem to support the quoted email form. This Value class handles those cases.

INTERFACE

Value::Object::EmailAddressCommon->new( $emailstr )

Create a value object if the supplied $emailstr validates according to RFC 5322. Otherwise throw an exception.

Value::Object::EmailAddressCommon->new_canonical( $emailstr )

Create a value object if the supplied $emailstr validates according to RFC 5322. Otherwise throw an exception.

Unlike the new method, the ASCII characters of the domain portion of the supplied $emailstr are lowercased before the email address is created. The canonical version of the domain is always lowercase.

$email->value()

Return a string matching the full email address of the Value object.

$email->local_part()

Return a string matching the local part of the Value object.

$email->domain()

Return a Value::Object::Domain object representing the domain portion of the Value object.

CONFIGURATION AND ENVIRONMENT

Value::Object::EmailAddressCommon requires no configuration files or environment variables.

DEPENDENCIES

parent

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-value-object@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

G. Wade Johnson gwadej@cpan.org

LICENCE AND COPYRIGHT

Copyright (c) 2014, G. Wade Johnson gwadej@cpan.org. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

cpanm Value::Object

perl -MCPAN -e shell
install Value::Object