PHP

$client->imports

Chaque méthode de cet espace de noms : sa signature, ses paramètres, ce qu'elle retourne et un exemple.

Méthodes

Bring an old mailbox across 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:readParcourt les résultats page par page

Signature

list(    ?string $addressId = null,    ?int $limit = null,    ?string $cursor = null,    ?string $apiKey = null,): Page

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 imports->listAll and imports->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.

Paramètres

addressIdstring: Only imports into this address.
limitint: Rows per page, a whole number from 1 to 100. The server defaults to 25.
cursorstring: The nextCursor from the previous page, an import id. One that names no import this key can see is a 400 invalid_cursor.
apiKeystring: Overrides the client's API key for this call only.

Retourne

A Page of import arrays, with items, hasMore and nextCursor.

Exemple

$page = $client->imports->list(addressId: 'addr_5d1c9e3a7b2f4e60a8c1d3b9', limit: 10); foreach ($page as $import) {    echo $import['id'], ' ', $import['status'], ': ', $import['counts']['imported'], ' imported, ', $import['counts']['duplicate'], ' duplicates', PHP_EOL;}

Remarques

A GET is retried automatically on network failure and on 408, 429, 500, 502, 503 and 504 responses, up to the client's maxRetries.

Aussi disponible dans

API: GET /imports
TypeScript: imports.list()
Python: imports.list()
Ruby: imports.list
CLI: openemail imports list

`imports->listAll`

Collect every mailbox import into one array

threads:readParcourt les résultats page par page

Signature

listAll(    ?string $addressId = null,    ?int $limit = null,    ?string $cursor = null,    ?string $apiKey = null,): array

Follows nextCursor from page to page and returns 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.

Paramètres

addressIdstring: Only imports into this address.
limitint: Page size per request, from 1 to 100, defaulting to 25 on the server.
cursorstring: An import id to start after, skipping everything newer.
apiKeystring: Overrides the client's API key for every page of this walk.

Retourne

A list of import arrays holding every import across all pages.

Exemple

$imports = $client->imports->listAll(); $imported = array_sum(array_map(static fn(array $import): int => (int) $import['counts']['imported'], $imports)); echo $imported, ' messages imported across ', count($imports), ' imports', PHP_EOL;

Remarques

A failure on any page throws out of the whole call, and none of the pages already read are returned.

Aussi disponible dans

API: GET /imports
TypeScript: imports.listAll()
Python: imports.list_all()
Ruby: imports.list_all

`imports->iterate`

Stream mailbox imports one at a time

threads:readParcourt les résultats page par page

Signature

iterate(    ?string $addressId = null,    ?int $limit = null,    ?string $cursor = null,    ?string $apiKey = null,): Generator

Returns a Generator that yields imports one at a time, newest first, and requests the next page only once the current one is used up. Breaking out of the foreach stops the requests.

Paramètres

addressIdstring: Only imports into this address.
limitint: Page size per request, from 1 to 100, defaulting to 25 on the server.
cursorstring: An import id to start after, skipping everything newer.
apiKeystring: Overrides the client's API key for every page of this walk.

Retourne

A Generator that yields one import array per step.

Exemple

foreach ($client->imports->iterate(addressId: 'addr_5d1c9e3a7b2f4e60a8c1d3b9') as $import) {    if ($import['status'] === 'failed') {        echo $import['id'], ' failed: ', $import['lastError'], PHP_EOL;    }}

Remarques

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

Aussi disponible dans

API: GET /imports
TypeScript: imports.iterate()
Python: imports.iterate()
Ruby: imports.iterate

`imports->get`

Read one mailbox import

threads:read

Signature

get(string $id, ?string $apiKey = null): array

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 id from another workspace answers exactly like one that never existed, with 404.

Paramètres

idstringObligatoire: Import id, imp_ followed by 24 hex characters.
apiKeystring: Overrides the client's API key for this call only.

Retourne

An array with id, addressId, address, status, options, files, formats, chunkBytes, totalBytes, processedBytes, counts, labelsCreated, labelsSkipped, lastError, uploadDeleted, createdAt, startedAt and finishedAt.

Exemple

$import = $client->imports->get('imp_4f8a2c6e1b9d3a7f5c0e2b84'); while (in_array($import['status'], ['queued', 'running'], true)) {    echo $import['processedBytes'], ' of ', $import['totalBytes'], ' bytes read, ', $import['counts']['imported'], ' messages in', PHP_EOL;     sleep(10);     $import = $client->imports->get($import['id']);} echo $import['status'], ' ', $import['lastError'] ?? '', PHP_EOL;

Remarques

lastError is set only when status is failed.

Aussi disponible dans

API: GET /imports/{id}
TypeScript: imports.get()
Python: imports.get()
Ruby: imports.get
CLI: openemail imports get

`imports->create`

Create a mailbox import and get its upload plan

threads:write

Signature

create(array $body, ?string $apiKey = null): array

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

imports->importFiles does create, upload and start in one call.

Paramètres

