Import a Mailbox
shipmail_create_mailbox_importImport emails from another provider into a Shipmail mailbox over IMAP. Use an app password; runs in background. Poll for progress.
Instructions
Start importing mail from another provider into a shipmail mailbox over IMAP. Use an app password for the source account. Outlook sources require the dashboard's Sign in with Microsoft and cannot be started here. The import runs in the background; poll shipmail_get_mailbox_import for progress.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ShipMail resource ID. | |
| provider | Yes | Source provider. Outlook imports require the dashboard's Microsoft sign-in. | |
| Yes | Address of the source mailbox | ||
| password | Yes | App password (preferred) or IMAP password for the source mailbox | |
| host | No | IMAP server, only for provider 'imap' | |
| port | No | IMAP port, only for provider 'imap' | |
| range | No | How far back to import. Defaults to all. | |
| include_spam | No | Also import the source spam folder | |
| include_trash | No | Also import the source trash folder |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| import | Yes |