client.imports
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
Bring an old mailbox across, straight from its mail server or from a Google Takeout, .mbox, .eml, .zip or .tgz export, with progress and a list of what did not come through.
imports.list
List one page of mailbox imports
list(address_id: nil, limit: nil, cursor: nil, api_key: nil) -> Nextmail::PageReturns one page of the imports in the workspace, newest first. Nothing is dropped from the history, so following next_cursor while has_more? is true reaches the very first import, and list_all and iterate do that walk for you. Each carries its status, the bytes read so far out of the total, and running counts of messages seen, imported, skipped as duplicates, left out by your options and not imported.
A key limited to particular addresses sees only imports into those addresses.
Parameters
address_idStringOnly imports into this address.
limitIntegerRows per page, a whole number from 1 to 100. The server defaults to 25.
cursorStringThe
next_cursorfrom the previous page, an import id. One that names no import this key can see is a 400invalid_cursor.api_keyStringOverrides the client API key for this call only.
Returns
An Nextmail::Page of import Hashes, with items, has_more? and next_cursor.
Example
page = client.imports.list(limit: 50) page.items.each do |item| puts "#{item[:address]} #{item[:status]} #{item[:counts][:imported]}"endNotes
A GET is retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, up to the client's
max_retries, and on a 429 only when it carries aRetry-Afterof a minute or less.
Also available in
- API
GET /imports- TypeScript
nextmail.imports.list()- Python
imports.list()- PHP
imports->list- Go
Imports.List- Java
imports().list- C#
Imports.ListAsync- CLI
openemail imports list
imports.list_all
Collect every mailbox import into one array
list_all(address_id: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Follows next_cursor from page to page and returns every import in the workspace, newest first, narrowed to one address when address_id: is given. A key limited to particular addresses sees only imports into those addresses.
Parameters
address_idStringOnly imports into this address.
limitIntegerPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorStringAn import id to start after, skipping everything newer.
api_keyStringOverrides the client API key for every page of this walk.
Returns
An Array of import Hashes holding every import across all pages.
Example
imports = client.imports.list_all failed = imports.select { |item| item[:status] == "failed" } puts "#{failed.length} of #{imports.length} imports failed"Notes
A failure on any page raises out of the whole call, and none of the pages already read are returned.
Also available in
imports.iterate
Stream mailbox imports one at a time
iterate(address_id: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>Returns an Enumerator that yields imports individually, newest first, or yields each one to a block when given one, and requests the next page only once the current one is drained. Breaking out of the loop stops the requests.
Parameters
address_idStringOnly imports into this address.
limitIntegerPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorStringAn import id to start after, skipping everything newer.
api_keyStringOverrides the client API key for every page of this walk.
Returns
An Enumerator of import Hashes (or yields each one to a block), one import per step.
Example
running = client.imports.iterate(address_id: "addr_2b7e").find { |item| item[:status] == "running" } puts running[:id], running[:counts][:imported] if runningNotes
The Enumerator is lazy, so an abandoned loop costs only the pages you consumed.
Also available in
imports.get
Read one mailbox import
get(id, api_key: nil) -> HashReturns one import with its status, byte progress and counts. Poll it while status is queued or running; it settles on completed, failed or cancelled.
An import from a live mailbox has source imap or microsoft and carries remote, with the folders done out of the total and why it waits, and children, the contacts and calendar imports that came with it. Such an import can also wait: parked carries on by itself at remote[:resumeAt], and needs-password stays until resume sends a new password. An import from files has source file, remote nil and no children.
An id from another workspace answers exactly like one that never existed, with 404.
Parameters
idStringRequiredImport id,
imp_followed by 24 hex characters.api_keyStringOverrides the client API key for this call only.
Returns
A Hash with id, source, remote, children, addressId, address, status, options, files, formats, chunkBytes, totalBytes, processedBytes, counts, labelsCreated, labelsSkipped, lastError, uploadDeleted, createdAt, startedAt and finishedAt. counts holds seen, imported, duplicate, filtered, failed and threads. remote is nil or a Hash with provider, host, username, foldersTotal, foldersDone, messagesTotal, pauseReason, resumeAt, rerunOf and rerunnable, and each of children is a Hash with id, kind, source, status, imported, skipped and total.
Example
item = client.imports.get("imp_3f9c2a7b1e4d8f60a5c7b92d") puts "#{item[:status]} #{item[:processedBytes]} / #{item[:totalBytes]}"Notes
lastErroris set only whenstatusisfailed.
Also available in
- API
GET /imports/{id}- TypeScript
nextmail.imports.get()- Python
imports.get()- PHP
imports->get- Go
Imports.Get- Java
imports().get- C#
Imports.GetAsync- CLI
openemail imports get
imports.create
Create a mailbox import and get its upload plan
create(body = nil, api_key: nil, **fields) -> HashCreates an import into one address of the workspace and returns it with status set to uploading. Each file is uploaded in parts of chunkBytes, files[i][:chunks] of them, through upload_chunk, and start then queues the import.
The import reads Google Takeout archives, .mbox files from Apple Mail, Thunderbird and most desktop apps, .eml files, and .zip or .tgz archives holding any of those, up to 100 GB a file and 50 files an import. Threads, dates and labels come across. Imported mail is quiet: it runs no rules, forwards, notifications, summaries or webhooks.
import_files does create, upload and start in one call.
Parameters
addressIdStringRequiredThe address the mail belongs to. It must be an address this workspace owns and this key may act for.
filesArray<Hash>RequiredEach file as a Hash with
nameandbytes, its size, 1 to 50 of them, each at most 100 GB.options.keepInboxBooleanDefault true: mail that was in the old inbox lands in Inbox with its unread state. False files everything under Archive. It goes inside the
optionsHash, as do the next two.options.includeSpamBooleanDefault false.
options.includeTrashBooleanDefault false.
api_keyStringOverrides the client API key for this call only.
Returns
A Hash for the import, shaped like the one get returns, with status set to uploading, chunkBytes and each file's chunks.
Example
item = client.imports.create( addressId: "addr_2b7e", files: [{name: "takeout-001.zip", bytes: 2_147_483_648}], options: {keepInbox: true, includeSpam: false}) puts item[:chunkBytes], item[:files][0][:chunks]Notes
An address with an import already queued or running is 409
already_running.Not retried automatically.
Also available in
imports.upload_state
See which parts of the upload have arrived
upload_state(id, api_key: nil) -> HashFor each file, the indexes of the parts already stored, so an interrupted upload sends only what is missing. Empty once the import has left the uploading state.
Parameters
idStringRequiredImport id,
imp_followed by 24 hex characters.api_keyStringOverrides the client API key for this call only.
Returns
A Hash with id, status and received, one sorted Array of part indexes per file.
Example
state = client.imports.upload_state("imp_3f9c2a7b1e4d8f60a5c7b92d") puts state[:received][0].lengthAlso available in
imports.upload_chunk
Upload one part of an import file
upload_chunk(id, file, chunk, data, api_key: nil) -> HashStores one part of file file: the bytes from chunk * chunkBytes up to the next part. Every part is exactly chunkBytes long except the last, and a part of the wrong length is 400 bad_chunk. Sending a part again replaces it, so a failed part can simply be retried.
Parameters
idStringRequiredImport id,
imp_followed by 24 hex characters.fileIntegerRequiredThe file index, in the order given to
create.chunkIntegerRequiredThe part index, from 0.
dataString, IO or PathnameRequiredThe part as a binary String, or an IO or a Pathname whose whole content is the part. It is sent as it is, so slice the part out of the file first.
api_keyStringOverrides the client API key for this call only.
Returns
A Hash echoing file, chunk and the bytes stored.
Example
size = File.size("takeout-001.zip")item = client.imports.create(addressId: "addr_2b7e", files: [{name: "takeout-001.zip", bytes: size}])part = File.binread("takeout-001.zip", item[:chunkBytes], 0) client.imports.upload_chunk(item[:id], 0, 0, part)Notes
Retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, and on a 429 only when it carries a
Retry-Afterof a minute or less, since a repeated part replaces itself.
Also available in
imports.start
Queue an import once its files are uploaded
start(id, api_key: nil) -> HashChecks that every part of every file has arrived, recognises each file's format and queues the import. A file still missing parts is 412 missing_chunks, and a file that is not an archive or a mailbox is 400 unsupported_file. Calling it on an import that has already left uploading returns it unchanged.
Parameters
idStringRequiredImport id,
imp_followed by 24 hex characters.api_keyStringOverrides the client API key for this call only.
Returns
The import Hash, shaped like the one get returns, with status set to queued.
Example
queued = client.imports.start("imp_3f9c2a7b1e4d8f60a5c7b92d") puts queued[:status]Notes
Retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, and on a 429 only when it carries a
Retry-Afterof a minute or less, since calling it again returns the import unchanged.
Also available in
imports.cancel
Cancel a mailbox import
cancel(id, api_key: nil) -> HashStops an import at its next checkpoint. Mail already imported stays in the mailbox. A finished import is 409 not_cancellable.
Parameters
idStringRequiredImport id,
imp_followed by 24 hex characters.api_keyStringOverrides the client API key for this call only.
Returns
The import Hash, shaped like the one get returns, with status set to cancelled.
Example
client.imports.cancel("imp_3f9c2a7b1e4d8f60a5c7b92d")Also available in
imports.list_failures
List what an import could not bring across
list_failures(id, after: nil, limit: nil, api_key: nil) -> HashEach message or archive entry that did not come across, with the reason: too-large (over 50 MB), unparseable, no-date, storage-error, unreadable-entry, encrypted-entry or archive-limit. Page with after:, passing the nextCursor of the previous page.
Parameters
idStringRequiredImport id,
imp_followed by 24 hex characters.afterIntegerThe
nextCursorof the previous page.limitIntegerAt most 100, the default.
api_keyStringOverrides the client API key for this call only.
Returns
A Hash, not an Nextmail::Page, with data, an Array of Hashes with id, seq, reason, subject, sender, messageId, source, bytes, detail and createdAt, and nextCursor, an Integer or nil on the last page.
Example
failures = client.imports.list_failures("imp_3f9c2a7b1e4d8f60a5c7b92d") failures[:data].each { |failure| puts "#{failure[:reason]} #{failure[:subject]}" }Also available in
imports.delete_upload
Delete the files uploaded for an import
delete_upload(id, api_key: nil) -> HashRemoves the uploaded archive. Mail already imported stays in the mailbox. An import still uploading is cancelled at the same time, and one that is queued or running is 409 still_running.
Parameters
idStringRequiredImport id,
imp_followed by 24 hex characters.api_keyStringOverrides the client API key for this call only.
Returns
The import Hash, shaped like the one get returns, with uploadDeleted set to true.
Example
client.imports.delete_upload("imp_3f9c2a7b1e4d8f60a5c7b92d")Also available in
imports.import_files
Create, upload and start an import in one call
import_files(input = nil, api_key: nil, **fields, &block) -> HashCreates the import, uploads every file part by part and starts it, reporting progress to a block or through onProgress. Pass each file's data as a binary String, an IO or a Pathname; parts are sliced from it, so a Pathname or an open File is never read into memory at once.
It returns once the import is queued. Poll get to follow it.
Parameters
addressIdStringRequiredThe address the mail belongs to.
filesArray<Hash>RequiredEach file as a Hash with
nameanddata, wheredatais a binary String, an IO or a Pathname.optionsHashkeepInbox,includeSpamandincludeTrash, as forcreate.onProgressProcAnything that responds to
call, called after each part with the bytes uploaded and the total. A block given to the call does the same job and is used instead when both are given.api_keyStringOverrides the client API key for this call only.
Returns
The import Hash, shaped like the one get returns, with status set to queued.
Example
files = [{name: "takeout-001.zip", data: Pathname("takeout-001.zip")}] item = client.imports.import_files(addressId: "addr_2b7e", files:) do |done, total| puts "#{(done * 100.0 / total).round}%"end puts item[:id], item[:status]Notes
If a part fails after its retries, the import is left in
uploading;upload_statethen tells you which parts to send before callingstart.
Also available in
imports.discover_mailbox
Find the mail server for an address
discover_mailbox(email, api_key: nil) -> HashLooks up where the mailbox behind an address lives, so an import can connect to it. It tries the providers Nextmail knows, then who receives mail for the domain, then Mozilla's public list of mail settings, then the domain's own _imaps._tcp record. Nothing is stored and no sign-in is attempted.
server is nil when nothing was found: ask for the host and port and pass them to check_mailbox. signIn says what the mailbox takes. app-password and password are what check_mailbox and connect_mailbox send. An Outlook.com or Microsoft 365 mailbox answers microsoft, which only the Microsoft sign-in on the Migrations page of the app can open.
Parameters
emailStringRequiredThe address of the old mailbox.
api_keyStringOverrides the client API key for this call only.
Returns
A Hash with object, email, provider, one of Nextmail::MAILBOX_PROVIDERS, signIn, one of Nextmail::MAILBOX_SIGN_INS, server, source, username, and contacts and calendars, whether those can come across too. server is nil or a Hash with host, port and security, and source says where the server was found, one of Nextmail::MAILBOX_SETTINGS_SOURCES or nil.
Example
settings = client.imports.discover_mailbox("[email protected]") if settings[:signIn] == "microsoft" puts "Connect this mailbox from the Migrations page of the app"else puts settings[:provider], settings[:signIn], settings.dig(:server, :host)endNotes
Something that is not an email address is a 400
mailbox_address_invalid.Too many lookups in an hour is a 429
mailbox_checks_limited.A GET is retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, up to the client's
max_retries, and on a 429 only when it carries aRetry-Afterof a minute or less.
Also available in
imports.check_mailbox
Check a mailbox before importing it
check_mailbox(body = nil, api_key: nil, **fields) -> HashSigns in to the old mailbox over IMAP, lists its folders and counts the messages, then signs out. Nothing is stored, the password is not kept and the old mailbox is not changed. Use it to show what an import would bring before starting one.
Leave host out to have the server looked up from the address, as discover_mailbox does. Only port 993 with TLS, or port 143 with STARTTLS, is accepted. Each person may make 10 sign-in attempts an hour across check_mailbox, connect_mailbox and resume, and every refused sign-in reads the same, whatever the reason.
Parameters
emailStringRequiredThe address of the old mailbox.
passwordStringRequiredThe password of the old mailbox, or an app password where
discover_mailboxanswerssignInapp-password.hostStringThe IMAP host, such as
imap.example.com. It has to be a public host. Left out, the server is looked up from the address.portInteger993 or 143, read only with
host. Left out, it followssecurity: 993 fortlsand 143 forstarttls.securityStringtlsorstarttls, the values ofNextmail::MAILBOX_SECURITIES, read only withhost. Left out, it followsport, and istlswhen both are left out.usernameStringThe name to sign in with. Left out, it is the
usernamethatdiscover_mailboxanswers, usually the address.api_keyStringOverrides the client API key for this call only.
Returns
A Hash with object, provider, the server and username that worked, folders, messages, the total an import would read, and contacts and calendars. folders holds up to 200 Hashes with name, role, one of Nextmail::MAILBOX_FOLDER_ROLES, messages and included, whether an import with the default options reads the folder.
Example
check = client.imports.check_mailbox(email: "[email protected]", password: ENV["OLD_MAILBOX_PASSWORD"]) included = check[:folders].count { |folder| folder[:included] } puts "#{check[:messages]} messages in #{included} folders"Notes
A sign-in the mail server does not accept is a 400
mailbox_login_failed, with no more detail than that.No server found for the address is a 400
mailbox_settings_unknown: sendhost. A host that is not public, or a port other than 993 or 143, is a 400mailbox_host_not_allowed.A mailbox that only opens through the Microsoft sign-in is a 400
mailbox_uses_microsoft.A mail server that does not answer is a 502
mailbox_unreachable, and too many sign-in attempts in an hour is a 429mailbox_checks_limited.Spam and bin folders come back with
includedfalse, since an import reads them only when asked to.Not retried automatically.
Also available in
imports.connect_mailbox
Import a live mailbox
connect_mailbox(body = nil, api_key: nil, **fields) -> HashStarts copying an old mailbox into one address, straight from its mail server. It signs in once to check the password, keeps the password sealed until the import finishes and for 30 days at most, and queues the import. Poll get for progress.
The old mailbox is only ever read. Folders become labels, read and starred state come across, and a message the address already holds is skipped, so running an import twice adds nothing. A Gmail mailbox is read from All Mail, with its labels. An import waits by itself when the old provider slows it down, such as Gmail's daily download limit, and carries on from the same folder afterwards: status is parked and remote[:resumeAt] says when. If the password stops working, status is needs-password until resume sends a new one.
contacts and calendars bring those across too where the provider offers them, which needs contacts:write and calendar:write as well. They arrive as contacts and calendar imports of their own, listed in children. rerunOf names a finished import of the same mailbox, at most 30 days old, so only mail that arrived since is fetched. Leave host out on such a run and it connects to the same server as that import. One import may run into an address at a time.
Parameters
addressIdStringRequiredThe address the mail belongs to. It must be an address this workspace owns and this key may act for.
emailStringRequiredThe address of the old mailbox.
passwordStringRequiredThe password of the old mailbox, or an app password where
discover_mailboxanswerssignInapp-password.hostStringThe IMAP host, such as
imap.example.com. It has to be a public host. Left out, the server is looked up from the address.portInteger993 or 143, read only with
host. Left out, it followssecurity: 993 fortlsand 143 forstarttls.securityStringtlsorstarttls, the values ofNextmail::MAILBOX_SECURITIES, read only withhost. Left out, it followsport, and istlswhen both are left out.usernameStringThe name to sign in with. Left out, it is the
usernamethatdiscover_mailboxanswers, usually the address.options.keepInboxBooleanDefault true: mail that was in the old inbox lands in Inbox with its unread state. False files everything under Archive. It goes inside the
optionsHash, as do the next two.options.includeSpamBooleanDefault false.
options.includeTrashBooleanDefault false.
contactsBooleanTrue brings the address book across too, where the provider offers it. Needs
contacts:write.calendarsBooleanTrue brings the calendars across too, where the provider offers them. Needs
calendar:write.rerunOfStringThe id of a finished import of the same mailbox, at most 30 days old. Only mail that arrived since is fetched.
api_keyStringOverrides the client API key for this call only.
Returns
The import Hash, shaped like the one get returns, with status set to queued, source set to imap, the remote mailbox it reads and the children it started.
Example
item = client.imports.connect_mailbox( addressId: "addr_2b7e", email: "[email protected]", password: ENV["OLD_MAILBOX_PASSWORD"], contacts: true, calendars: true) puts item[:status], item.dig(:remote, :host), item[:children].sizeNotes
An address with an import already under way is 409
already_running, and an import named inrerunOfthat cannot be continued is 409rerun_not_available.An address outside the workspace is 404
address_not_found, and one the key may not act for is 403address_not_allowed.The sign-in is checked before anything is queued, so it fails as
check_mailboxdoes: 400mailbox_login_failed,mailbox_settings_unknown,mailbox_host_not_allowedormailbox_uses_microsoft, 502mailbox_unreachableand 429mailbox_checks_limited.childrenis filled here and byget.listreturns it empty.Not retried automatically.
Also available in
imports.resume
Resume a waiting mailbox import
resume(id, body = nil, api_key: nil, **fields) -> HashCarries on an import from a live mailbox that is waiting. One with status parked is queued again at once, without a password. One with status needs-password needs the new password, which is checked against the old mailbox before the import is queued. It picks up at the folder and message it stopped at.
An import that came from a Microsoft sign-in is resumed by signing in again on the Migrations page of the app.
Parameters
idStringRequiredImport id,
imp_followed by 24 hex characters.passwordStringThe new password of the old mailbox. Required when
statusisneeds-password.api_keyStringOverrides the client API key for this call only.
Returns
The import Hash, shaped like the one get returns, with status set to queued.
Example
parked = client.imports.resume("imp_3f9c2a7b1e4d8f60a5c7b92d") puts parked[:status] signed_in = client.imports.resume("imp_9d2c7b5a06f8d4e1b7a2c9f3", password: ENV["OLD_MAILBOX_PASSWORD"]) puts signed_in[:status]Notes
An import that is not waiting, or that reads uploaded files, is 409
not_resumable.Leaving
passwordout for an import that needs one is 400password_required, and a password the mail server does not accept is 400mailbox_login_failed.A new password counts towards the 10 sign-in attempts an hour that
check_mailboxandconnect_mailboxshare.A parked import carries on by itself at
remote[:resumeAt], so calling this only tries sooner.Not retried automatically.