Vishesh 'ironeagle' Bangotra
f7f9744e47
Reviewed-on: #1 Co-authored-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com> Co-committed-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com>
67 lines
3.0 KiB
JSON
67 lines
3.0 KiB
JSON
{
|
|
"module": "mail_intake.config",
|
|
"content": {
|
|
"path": "mail_intake.config",
|
|
"docstring": "Global configuration models for Mail Intake.\n\nThis module defines the **top-level configuration object** used to control\nmail ingestion behavior across adapters, authentication providers, and\ningestion workflows.\n\nConfiguration is intentionally explicit, immutable, and free of implicit\nenvironment reads to ensure predictability and testability.",
|
|
"objects": {
|
|
"dataclass": {
|
|
"name": "dataclass",
|
|
"kind": "alias",
|
|
"path": "mail_intake.config.dataclass",
|
|
"signature": "<bound method Alias.signature of Alias('dataclass', 'dataclasses.dataclass')>",
|
|
"docstring": null
|
|
},
|
|
"Optional": {
|
|
"name": "Optional",
|
|
"kind": "alias",
|
|
"path": "mail_intake.config.Optional",
|
|
"signature": "<bound method Alias.signature of Alias('Optional', 'typing.Optional')>",
|
|
"docstring": null
|
|
},
|
|
"MailIntakeConfig": {
|
|
"name": "MailIntakeConfig",
|
|
"kind": "class",
|
|
"path": "mail_intake.config.MailIntakeConfig",
|
|
"signature": "<bound method Class.signature of Class('MailIntakeConfig', 16, 45)>",
|
|
"docstring": "Global configuration for mail-intake.\n\nThis configuration is intentionally explicit and immutable.\nNo implicit environment reads or global state.\n\nDesign principles:\n- Immutable once constructed\n- Explicit configuration over implicit defaults\n- No direct environment or filesystem access\n\nThis model is safe to pass across layers and suitable for serialization.",
|
|
"members": {
|
|
"provider": {
|
|
"name": "provider",
|
|
"kind": "attribute",
|
|
"path": "mail_intake.config.MailIntakeConfig.provider",
|
|
"signature": null,
|
|
"docstring": "Identifier of the mail provider to use (e.g., ``\"gmail\"``)."
|
|
},
|
|
"user_id": {
|
|
"name": "user_id",
|
|
"kind": "attribute",
|
|
"path": "mail_intake.config.MailIntakeConfig.user_id",
|
|
"signature": null,
|
|
"docstring": "Provider-specific user identifier. Defaults to the authenticated user."
|
|
},
|
|
"readonly": {
|
|
"name": "readonly",
|
|
"kind": "attribute",
|
|
"path": "mail_intake.config.MailIntakeConfig.readonly",
|
|
"signature": null,
|
|
"docstring": "Whether ingestion should operate in read-only mode."
|
|
},
|
|
"credentials_path": {
|
|
"name": "credentials_path",
|
|
"kind": "attribute",
|
|
"path": "mail_intake.config.MailIntakeConfig.credentials_path",
|
|
"signature": null,
|
|
"docstring": "Optional path to provider credentials configuration."
|
|
},
|
|
"token_path": {
|
|
"name": "token_path",
|
|
"kind": "attribute",
|
|
"path": "mail_intake.config.MailIntakeConfig.token_path",
|
|
"signature": null,
|
|
"docstring": "Optional path to persisted authentication tokens."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |