37 lines
2.4 KiB
JSON
37 lines
2.4 KiB
JSON
{
|
|
"module": "mail_intake.exceptions",
|
|
"content": {
|
|
"path": "mail_intake.exceptions",
|
|
"docstring": "Exception hierarchy for Mail Intake.\n\n---\n\n## Summary\n\nThis module defines the **canonical exception types** used throughout the\nMail Intake library.\n\nAll library-raised errors derive from `MailIntakeError`. Consumers are\nencouraged to catch this base type (or specific subclasses) rather than\nprovider-specific or third-party exceptions.",
|
|
"objects": {
|
|
"MailIntakeError": {
|
|
"name": "MailIntakeError",
|
|
"kind": "class",
|
|
"path": "mail_intake.exceptions.MailIntakeError",
|
|
"signature": "<bound method Class.signature of Class('MailIntakeError', 17, 27)>",
|
|
"docstring": "Base exception for all Mail Intake errors.\n\nNotes:\n **Guarantees:**\n\n - This is the root of the Mail Intake exception hierarchy\n - All errors raised by the library must derive from this class\n - Consumers should generally catch this type when handling library-level failures"
|
|
},
|
|
"MailIntakeAuthError": {
|
|
"name": "MailIntakeAuthError",
|
|
"kind": "class",
|
|
"path": "mail_intake.exceptions.MailIntakeAuthError",
|
|
"signature": "<bound method Class.signature of Class('MailIntakeAuthError', 30, 38)>",
|
|
"docstring": "Authentication and credential-related failures.\n\nNotes:\n **Lifecycle:**\n\n - Raised when authentication providers are unable to acquire, refresh, or persist valid credentials"
|
|
},
|
|
"MailIntakeAdapterError": {
|
|
"name": "MailIntakeAdapterError",
|
|
"kind": "class",
|
|
"path": "mail_intake.exceptions.MailIntakeAdapterError",
|
|
"signature": "<bound method Class.signature of Class('MailIntakeAdapterError', 41, 49)>",
|
|
"docstring": "Errors raised by mail provider adapters.\n\nNotes:\n **Lifecycle:**\n\n - Raised when a provider adapter encounters API errors, transport failures, or invalid provider responses"
|
|
},
|
|
"MailIntakeParsingError": {
|
|
"name": "MailIntakeParsingError",
|
|
"kind": "class",
|
|
"path": "mail_intake.exceptions.MailIntakeParsingError",
|
|
"signature": "<bound method Class.signature of Class('MailIntakeParsingError', 52, 60)>",
|
|
"docstring": "Errors encountered while parsing message content.\n\nNotes:\n **Lifecycle:**\n\n - Raised when raw provider payloads cannot be interpreted or normalized into internal domain models"
|
|
}
|
|
}
|
|
}
|
|
} |