Ole-Morten Duesund
c2ad55eaaf
## Documentation Enhancements - Create comprehensive README with installation, configuration, and usage examples - Add simple, advanced, and provider-specific configuration examples - Document all features: incremental sync, wildcard patterns, keyword filtering, attachment support - Include production deployment guidance and troubleshooting section - Add architecture documentation with database structure and document format examples ## Configuration Cleanup - Remove unnecessary `database` field from CouchDB configuration - Add `m2c_` prefix to all CouchDB database names for better namespace isolation - Update GenerateAccountDBName() to consistently prefix databases with `m2c_` - Clean up all configuration examples to remove deprecated database field ## Test Environment Simplification - Simplify test script structure to eliminate confusion and redundancy - Remove redundant populate-test-messages.sh wrapper script - Update run-tests.sh to be comprehensive automated test with cleanup - Maintain clear separation: automated tests vs manual testing environment - Update all test scripts to expect m2c-prefixed database names ## Configuration Examples Added - config-simple.json: Basic single Gmail account setup - config-advanced.json: Multi-account with complex filtering and different providers - config-providers.json: Real-world configurations for Gmail, Outlook, Yahoo, iCloud ## Benefits - Clear documentation for users from beginner to advanced - Namespace isolation prevents database conflicts in shared CouchDB instances - Simplified test workflow eliminates user confusion about which scripts to use - Comprehensive examples cover common email provider configurations 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
78 lines
No EOL
2 KiB
JSON
78 lines
No EOL
2 KiB
JSON
{
|
|
"couchDb": {
|
|
"url": "https://your-couchdb.example.com:5984",
|
|
"user": "backup_user",
|
|
"password": "secure_password"
|
|
},
|
|
"mailSources": [
|
|
{
|
|
"name": "Work Email",
|
|
"enabled": true,
|
|
"protocol": "imap",
|
|
"host": "outlook.office365.com",
|
|
"port": 993,
|
|
"user": "you@company.com",
|
|
"password": "app-password",
|
|
"mode": "sync",
|
|
"folderFilter": {
|
|
"include": ["*"],
|
|
"exclude": ["Deleted Items", "Junk Email", "Drafts"]
|
|
},
|
|
"messageFilter": {
|
|
"since": "2023-01-01",
|
|
"subjectKeywords": ["project", "meeting", "urgent"],
|
|
"senderKeywords": ["@company.com", "@client.com"]
|
|
}
|
|
},
|
|
{
|
|
"name": "Personal Gmail",
|
|
"enabled": true,
|
|
"protocol": "imap",
|
|
"host": "imap.gmail.com",
|
|
"port": 993,
|
|
"user": "personal@gmail.com",
|
|
"password": "gmail-app-password",
|
|
"mode": "archive",
|
|
"folderFilter": {
|
|
"include": ["INBOX", "Important", "Work/*", "Personal/*"],
|
|
"exclude": ["[Gmail]/Trash", "[Gmail]/Spam", "*Temp*"]
|
|
},
|
|
"messageFilter": {
|
|
"recipientKeywords": ["family@", "personal@"]
|
|
}
|
|
},
|
|
{
|
|
"name": "Self-Hosted Mail",
|
|
"enabled": true,
|
|
"protocol": "imap",
|
|
"host": "mail.yourdomain.com",
|
|
"port": 143,
|
|
"user": "admin@yourdomain.com",
|
|
"password": "mail-password",
|
|
"mode": "archive",
|
|
"folderFilter": {
|
|
"include": ["INBOX", "Archive/*", "Projects/*"],
|
|
"exclude": ["*/Drafts", "Trash"]
|
|
},
|
|
"messageFilter": {
|
|
"since": "2023-06-01",
|
|
"subjectKeywords": ["invoice", "receipt", "statement"]
|
|
}
|
|
},
|
|
{
|
|
"name": "Legacy Account",
|
|
"enabled": false,
|
|
"protocol": "imap",
|
|
"host": "legacy.mailserver.com",
|
|
"port": 993,
|
|
"user": "old@account.com",
|
|
"password": "legacy-password",
|
|
"mode": "archive",
|
|
"folderFilter": {
|
|
"include": ["INBOX"],
|
|
"exclude": []
|
|
},
|
|
"messageFilter": {}
|
|
}
|
|
]
|
|
} |