doc: extended documentation.
# -*- coding: UTF-8 -*-
# Copyright (c) 2008 - 2010, Pascal Volk
# See COPYING for distribution information.
"""
VirtualMailManager.EmailAddress
Virtual Mail Manager's EmailAddress class to handle e-mail addresses.
"""
from VirtualMailManager import check_domainname, check_localpart
from VirtualMailManager.constants.ERROR import \
DOMAIN_NO_NAME, INVALID_ADDRESS, LOCALPART_INVALID
from VirtualMailManager.Exceptions import VMMEmailAddressException as VMMEAE
_ = lambda msg: msg
class EmailAddress(object):
"""Simple class for validated e-mail addresses."""
__slots__ = ('_localpart', '_domainname')
def __init__(self, address):
"""Creates a new instance from the string/unicode ``address``."""
if not isinstance(address, basestring):
raise TypeError('address is not a str/unicode object: %r' %
address)
self._localpart = None
self._domainname = None
self._chk_address(address)
@property
def localpart(self):
"""The local-part of the address *local-part@domain*"""
return self._localpart
@property
def domainname(self):
"""The domain part of the address *local-part@domain*"""
return self._domainname
def __eq__(self, other):
if isinstance(other, self.__class__):
return self._localpart == other.localpart and \
self._domainname == other.domainname
return NotImplemented
def __ne__(self, other):
if isinstance(other, self.__class__):
return self._localpart != other.localpart or \
self._domainname != other.domainname
return NotImplemented
def __repr__(self):
return "EmailAddress('%s@%s')" % (self._localpart, self._domainname)
def __str__(self):
return '%s@%s' % (self._localpart, self._domainname)
def _chk_address(self, address):
"""Checks if the string ``address`` could be used for an e-mail
address. If so, it will assign the corresponding values to the
attributes `_localpart` and `_domainname`."""
parts = address.split('@')
p_len = len(parts)
if p_len < 2:
raise VMMEAE(_(u"Missing the '@' sign in address %r") % address,
INVALID_ADDRESS)
elif p_len > 2:
raise VMMEAE(_(u"Too many '@' signs in address %r") % address,
INVALID_ADDRESS)
if not parts[0]:
raise VMMEAE(_(u"Missing local-part in address %r") % address,
LOCALPART_INVALID)
if not parts[1]:
raise VMMEAE(_(u"Missing domain name in address %r") % address,
DOMAIN_NO_NAME)
self._localpart = check_localpart(parts[0])
self._domainname = check_domainname(parts[1])
del _