_email
| CLASS | DESCRIPTION |
|---|---|
EmailSettings |
Class with settings for email-sending feature. |
PublicEmailSettings |
Schema for |
Attributes
Classes
EmailSettings
Bases: BaseSettings
Class with settings for email-sending feature.
| ATTRIBUTE | DESCRIPTION |
|---|---|
FRACTAL_EMAIL_SENDER |
Address of the OAuth-signup email sender.
TYPE:
|
FRACTAL_EMAIL_PASSWORD |
Password for the OAuth-signup email sender.
TYPE:
|
FRACTAL_EMAIL_SMTP_SERVER |
SMTP server for the OAuth-signup emails.
TYPE:
|
FRACTAL_EMAIL_SMTP_PORT |
SMTP server port for the OAuth-signup emails.
TYPE:
|
FRACTAL_EMAIL_INSTANCE_NAME |
Fractal instance name, to be included in the OAuth-signup emails.
TYPE:
|
FRACTAL_EMAIL_RECIPIENTS |
Comma-separated list of recipients of the OAuth-signup emails.
TYPE:
|
FRACTAL_EMAIL_USE_STARTTLS |
Whether to use StartTLS when using the SMTP server.
TYPE:
|
FRACTAL_EMAIL_USE_LOGIN |
Whether to use login when using the SMTP server. If 'true', FRACTAL_EMAIL_PASSWORD must be provided.
TYPE:
|
| METHOD | DESCRIPTION |
|---|---|
validate_email_settings |
Set |
Source code in fractal_server/config/_email.py
Attributes
public = None
class-attribute
instance-attribute
The validated field which is actually used in fractal-server,
automatically populated upon creation.
Methods:
validate_email_settings()
Set self.public.
Source code in fractal_server/config/_email.py
PublicEmailSettings
pydantic-model
Bases: BaseModel
Schema for EmailSettings.public, namely the ready-to-use settings.
| ATTRIBUTE | DESCRIPTION |
|---|---|
sender |
Sender email address.
TYPE:
|
recipients |
List of recipients email address.
TYPE:
|
smtp_server |
SMTP server address.
TYPE:
|
port |
SMTP server port.
TYPE:
|
password |
Sender password.
TYPE:
|
instance_name |
Name of SMTP server instance.
TYPE:
|
use_starttls |
Whether to use the security protocol.
TYPE:
|
use_login |
Whether to use login.
TYPE:
|
Fields:
-
sender(EmailStr) -
recipients(list[EmailStr]) -
smtp_server(str) -
port(int) -
password(SecretStr | None) -
instance_name(str) -
use_starttls(bool) -
use_login(bool)