Source code for abstract_api.email_validation.email_validation

from typing import ClassVar, Optional

from ..core.bases import BaseService
from .email_validation_response import EmailValidationResponse




class EmailValidation(BaseService[EmailValidationResponse]):
    """AbstractAPI email validation and verification service.

    Used to validate and verify an email address.

    Attributes:
        _subdomain: Email validation service subdomain.
    """
    _subdomain = "emailvalidation"
    _service_name_env_var: ClassVar[str] = "EMAIL_VALIDATION"



    def check(
        self,
        email: str,
        auto_correct: Optional[bool] = False
    ) -> EmailValidationResponse:
        """Validates and verifies an email address.

        Args:
            email: An email address to be validated and verified.
            auto_correct: Whether the given email address should be
                autocorrected and returned in API response.

        Returns:
            EmailValidationResponse representing API call response.
        """
        return self._service_request(
            _response_class=EmailValidationResponse,
            email=email,
            auto_correct=auto_correct
        )