Import a Mailbox
shipmail_create_mailbox_importImport emails from a supported provider into a Shipmail mailbox using IMAP. Provide source email and app password; poll for import progress.
Instructions
Start importing mail from another provider into a shipmail mailbox over IMAP. Use an app or device 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. | |
| host | No | IMAP server. Required for 'imap' and 'mxroute'; optional Titan or OVHcloud server override. | |
| port | No | IMAP port. Used for custom IMAP, MXroute, Titan, and OVHcloud overrides. | |
| Yes | Address of the source mailbox | ||
| range | No | How far back to import. Defaults to all. | |
| password | Yes | App password, device password, or IMAP password for the source mailbox | |
| provider | Yes | Source provider. Outlook imports require the dashboard's Microsoft sign-in. | |
| 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 |