client.Imports

Cada método deste espaço de nomes: a sua assinatura, os seus parâmetros, o que devolve e um exemplo.

Métodos

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

threads:readPercorre os resultados por páginas

Assinatura

List(ctx context.Context, opts ...openemail.RequestOption) (*openemail.Page, error)

Returns one page of the imports in the workspace, newest first. Nothing is dropped from the history, so following NextCursor while HasMore is true reaches the very first import, and ListAll 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.

Parâmetros

openemail.WithAddressIDstring: Only imports into this address.
openemail.WithLimitint: Rows per page, a whole number from 1 to 100. The server defaults to 25.
openemail.WithCursorstring: The NextCursor from the previous page, an import id. One that names no import this key can see is a 400 invalid_cursor.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

A *openemail.Page with Items, HasMore and NextCursor.

Exemplo

page, err := client.Imports.List(ctx, openemail.WithLimit(50))if err != nil {	return err} for _, job := range page.Items {	fmt.Println(job.String("address"), job.String("status"), job.Object("counts").Int("imported"))} fmt.Println(page.HasMore, page.NextCursor)

Notas

A GET is retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, up to the client's openemail.WithMaxRetries, and on a 429 only when it carries a Retry-After of a minute or less.

Também disponível em

API: GET /imports
TypeScript: imports.list()
Python: imports.list()
Ruby: imports.list
PHP: imports->list
Java: imports().list
C#: Imports.ListAsync
CLI: openemail imports list

`Imports.ListAll`

Collect every mailbox import into one slice

threads:readPercorre os resultados por páginas

Assinatura

ListAll(ctx context.Context, opts ...openemail.RequestOption) ([]openemail.Object, error)

Follows NextCursor from page to page and returns with every import in the workspace, newest first, narrowed to one address when addressId is given. A key limited to particular addresses sees only imports into those addresses.

Parâmetros

openemail.WithAddressIDstring: Only imports into this address.
openemail.WithLimitint: Page size per request, from 1 to 100, defaulting to 25 on the server.
openemail.WithCursorstring: An import id to start after, skipping everything newer.
openemail.WithAPIKeystring: Overrides the client API key for every page of this walk.

Devolve

A []openemail.Object holding every import across all pages.

Exemplo

imports, err := client.Imports.ListAll(ctx)if err != nil {	return err} for _, job := range imports {	fmt.Println(job.String("status"))}

Notas

A failure on any page fails the whole call.

Também disponível em

API: GET /imports
TypeScript: imports.listAll()
Python: imports.list_all()
Ruby: imports.list_all
PHP: imports->listAll
Java: imports().listAll
C#: Imports.ListAllAsync

`Imports.Iterate`

Stream mailbox imports one at a time

threads:readPercorre os resultados por páginas

Assinatura

Iterate(ctx context.Context, opts ...openemail.RequestOption) *openemail.Iterator

Returns an iterator that yields imports individually, newest first, and requests the next page only once the current one is drained. Breaking out of the loop stops the requests.

Parâmetros

openemail.WithAddressIDstring: Only imports into this address.
openemail.WithLimitint: Page size per request, from 1 to 100, defaulting to 25 on the server.
openemail.WithCursorstring: An import id to start after, skipping everything newer.
openemail.WithAPIKeystring: Overrides the client API key for every page of this walk.

Devolve

An *openemail.Iterator yielding one import per step.

Exemplo

for job, err := range client.Imports.Iterate(ctx, openemail.WithAddressID("addr_2b7e")).All() {	if err != nil {		return err	} 	fmt.Println(job.String("status"), job.String("id"), job.Object("counts").Int("imported"))}

Notas

The iterator is lazy, so an abandoned loop costs only the pages you consumed.

Também disponível em

API: GET /imports
TypeScript: imports.iterate()
Python: imports.iterate()
Ruby: imports.iterate
PHP: imports->iterate
Java: imports().iterate
C#: Imports.IterateAsync

`Imports.Get`

Read one mailbox import

threads:read

Assinatura

Get(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)

Returns 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: null and no children.

An id from another workspace answers exactly like one that never existed, with 404.

Parâmetros

idstringObrigatório: Import id, imp_ followed by 24 hex characters.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

An openemail.Object.

Exemplo

