annotate libervia/backend/plugins/plugin_comp_email_gateway/models.py @ 4387:a6270030968d default tip

doc (components): Document the handling of mailing lists in Email Gateway: fix 462
author Goffi <goffi@goffi.org>
date Sun, 03 Aug 2025 23:45:48 +0200
parents c055042c01e3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4303
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
1 #!/usr/bin/env python3
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
2
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
3 # Libervia Email Gateway Component
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
4 # Copyright (C) 2009-2024 Jérôme Poisson (goffi@goffi.org)
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
5
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
6 # This program is free software: you can redistribute it and/or modify
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # it under the terms of the GNU Affero General Public License as published by
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # the Free Software Foundation, either version 3 of the License, or
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # (at your option) any later version.
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
10
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
11 # This program is distributed in the hope that it will be useful,
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # GNU Affero General Public License for more details.
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
15
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
16 # You should have received a copy of the GNU Affero General Public License
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
18
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
19 from dataclasses import dataclass
4386
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
20 from pydantic import BaseModel, ConfigDict
4303
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
21 from twisted.mail import imap4
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
22
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
23
4386
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
24 class Credentials(BaseModel):
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
25 model_config = ConfigDict(extra='forbid')
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
26 user_name: str
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
27 user_email: str
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
28 smtp_host: str
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
29 smtp_port: int
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
30 smtp_username: str
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
31 smtp_password: str
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
32 imap_success: bool = False
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
33 imap_host: str
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
34 imap_port: int
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
35 imap_username: str
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
36 imap_password: str
c055042c01e3 component Email gateway: Convert mailing list to pubsub nodes:
Goffi <goffi@goffi.org>
parents: 4303
diff changeset
37
4303
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
38
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
39
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
40 @dataclass
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
41 class UserData:
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
42 credentials: Credentials
a7ec325246fb component email-gateway: first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
43 imap_client: imap4.IMAP4Client | None = None