addressIdstringObligatoire: The address the mail belongs to. It must be an address this workspace owns and this key may act for.
filesarrayObligatoire: Each file as an array with name and bytes, its size, 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.
apiKeystring: Overrides the client's API key for this call only.

Retourne

An array for the import with status set to uploading, chunkBytes and each file's chunks.

Exemple

$import = $client->imports->create([    'addressId' => 'addr_5d1c9e3a7b2f4e60a8c1d3b9',    'files' => [['name' => 'mailbox.mbox', 'bytes' => filesize('mailbox.mbox')]],    'options' => ['keepInbox' => true, 'includeSpam' => false],]); echo $import['id'], ' takes ', $import['files'][0]['chunks'], ' parts of ', $import['chunkBytes'], ' bytes', PHP_EOL;

Remarques

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

Aussi disponible dans

API: POST /imports
TypeScript: imports.create()
Python: imports.create()
Ruby: imports.create
CLI: openemail imports create

`imports->uploadState`

See which parts of the upload have arrived

threads:write

Signature

uploadState(string $id, ?string $apiKey = null): array

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.

Paramètres

idstringObligatoire: Import id, imp_ followed by 24 hex characters.
apiKeystring: Overrides the client's API key for this call only.

Retourne

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

Exemple

$import = $client->imports->get('imp_4f8a2c6e1b9d3a7f5c0e2b84');$received = $client->imports->uploadState($import['id'])['received'][0] ?? []; for ($chunk = 0; $chunk < $import['files'][0]['chunks']; $chunk++) {    if (!in_array($chunk, $received, true)) {        $part = file_get_contents('mailbox.mbox', false, null, $chunk * $import['chunkBytes'], $import['chunkBytes']);         $client->imports->uploadChunk($import['id'], 0, $chunk, (string) $part);    }} $client->imports->start($import['id']);

Aussi disponible dans

API: GET /imports/{id}/upload
TypeScript: imports.uploadState()
Python: imports.upload_state()
Ruby: imports.upload_state
CLI: openemail imports upload-state

`imports->uploadChunk`

Upload one part of an import file

threads:write

Signature

uploadChunk(string $id, int $file, int $chunk, mixed $data, ?string $apiKey = null): array

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.

Paramètres

idstringObligatoire: Import id, imp_ followed by 24 hex characters.
fileintObligatoire: The file index, in the order given to imports->create.
chunkintObligatoire: The part index, from 0.
datastring|resource|SplFileInfo|StreamInterfaceObligatoire: The part as a string of bytes, a stream resource, an SplFileInfo or a PSR-7 stream. All of it is sent, so pass the part alone rather than the whole file.
apiKeystring: Overrides the client's API key for this call only.

Retourne

An array echoing file, chunk and the bytes stored.

Exemple

$import = $client->imports->create([    'addressId' => 'addr_5d1c9e3a7b2f4e60a8c1d3b9',    'files' => [['name' => 'mailbox.mbox', 'bytes' => filesize('mailbox.mbox')]],]); for ($chunk = 0; $chunk < $import['files'][0]['chunks']; $chunk++) {    $part = file_get_contents('mailbox.mbox', false, null, $chunk * $import['chunkBytes'], $import['chunkBytes']);     $stored = $client->imports->uploadChunk($import['id'], 0, $chunk, (string) $part);     echo 'Part ', $stored['chunk'], ': ', $stored['bytes'], ' bytes', PHP_EOL;} $client->imports->start($import['id']);

Remarques

Retried automatically on network failure and on 408, 429, 500, 502, 503 and 504 responses, since a repeated part replaces itself.

Aussi disponible dans

API: PUT /imports/{id}/files/{file}/chunks/{chunk}
TypeScript: imports.uploadChunk()
Python: imports.upload_chunk()
Ruby: imports.upload_chunk
CLI: openemail imports upload-chunk

`imports->start`

Queue an import once its files are uploaded

threads:write

Signature

start(string $id, ?string $apiKey = null): array

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.

Paramètres

idstringObligatoire: Import id, imp_ followed by 24 hex characters.
apiKeystring: Overrides the client's API key for this call only.

Retourne

An array for the import with status set to queued.

Exemple

use OpenEmail\Exception\ApiException; try {    $import = $client->imports->start('imp_4f8a2c6e1b9d3a7f5c0e2b84');     echo $import['status'], ', read as ', implode(', ', $import['formats']), PHP_EOL;} catch (ApiException $error) {    if ($error->errorCode !== 'missing_chunks') {        throw $error;    }     print_r($client->imports->uploadState('imp_4f8a2c6e1b9d3a7f5c0e2b84')['received']);}

Aussi disponible dans

API: POST /imports/{id}/start
TypeScript: imports.start()
Python: imports.start()
Ruby: imports.start
CLI: openemail imports start

`imports->cancel`

Cancel a mailbox import

threads:write

Signature

cancel(string $id, ?string $apiKey = null): array

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

Paramètres

idstringObligatoire: Import id, imp_ followed by 24 hex characters.
apiKeystring: Overrides the client's API key for this call only.

Retourne