item, err := client.Imports.Get(ctx, "imp_3f9c2a7b1e4d8f60a5c7b92d")if err != nil {	return err} fmt.Println(item.String("status"), item.Int("processedBytes"), item.Int("totalBytes"))

Notas

lastError is set only when status is failed.

Também disponível em

API: GET /imports/{id}
TypeScript: imports.get()
Python: imports.get()
Ruby: imports.get
PHP: imports->get
Java: imports().get
C#: Imports.GetAsync
CLI: openemail imports get

`Imports.Create`

Create a mailbox import and get its upload plan

threads:write

Assinatura

Create(ctx context.Context, body openemail.Body, opts ...openemail.RequestOption) (openemail.Object, error)

Creates an import into one address of the workspace and returns it with status: uploading. Each file is uploaded in parts of chunkBytes, files[i].chunks of them, through UploadChunk, 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.

ImportFiles does create, upload and start in one call.

Parâmetros

addressIdstringObrigatório: The address the mail belongs to. It must be an address this workspace owns and this key may act for.
files[]openemail.BodyObrigatório: Each file as a map with name and bytes, 1 to 50 of them, each at most 100 GB.
options.keepInboxbool: Default true: mail that was in the old inbox lands in Inbox with its unread state. False files everything under Archive.
options.includeSpambool: Default false.
options.includeTrashbool: Default false.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

An openemail.Object with status: uploading, chunkBytes and each file's chunks.

Exemplo

item, err := client.Imports.Create(ctx, openemail.Body{	"addressId": "addr_2b7e",	"files": []openemail.Body{		{"name": "takeout-001.zip", "bytes": 2147483648},	},})if err != nil {	return err} fmt.Println(item.Int("chunkBytes"))

Notas

An address with an import already queued or running is 409 already_running.
Not retried automatically.

Também disponível em

API: POST /imports
TypeScript: imports.create()
Python: imports.create()
Ruby: imports.create
PHP: imports->create
Java: imports().create
C#: Imports.CreateAsync
CLI: openemail imports create

`Imports.UploadState`

See which parts of the upload have arrived

threads:write

Assinatura

UploadState(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)

For 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.

Parâmetros

idstringObrigatório: Import id, imp_ followed by 24 hex characters.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

An openemail.Object with received, one sorted array of part indexes per file.

Exemplo

state, err := client.Imports.UploadState(ctx, "imp_3f9c2a7b1e4d8f60a5c7b92d")if err != nil {	return err} fmt.Println(state.String("id"), state.String("status"))

Também disponível em

API: GET /imports/{id}/upload
TypeScript: imports.uploadState()
Python: imports.upload_state()
Ruby: imports.upload_state
PHP: imports->uploadState
Java: imports().uploadState
C#: Imports.UploadStateAsync
CLI: openemail imports upload-state

`Imports.UploadChunk`

Upload one part of an import file

threads:write

Assinatura

UploadChunk(ctx context.Context, id string, file int, chunk int, data io.Reader, opts ...openemail.RequestOption) (openemail.Object, error)

Stores 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.

Parâmetros

idstringObrigatório: Import id, imp_ followed by 24 hex characters.
fileintObrigatório: The file index, in the order given to Create.
chunkintObrigatório: The part index, from 0.
dataio.ReaderObrigatório: The part, as an io.Reader.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

An openemail.Object echoing file, chunk and the bytes stored.

Exemplo

source, err := os.Open("mailbox.mbox")if err != nil {	return err} defer source.Close() chunk, err := client.Imports.UploadChunk(ctx, "imp_3f9c2a7b1e4d8f60a5c7b92d", 0, 0, source)if err != nil {	return err} fmt.Println(chunk.String("object"))

Notas

Retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, and on a 429 only when it carries a Retry-After of a minute or less, since a repeated part replaces itself.

Também disponível em

API: PUT /imports/{id}/files/{file}/chunks/{chunk}
TypeScript: imports.uploadChunk()
Python: imports.upload_chunk()
Ruby: imports.upload_chunk
PHP: imports->uploadChunk
Java: imports().uploadChunk
C#: Imports.UploadChunkAsync
CLI: openemail imports upload-chunk

`Imports.Start`

Queue an import once its files are uploaded

threads:write

Assinatura

Start(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)

Checks 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.

Parâmetros

idstringObrigatório: Import id, imp_ followed by 24 hex characters.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

An openemail.Object with status: queued.

Exemplo

