wehub-resource-sync
bcbd1bdb22
Integ / changes (push) Has been skipped
Pre-commit / pre-commit (push) Failing after 1s
CLI exit codes / changes (push) Has been skipped
Test (Install) / changes (push) Has been skipped
Test (Python) / changes (push) Has been skipped
Test (TypeScript) / changes (push) Has been skipped
CLI exit codes / cli-gate (push) Has been cancelled
Test (Install) / test-install-gate (push) Has been cancelled
Integ / integ-gate (push) Has been cancelled
Test (Python) / test-python-gate (push) Has been cancelled
Test (TypeScript) / test-typescript-gate (push) Has been cancelled
Test (Install) / python-minimal (3.12) (push) Has been cancelled
Test (Install) / python-minimal (3.11) (push) Has been cancelled
Test (Install) / python-extra (agno, mirage.agents.agno) (push) Has been cancelled
Test (Install) / python-extra (chroma, mirage.resource.chroma) (push) Has been cancelled
Test (Install) / python-extra (pdf, mirage.core.filetype.pdf) (push) Has been cancelled
Integ / integ (push) Has been cancelled
Integ / integ-database (push) Has been cancelled
Integ / integ-database-ts (push) Has been cancelled
Integ / integ-data (push) Has been cancelled
Integ / integ-ssh (push) Has been cancelled
Integ / integ-ssh-ts (push) Has been cancelled
Test (Python) / audit (push) Has been cancelled
Test (TypeScript) / test (push) Has been cancelled
Test (TypeScript) / python-fs-shim (push) Has been cancelled
CLI exit codes / Python CLI (push) Has been cancelled
CLI exit codes / TypeScript CLI (push) Has been cancelled
CLI exit codes / Cross-language snapshot interop (push) Has been cancelled
Test (Python) / test (push) Has been cancelled
Test (Python) / import-isolation (deepagents, openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Python) / import-isolation (deepagents, pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Integ / integ-ts (push) Has been cancelled
Integ / integ-fuse (push) Has been cancelled
Test (Install) / python-extra (databricks, mirage.resource.databricks_volume) (push) Has been cancelled
Test (Install) / python-extra (deepagents, mirage.agents.langchain) (push) Has been cancelled
Test (Install) / python-extra (email, mirage.resource.email) (push) Has been cancelled
Test (Install) / python-extra (fuse, mirage.fuse.mount) (push) Has been cancelled
Test (Install) / python-extra (hdf5, mirage.core.filetype.hdf5) (push) Has been cancelled
Test (Install) / python-extra (hf, mirage.resource.hf_buckets) (push) Has been cancelled
Test (Install) / python-extra (lancedb, mirage.resource.lancedb) (push) Has been cancelled
Test (Install) / python-extra (langfuse, mirage.resource.langfuse) (push) Has been cancelled
Test (Install) / python-extra (mongodb, mirage.resource.mongodb) (push) Has been cancelled
Test (Install) / python-extra (nextcloud, mirage.resource.nextcloud) (push) Has been cancelled
Test (Install) / python-extra (openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Install) / python-extra (openhands, mirage.agents.openhands, 3.12) (push) Has been cancelled
Test (Install) / python-extra (parquet, mirage.core.filetype.parquet) (push) Has been cancelled
Test (Install) / python-extra (postgres, mirage.resource.postgres) (push) Has been cancelled
Test (Install) / python-extra (pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Test (Install) / python-extra (qdrant, mirage.resource.qdrant) (push) Has been cancelled
Test (Install) / python-extra (redis, mirage.resource.redis) (push) Has been cancelled
Test (Install) / python-extra (s3, mirage.resource.s3) (push) Has been cancelled
Test (Install) / python-extra (ssh, mirage.resource.ssh) (push) Has been cancelled
Test (Install) / ts-minimal (push) Has been cancelled
58 lines
1.5 KiB
Plaintext
58 lines
1.5 KiB
Plaintext
---
|
|
title: Email
|
|
icon: envelope
|
|
description: Set up the Email resource in Python.
|
|
---
|
|
|
|
## Dependencies
|
|
|
|
```bash
|
|
uv add aioimaplib aiosmtplib
|
|
```
|
|
|
|
For credential setup, see the [Email Setup](/home/setup/email) guide.
|
|
|
|
## Configuration
|
|
|
|
```python
|
|
import os
|
|
from mirage import Workspace, MountMode
|
|
from mirage.resource.email import EmailConfig, EmailResource
|
|
|
|
config = EmailConfig(
|
|
imap_host=os.environ["IMAP_HOST"],
|
|
smtp_host=os.environ["SMTP_HOST"],
|
|
username=os.environ["EMAIL_USERNAME"],
|
|
password=os.environ["EMAIL_PASSWORD"],
|
|
)
|
|
resource = EmailResource(config=config)
|
|
ws = Workspace({"/email/": resource}, mode=MountMode.READ)
|
|
```
|
|
|
|
### Verify Connection
|
|
|
|
```python
|
|
import asyncio
|
|
|
|
async def main():
|
|
r = await ws.execute("ls /email/")
|
|
print(await r.stdout_str())
|
|
|
|
asyncio.run(main())
|
|
```
|
|
|
|
This should print your IMAP folder names (e.g., `INBOX`, `Sent`,
|
|
`Drafts`, `Archive`).
|
|
|
|
## Config Reference
|
|
|
|
| Field | Required | Default | Description |
|
|
| ----------- | -------- | ------- | ------------------------ |
|
|
| `imap_host` | Yes | | IMAP server hostname |
|
|
| `imap_port` | No | `993` | IMAP port |
|
|
| `smtp_host` | Yes | | SMTP server hostname |
|
|
| `smtp_port` | No | `587` | SMTP port |
|
|
| `username` | Yes | | Email address / login |
|
|
| `password` | Yes | | Password or app password |
|
|
| `use_ssl` | No | `True` | Use SSL for IMAP |
|