Skip to content

System Config Smtp Dto

immichpy.client.generated.models.system_config_smtp_dto.SystemConfigSmtpDto pydantic-model

Bases: BaseModel

SystemConfigSmtpDto

Show JSON schema: 
{
  "$defs": {
    "SystemConfigSmtpTransportDto": {
      "description": "SystemConfigSmtpTransportDto",
      "properties": {
        "host": {
          "description": "SMTP server hostname",
          "title": "Host",
          "type": "string"
        },
        "ignoreCert": {
          "description": "Whether to ignore SSL certificate errors",
          "title": "Ignorecert",
          "type": "boolean"
        },
        "password": {
          "description": "SMTP password",
          "title": "Password",
          "type": "string"
        },
        "port": {
          "anyOf": [
            {
              "maximum": 65535,
              "minimum": 0,
              "type": "number"
            },
            {
              "maximum": 65535,
              "minimum": 0,
              "type": "integer"
            }
          ],
          "description": "SMTP server port",
          "title": "Port"
        },
        "secure": {
          "description": "Whether to use secure connection (TLS/SSL)",
          "title": "Secure",
          "type": "boolean"
        },
        "username": {
          "description": "SMTP username",
          "title": "Username",
          "type": "string"
        }
      },
      "required": [
        "host",
        "ignoreCert",
        "password",
        "port",
        "secure",
        "username"
      ],
      "title": "SystemConfigSmtpTransportDto",
      "type": "object"
    }
  },
  "description": "SystemConfigSmtpDto",
  "properties": {
    "enabled": {
      "description": "Whether SMTP email notifications are enabled",
      "title": "Enabled",
      "type": "boolean"
    },
    "from": {
      "description": "Email address to send from",
      "title": "From",
      "type": "string"
    },
    "replyTo": {
      "description": "Email address for replies",
      "title": "Replyto",
      "type": "string"
    },
    "transport": {
      "$ref": "#/$defs/SystemConfigSmtpTransportDto"
    }
  },
  "required": [
    "enabled",
    "from",
    "replyTo",
    "transport"
  ],
  "title": "SystemConfigSmtpDto",
  "type": "object"
}

Config:

  • populate_by_name: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

enabled pydantic-field 

enabled: StrictBool

Whether SMTP email notifications are enabled

reply_to pydantic-field 

reply_to: StrictStr

Email address for replies

var_from pydantic-field 

var_from: StrictStr

Email address to send from

from_dict classmethod 

from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]

Create an instance of SystemConfigSmtpDto from a dict

Source code in immichpy/client/generated/models/system_config_smtp_dto.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of SystemConfigSmtpDto from a dict"""
    if obj is None:
        return None

    if not isinstance(obj, dict):
        return cls.model_validate(obj)

    _obj = cls.model_validate(
        {
            "enabled": obj.get("enabled"),
            "from": obj.get("from"),
            "replyTo": obj.get("replyTo"),
            "transport": SystemConfigSmtpTransportDto.from_dict(obj["transport"])
            if obj.get("transport") is not None
            else None,
        }
    )
    return _obj

from_json classmethod 

from_json(json_str: str) -> Optional[Self]

Create an instance of SystemConfigSmtpDto from a JSON string

Source code in immichpy/client/generated/models/system_config_smtp_dto.py 
58
59
60
61
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of SystemConfigSmtpDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

to_dict 

to_dict() -> Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic's self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
Source code in immichpy/client/generated/models/system_config_smtp_dto.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def to_dict(self) -> Dict[str, Any]:
    """Return the dictionary representation of the model using alias.

    This has the following differences from calling pydantic's
    `self.model_dump(by_alias=True)`:

    * `None` is only added to the output dict for nullable fields that
      were set at model initialization. Other fields with value `None`
      are ignored.
    """
    excluded_fields: Set[str] = set([])

    _dict = self.model_dump(
        by_alias=True,
        exclude=excluded_fields,
        exclude_none=True,
    )
    # override the default output from pydantic by calling `to_dict()` of transport
    if self.transport:
        _dict["transport"] = self.transport.to_dict()
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/system_config_smtp_dto.py 
53
54
55
56
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
    return json.dumps(self.to_dict())

to_str 

to_str() -> str

Returns the string representation of the model using alias

Source code in immichpy/client/generated/models/system_config_smtp_dto.py 
49
50
51
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))