Class EmailConfig

keepercommander/email_service.py:151–284

Email configuration for sending emails via various providers. Stored as Keeper records (login type) with encrypted credentials. See ADR Decision 1 in ONBOARDING_FEATURE_IMPLEMENTATION_PLAN.md Supported providers: - smtp: Standard SMTP with username/password - ses: AWS Simp

@dataclass
class EmailConfig:
    """
    Email configuration for sending emails via various providers.

    Stored as Keeper records (login type) with encrypted credentials.
    See ADR Decision 1 in ONBOARDING_FEATURE_IMPLEMENTATION_PLAN.md

    Supported providers:
    - smtp: Standard SMTP with username/password
    - ses: AWS Simple Email Service
    - sendgrid: SendGrid API
    - gmail-oauth: Gmail with OAuth 2.0 (uses Gmail API)
    - microsoft-oauth: Microsoft 365/Outlook with OAuth 2.0 (uses Graph API)
    """
    record_uid: str
    name: str
    provider: str  # 'smtp', 'ses', 'sendgrid', 'gmail-oauth', 'microsoft-oauth'
    from_address: str
    from_name: str = "Keeper Commander"

    # SMTP-specific
    smtp_host: Optional[str] = None
    smtp_port: int = 587
    smtp_username: Optional[str] = None
    smtp_password: Optional[str] = None
    smtp_use_tls: bool = True
    smtp_use_ssl: bool = False

    # AWS SES-specific
    aws_region: Optional[str] = None
    aws_access_key: Optional[str] = None
    aws_secret_key: Optional[str] = None

    # SendGrid-specific
    sendgrid_api_key: Optional[str] = None

    # OAuth-specific (gmail-oauth, microsoft-oauth)
    oauth_client_id: Optional[str] = None
    oauth_client_secret: Optional[str] = None
    oauth_access_token: Optional[str] = None
    oauth_refresh_token: Optional[str] = None
    oauth_token_expiry: Optional[str] = None  # ISO 8601 format
    oauth_scopes: Optional[List[str]] = None
    oauth_tenant_id: Optional[str] = None  # For Microsoft 365 (can be 'common', 'organizations', or specific tenant ID)

    # Additional metadata
    custom_fields: Dict[str, Any] = field(default_factory=dict)

    # Internal flag to track OAuth token updates (not stored in Keeper)
    _oauth_tokens_updated: bool = field(default=False, init=False)

    def validate(self) -> List[str]:
        """
        Validate email configuration completeness.

        Returns:
            List of validation error messages (empty if valid)
        """