An array for the import with status set to cancelled.

Exemple

use OpenEmail\Exception\ConflictException; try {    $import = $client->imports->cancel('imp_4f8a2c6e1b9d3a7f5c0e2b84');     echo $import['status'], ', ', $import['counts']['imported'], ' messages stay', PHP_EOL;} catch (ConflictException) {    echo 'The import already finished', PHP_EOL;}

Aussi disponible dans

API: POST /imports/{id}/cancel
TypeScript: imports.cancel()
Python: imports.cancel()
Ruby: imports.cancel
CLI: openemail imports cancel

`imports->listFailures`

List what an import could not bring across

threads:read

Signature

listFailures(string $id, ?int $after = null, ?int $limit = null, ?string $apiKey = null): array

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.

Paramètres

idstringObligatoire: Import id, imp_ followed by 24 hex characters.
afterint: The nextCursor of the previous page.
limitint: At most 100, the default.
apiKeystring: Overrides the client's API key for this call only.

Retourne

An array with data, a list of failures, and nextCursor, the number to pass as after: for the next page, or null after the last one.

Exemple

$failures = $client->imports->listFailures('imp_4f8a2c6e1b9d3a7f5c0e2b84', limit: 50); foreach ($failures['data'] as $failure) {    echo $failure['reason'], ': ', $failure['subject'] ?? $failure['source'], PHP_EOL;} if ($failures['nextCursor'] !== null) {    $more = $client->imports->listFailures('imp_4f8a2c6e1b9d3a7f5c0e2b84', after: $failures['nextCursor'], limit: 50);     echo count($more['data']), ' more on the next page', PHP_EOL;}

Aussi disponible dans

API: GET /imports/{id}/failures
TypeScript: imports.listFailures()
Python: imports.list_failures()
Ruby: imports.list_failures
CLI: openemail imports list-failures

`imports->deleteUpload`

Delete the files uploaded for an import

threads:write

Signature

deleteUpload(string $id, ?string $apiKey = null): array

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.

Paramètres

idstringObligatoire: Import id, imp_ followed by 24 hex characters.
apiKeystring: Overrides the client's API key for this call only.

Retourne

An array for the import with uploadDeleted set to true.

Exemple

$import = $client->imports->deleteUpload('imp_4f8a2c6e1b9d3a7f5c0e2b84'); echo $import['uploadDeleted'] ? 'The uploaded files are gone' : 'The files are still stored', ', status ', $import['status'], PHP_EOL;

Aussi disponible dans

API: DELETE /imports/{id}/upload
TypeScript: imports.deleteUpload()
Python: imports.delete_upload()
Ruby: imports.delete_upload
CLI: openemail imports delete-upload

`imports->importFiles`

Create, upload and start an import in one call

threads:write

Signature

importFiles(array $input, ?string $apiKey = null): array

Creates the import, uploads every file part by part and starts it, reporting progress through onProgress. Pass each file's data as a string of bytes, a stream resource, an SplFileInfo or a PSR-7 stream. Parts are sliced from it, so an SplFileInfo or a seekable stream is read one part at a time and never held in memory whole.

It returns once the import is queued. Poll imports->get to follow it.

Paramètres

addressIdstringObligatoire: The address the mail belongs to.
filesarrayObligatoire: Each file as an array with name and data. A file whose data is not one of the byte sources above throws an InvalidArgumentException before anything is sent.
optionsarray: keepInbox, includeSpam and includeTrash, as for imports->create.
onProgresscallable: Called after each part with two integers: the bytes uploaded so far and the total.
apiKeystring: Overrides the client's API key for every request of this call.

Retourne

An array for the import with status set to queued.

Exemple

$import = $client->imports->importFiles([    'addressId' => 'addr_5d1c9e3a7b2f4e60a8c1d3b9',    'files' => [        ['name' => 'takeout.tgz', 'data' => new \SplFileInfo('takeout.tgz')],        ['name' => 'mailbox.mbox', 'data' => fopen('mailbox.mbox', 'rb')],    ],    'options' => ['keepInbox' => false],    'onProgress' => static function (int $uploaded, int $total): void {        echo $uploaded, ' of ', $total, ' bytes uploaded', PHP_EOL;    },]); echo $import['id'], ' is ', $import['status'], PHP_EOL;

Remarques

If a part still fails after its retries, the exception is thrown and the import is left in uploading. imports->uploadState then tells you which parts to send before calling imports->start.

Aussi disponible dans

API: POST /imports
TypeScript: imports.importFiles()
Python: imports.import_files()
Ruby: imports.import_files
CLI: openemail imports import-files

$client->imports

Méthodes

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Paramètres

Retourne

Exemple

Aussi disponible dans

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Paramètres

Retourne

Exemple

Aussi disponible dans

Paramètres

Retourne

Exemple

Aussi disponible dans

Paramètres

Retourne

Exemple

Aussi disponible dans

Paramètres

Retourne

Exemple

Aussi disponible dans

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Votre boîte de réception,à vos conditions.

Votre boîte de réception,
à vos conditions.