queued, err := client.Imports.Start(ctx, "imp_3f9c2a7b1e4d8f60a5c7b92d")if err != nil {	return err} fmt.Println(queued.String("status"))

Também disponível em

API: POST /imports/{id}/start
TypeScript: imports.start()
Python: imports.start()
Ruby: imports.start
PHP: imports->start
Java: imports().start
C#: Imports.StartAsync
CLI: openemail imports start

`Imports.Cancel`

Cancel a mailbox import

threads:write

Assinatura

Cancel(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)

Stops an import at its next checkpoint. Mail already imported stays in the mailbox. A finished import is 409 not_cancellable.

Parâmetros

idstringObrigatório: Import id, imp_ followed by 24 hex characters.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

An openemail.Object with status: cancelled.

Exemplo

job, err := client.Imports.Cancel(ctx, "imp_3f9c2a7b1e4d8f60a5c7b92d")if err != nil {	return err} fmt.Println(job.String("id"), job.String("status"))

Também disponível em

API: POST /imports/{id}/cancel
TypeScript: imports.cancel()
Python: imports.cancel()
Ruby: imports.cancel
PHP: imports->cancel
Java: imports().cancel
C#: Imports.CancelAsync
CLI: openemail imports cancel

`Imports.ListFailures`

List what an import could not bring across

threads:read

Assinatura

ListFailures(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)

Each 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.

Parâmetros

idstringObrigatório: Import id, imp_ followed by 24 hex characters.
openemail.WithAfterint: The nextCursor of the previous page.
openemail.WithLimitint: At most 100, the default.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

An openemail.Object with data and nextCursor.

Exemplo

page, err := client.Imports.ListFailures(ctx, "imp_3f9c2a7b1e4d8f60a5c7b92d")if err != nil {	return err} fmt.Println(page.String("object"))

Também disponível em

API: GET /imports/{id}/failures
TypeScript: imports.listFailures()
Python: imports.list_failures()
Ruby: imports.list_failures
PHP: imports->listFailures
Java: imports().listFailures
C#: Imports.ListFailuresAsync
CLI: openemail imports list-failures

`Imports.DeleteUpload`

Delete the files uploaded for an import

threads:write

Assinatura

DeleteUpload(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)

Removes 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.

Parâmetros

idstringObrigatório: Import id, imp_ followed by 24 hex characters.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

An openemail.Object with uploadDeleted: true.

Exemplo

job, err := client.Imports.DeleteUpload(ctx, "imp_3f9c2a7b1e4d8f60a5c7b92d")if err != nil {	return err} fmt.Println(job.String("id"), job.String("status"))

Também disponível em

API: DELETE /imports/{id}/upload
TypeScript: imports.deleteUpload()
Python: imports.delete_upload()
Ruby: imports.delete_upload
PHP: imports->deleteUpload
Java: imports().deleteUpload
C#: Imports.DeleteUploadAsync
CLI: openemail imports delete-upload

`Imports.ImportFiles`

Create, upload and start an import in one call

threads:write

Assinatura

ImportFiles(ctx context.Context, input openemail.Body, opts ...openemail.RequestOption) (openemail.Object, error)

Creates the import, uploads every file part by part and starts it, reporting progress through onProgress. Pass each file as a []byte or an io.Reader. A reader is read into memory before the parts are cut from it.

It returns once the import is queued. Poll Get to follow it.

Parâmetros

addressIdstringObrigatório: The address the mail belongs to.
files[]openemail.BodyObrigatório: Each file as a map with name and data.
optionsopenemail.Body: keepInbox, includeSpam and includeTrash, as for Create.
onProgressany: Called after each part with the bytes uploaded and the total.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

An openemail.Object with status: queued.

Exemplo

archive, err := os.Open("takeout.zip")if err != nil {	return err} defer archive.Close() job, err := client.Imports.ImportFiles(ctx, openemail.Body{	"addressId": "addr_2b7e",	"files": []openemail.Body{		{"name": "takeout-001.zip", "data": archive},	},	"onProgress": func(uploaded, total int) {		fmt.Println(uploaded, "of", total, "bytes")	},})if err != nil {	return err} fmt.Println(job.ID(), job.String("status"))

Notas

If a part fails after its retries, the import is left in uploading; UploadState then tells you which parts to send before calling Start.

Também disponível em

API: POST /imports
TypeScript: imports.importFiles()
Python: imports.import_files()
Ruby: imports.import_files
PHP: imports->importFiles
Java: imports().importFiles
C#: Imports.ImportFilesAsync
CLI: openemail imports import-files

`Imports.DiscoverMailbox`

Find the mail server for an address

threads:write

Assinatura

DiscoverMailbox(ctx context.Context, email string, opts ...openemail.RequestOption) (openemail.Object, error)

Looks up where the mailbox behind an address lives, so an import can connect to it. It tries the providers OpenEmail 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 null when nothing was found: ask for the host and port and pass them to CheckMailbox. signIn says what the mailbox takes. app-password and password are what CheckMailbox and ConnectMailbox 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.

Parâmetros

emailstringObrigatório: The address of the old mailbox.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

An openemail.Object with provider, signIn, server, source, username and whether contacts and calendars can come across too.

Exemplo

settings, err := client.Imports.DiscoverMailbox(ctx, "[email protected]")if err != nil {	return err} if settings.String("signIn") == "microsoft" {	fmt.Println("Connect this mailbox from the Migrations page of the app") 	return nil} fmt.Println(settings.String("provider"), settings.String("signIn"), settings.Object("server").String("host"))

Notas

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 openemail.WithMaxRetries, and on a 429 only when it carries a Retry-After of a minute or less.

Também disponível em

API: GET /imports/mailbox-settings
TypeScript: imports.discoverMailbox()
Python: imports.discover_mailbox()
Ruby: imports.discover_mailbox
PHP: imports->discoverMailbox
Java: imports().discoverMailbox
C#: Imports.DiscoverMailboxAsync
CLI: openemail imports discover-mailbox

`Imports.CheckMailbox`

Check a mailbox before importing it

threads:write

Assinatura

CheckMailbox(ctx context.Context, body openemail.Body, opts ...openemail.RequestOption) (openemail.Object, error)

Signs 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 DiscoverMailbox does. Only port 993 with TLS, or port 143 with STARTTLS, is accepted. Each person may make 10 sign-in attempts an hour across CheckMailbox, ConnectMailbox and Resume, and every refused sign-in reads the same, whatever the reason.

Parâmetros

emailstringObrigatório: The address of the old mailbox.
passwordstringObrigatório: The password of the old mailbox, or an app password where DiscoverMailbox answers signIn: app-password.
hoststring: The IMAP host, such as imap.example.com. It has to be a public host. Left out, the server is looked up from the address.
portint: 993 or 143, read only with host. Left out, it follows security: 993 for tls and 143 for starttls.
securitystring: tls or starttls, read only with host. Left out, it follows port, and is tls when both are left out.
usernamestring: The name to sign in with. Left out, it is the username that DiscoverMailbox answers, usually the address.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

An openemail.Object with the server and username that worked, up to 200 folders with their role, messages and whether an import with the default options reads them, and the total messages an import would read.

Exemplo

check, err := client.Imports.CheckMailbox(ctx, openemail.Body{	"email":    "[email protected]",	"password": os.Getenv("OLD_MAILBOX_PASSWORD"),})if err != nil {	return err} included := 0 for _, folder := range check.Objects("folders") {	if folder.Bool("included") {		included++	}} fmt.Println(check.Int("messages"), "messages in", included, "folders")

Notas

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: send host. A host that is not public, or a port other than 993 or 143, is a 400 mailbox_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 429 mailbox_checks_limited.
Spam and bin folders come back with included: false, since an import reads them only when asked to.
Not retried automatically.

Também disponível em

API: POST /imports/mailbox/check
TypeScript: imports.checkMailbox()
Python: imports.check_mailbox()
Ruby: imports.check_mailbox
PHP: imports->checkMailbox
Java: imports().checkMailbox
C#: Imports.CheckMailboxAsync
CLI: openemail imports check-mailbox

`Imports.ConnectMailbox`

Import a live mailbox

threads:write

Assinatura

ConnectMailbox(ctx context.Context, body openemail.Body, opts ...openemail.RequestOption) (openemail.Object, error)

Starts 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. One import may run into an address at a time.

Parâmetros

addressIdstringObrigatório: The address the mail belongs to. It must be an address this workspace owns and this key may act for.
emailstringObrigatório: The address of the old mailbox.
passwordstringObrigatório: The password of the old mailbox, or an app password where DiscoverMailbox answers signIn: app-password.
hoststring: The IMAP host, such as imap.example.com. It has to be a public host. Left out, the server is looked up from the address.
portint: 993 or 143, read only with host. Left out, it follows security: 993 for tls and 143 for starttls.
securitystring: tls or starttls, read only with host. Left out, it follows port, and is tls when both are left out.
usernamestring: The name to sign in with. Left out, it is the username that DiscoverMailbox answers, usually the address.
options.keepInboxbool: Default true: mail that was in the old inbox lands in Inbox with its unread state. False files everything under Archive.
options.includeSpambool: Default false.
options.includeTrashbool: Default false.
contactsbool: True brings the address book across too, where the provider offers it. Needs contacts:write.
calendarsbool: True brings the calendars across too, where the provider offers them. Needs calendar:write.
rerunOfstring: The id of a finished import of the same mailbox, at most 30 days old. Only mail that arrived since is fetched.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

An openemail.Object with status: queued, source: imap, the remote mailbox it reads and the children it started.

Exemplo

item, err := client.Imports.ConnectMailbox(ctx, openemail.Body{	"addressId": "addr_2b7e",	"email":     "[email protected]",	"password":  os.Getenv("OLD_MAILBOX_PASSWORD"),	"contacts":  true,	"calendars": true,})if err != nil {	return err} fmt.Println(item.String("status"), item.Object("remote").String("host"), len(item.Objects("children")))

Notas

An address with an import already under way is 409 already_running, and an import named in rerunOf that cannot be continued is 409 rerun_not_available.
An address outside the workspace is 404 address_not_found, and one the key may not act for is 403 address_not_allowed.
The sign-in is checked before anything is queued, so it fails as CheckMailbox does: 400 mailbox_login_failed, mailbox_settings_unknown, mailbox_host_not_allowed or mailbox_uses_microsoft, 502 mailbox_unreachable and 429 mailbox_checks_limited.
children is filled here and by Get. List returns it empty.
Not retried automatically.

Também disponível em

API: POST /imports/mailbox
TypeScript: imports.connectMailbox()
Python: imports.connect_mailbox()
Ruby: imports.connect_mailbox
PHP: imports->connectMailbox
Java: imports().connectMailbox
C#: Imports.ConnectMailboxAsync
CLI: openemail imports connect-mailbox

`Imports.Resume`

Resume a waiting mailbox import

threads:write

Assinatura

Resume(ctx context.Context, id string, body openemail.Body, opts ...openemail.RequestOption) (openemail.Object, error)

Carries on an import from a live mailbox that is waiting. One with status: parked is queued again at once, without a body. 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.

Parâmetros

idstringObrigatório: Import id, imp_ followed by 24 hex characters.
passwordstring: The new password of the old mailbox. Required when status is needs-password.
openemail.WithAPIKeystring: Overrides the client API key for this call only.

Devolve

An openemail.Object with status: queued.

Exemplo

parked, err := client.Imports.Resume(ctx, "imp_3f9c2a7b1e4d8f60a5c7b92d", nil)if err != nil {	return err} fmt.Println(parked.String("status")) signedIn, err := client.Imports.Resume(ctx, "imp_9d2c7b5a06f8d4e1b7a2c9f3", openemail.Body{	"password": os.Getenv("OLD_MAILBOX_PASSWORD"),})if err != nil {	return err} fmt.Println(signedIn.String("status"))

Notas

An import that is not waiting, or that reads uploaded files, is 409 not_resumable.
Leaving password out for an import that needs one is 400 password_required, and a password the mail server does not accept is 400 mailbox_login_failed.
A new password counts towards the 10 sign-in attempts an hour that CheckMailbox and ConnectMailbox share.
A parked import carries on by itself at remote.resumeAt, so calling this only tries sooner.
Not retried automatically.

Também disponível em

API: POST /imports/{id}/resume
TypeScript: imports.resume()
Python: imports.resume()
Ruby: imports.resume
PHP: imports->resume
Java: imports().resume
C#: Imports.ResumeAsync
CLI: openemail imports resume

client.Imports

Métodos

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Também disponível em

Parâmetros

Devolve

Exemplo

Também disponível em

Parâmetros

Devolve

Exemplo

Também disponível em

Parâmetros

Devolve

Exemplo

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

A sua caixa de entrada,nos seus termos.

A sua caixa de entrada,
nos seus termos.