Aller à la documentation
Ruby

client.files

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

Méthodes

Every attachment the mailbox holds, sent and received, and the files uploaded to it, with their bytes, the download links they went out as and whether each can be deleted.

files.list

List one page of the files the mailbox holds

Portéesfiles:readParcourt les résultats page par page
Signature
list(q: nil, kind: nil, direction: nil, address: nil, since: nil, until: nil, sort: nil, limit: nil, cursor: nil, api_key: nil) -> OpenEmail::Page

Returns one page of the Files page: every attachment the mailbox holds, sent and received, and every file uploaded to it, with its name, type, size, the address it came to, the thread it belongs to and whether it can be deleted. list_all collects every page and iterate walks them lazily.

Only an upload that nothing depends on can be deleted, and its deletable is true. Every other row has a usage saying what keeps it: received, sent, linked for an upload that went out as a download link that still works, or scheduled for one attached to a message that has not gone out yet.

A key limited to particular addresses or domains sees only the files that arrived at them, the same boundary the thread list uses, so it does not see files uploaded for the whole workspace. A deleted file is not listed.

The index starts from the day it shipped, so an older mailbox lists what has arrived since. Older attachments are still on their messages, where threads.list_attachments reads them.

Paramètres

qString

Searches the file name and its type. Words match loosely, and a close spelling is tried when nothing matches exactly.

kindString

Keeps one kind: image, pdf, audio, video or text, the choices of the filter on the Files page.

directionString

Keeps one direction: inbound for files that arrived on a message, outbound for files that went out on one, uploaded for files put on the Files page.

addressString

Keeps the files of one address, the deliveredTo of the file, compared without regard to case.

sinceTime, Date or String

Keeps files added at or after this moment. A Time or an ISO 8601 String.

untilTime, Date or String

Keeps files added before this moment. A Time or an ISO 8601 String.

sortString

newest (the default), oldest, largest or name. A cursor carries on in the order it was handed out in.

limitInteger

Page size, from 1 to 100. The server defaults to 25.

cursorString

The next_cursor of the previous page. Leave it out for the first page.

api_keyString

Overrides the client API key for this call only.

Retourne

An OpenEmail::Page of Hashes, with items, has_more? and next_cursor. Each item has id, filename, mimeType, sizeBytes, direction, threadId, messageId, deliveredTo, usage, deletable and createdAt.

Exemple

page = client.files.list(kind: "pdf", sort: "largest") p page.items.map { |file| [file[:filename], file[:sizeBytes]] }

Remarques

  • Needs files:read. Reading an email with threads:read still reads the attachments on it; files:read reads every file, uploads included.

  • The cursor is opaque and holds where the last row sat in this order. A cursor this list did not hand out, or one handed out under another sort:, is a 400 invalid_cursor.

Aussi disponible dans

API
GET /files
TypeScript
files.list()
Python
files.list()
CLI
openemail files list

files.list_all

Collect every file into one array

Portéesfiles:readParcourt les résultats page par page
Signature
list_all(q: nil, kind: nil, direction: nil, address: nil, since: nil, until: nil, sort: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>

Walks every page of list and returns every file in one Array, in the order sort: names. One request per page, with the same filters on each.

Paramètres

qString

Searches the file name and its type. Words match loosely, and a close spelling is tried when nothing matches exactly.

kindString

Keeps one kind: image, pdf, audio, video or text, the choices of the filter on the Files page.

directionString

Keeps one direction: inbound for files that arrived on a message, outbound for files that went out on one, uploaded for files put on the Files page.

addressString

Keeps the files of one address, the deliveredTo of the file, compared without regard to case.

sinceTime, Date or String

Keeps files added at or after this moment. A Time or an ISO 8601 String.

untilTime, Date or String

Keeps files added before this moment. A Time or an ISO 8601 String.

sortString

newest (the default), oldest, largest or name. A cursor carries on in the order it was handed out in.

limitInteger

Page size for each request, from 1 to 100. The server defaults to 25.

cursorString

Starts the walk after this cursor instead of the first page.

api_keyString

Overrides the client API key for every page of this walk.

Retourne

An Array of Hashes holding every file, each with the fields list returns.

Exemple

all = client.files.list_all(q: "invoice") puts all.size

Remarques

  • If any page fails, the error is raised and the rows already fetched are discarded.

Aussi disponible dans

API
GET /files
TypeScript
files.listAll()
Python
files.list_all()

files.iterate

Stream the files one at a time

Portéesfiles:readParcourt les résultats page par page
Signature
iterate(q: nil, kind: nil, direction: nil, address: nil, since: nil, until: nil, sort: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>

Returns an Enumerator that yields one file at a time, in the order sort: names, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests. Given a block, it yields each file to the block instead.

Paramètres

qString

Searches the file name and its type. Words match loosely, and a close spelling is tried when nothing matches exactly.

kindString

Keeps one kind: image, pdf, audio, video or text, the choices of the filter on the Files page.

directionString

Keeps one direction: inbound for files that arrived on a message, outbound for files that went out on one, uploaded for files put on the Files page.

addressString

Keeps the files of one address, the deliveredTo of the file, compared without regard to case.

sinceTime, Date or String

Keeps files added at or after this moment. A Time or an ISO 8601 String.

untilTime, Date or String

Keeps files added before this moment. A Time or an ISO 8601 String.

sortString

newest (the default), oldest, largest or name. A cursor carries on in the order it was handed out in.

limitInteger

Page size for each request, from 1 to 100. The server defaults to 25.

cursorString

Starts the walk after this cursor instead of the first page.

api_keyString

Overrides the client API key for every page of this walk.

Retourne

An Enumerator of Hashes, one file per step (or yields each one to a block).

Exemple

client.files.iterate(sort: "oldest") do |file|  puts "#{file[:createdAt]} #{file[:filename]}"end

Remarques

  • Pages are fetched only as they are needed, so an abandoned loop costs only the pages you consumed.

Aussi disponible dans

API
GET /files
TypeScript
files.iterate()
Python
files.iterate()

files.get

Read one file by id

Portéesfiles:read
Signature
get(id, api_key: nil) -> Hash

Returns one file: its name, type, size, whether it was sent, received or uploaded, the address it came to, the thread and message it belongs to, and whether it can be deleted. download fetches its bytes.

deletable is true only for an upload that nothing depends on. Otherwise usage says what keeps it: received or sent for a file that came in or went out on a message, linked for an upload that went out as a download link that still works, and scheduled for one attached to a message that has not gone out yet.

Paramètres

idStringObligatoire

The id from list, file_ and 24 hex.

api_keyString

Overrides the client API key for this call only.

Retourne

A Hash with the fields list returns for each file, usage and deletable included.

Exemple

file = client.files.get("file_6bb640f5b99e47deb758f1f5") puts file[:filename], file[:mimeType]

Remarques

  • A deleted file, one outside the addresses a narrowed key holds, and an unknown id all answer 404 resource_not_found.

Aussi disponible dans

API
GET /files/{id}
TypeScript
files.get()
Python
files.get()
CLI
openemail files get

files.stats

Count the files and the space they take

Portéesfiles:read
Signature
stats(api_key: nil) -> Hash

Returns the numbers on the Analytics tab of the Files page in one request: how many files the mailbox holds and how many bytes they take, in all and split into received, sent and uploaded, the file types and the addresses taking the most space, how many files arrived on each of the last 30 days, and the download links still working with how often they were fetched.

Deleted files are not counted. A key limited to particular addresses or domains counts only the files that arrived at them, so files uploaded for the whole workspace are left out of its numbers.

Paramètres

api_keyString

Overrides the client API key for this call only.

Retourne

A Hash with totals, received, sent and uploaded, each a Hash of files and bytes, then types, byDay, addresses and links.

Exemple

stats = client.files.stats puts "#{stats[:totals][:files]} files in #{stats[:totals][:bytes]} bytes, #{stats[:uploaded][:files]} of them uploaded"p stats[:types].map { |type| [type[:mimeType], type[:bytes]] }

Remarques

  • Needs files:read.

  • types holds at most the 8 types taking the most bytes and addresses at most the 6 addresses holding the most. A file uploaded for the whole workspace has no address, so it counts in the totals and never in addresses.

  • byDay covers the last 30 days in UTC, today included, and is sparse: a day on which no file arrived has no entry, so a chart must fill the gaps. Each day is YYYY-MM-DD.

  • links counts the download links that still work: shares of them, fetched downloads times in all, last at lastDownloadAt, which is nil when none was ever fetched. Scanners and link previewers are left out of the count.

Aussi disponible dans

API
GET /files/stats
TypeScript
files.stats()
Python
files.stats()
CLI
openemail files stats

files.download

Fetch the bytes of a file

Portéesfiles:read
Signature
download(id, api_key: nil) -> String

Returns the file exactly as it is stored, the same bytes the Download action on the Files page saves. The response carries the file's own Content-Type and name.

Paramètres

idStringObligatoire

The id from list.

api_keyString

Overrides the client API key for this call only.

Retourne

A binary String holding the file.

Exemple

file = client.files.get("file_6bb640f5b99e47deb758f1f5")bytes = client.files.download(file[:id]) File.binwrite(file[:filename], bytes)

Remarques

  • The whole file is held in memory, so fetch very large ones one at a time.

  • A file whose bytes are gone from storage answers 404 like a missing one.

Aussi disponible dans

API
GET /files/{id}/content
TypeScript
files.download()
Python
files.download()
CLI
openemail files download

files.upload

Upload a file to the Files page

Portéesfiles:write
Signature
upload(data, filename: nil, content_type: nil, timeout: nil, api_key: nil) -> Hash

Stores the bytes as a new file, the way the Upload button on the Files page does, and returns it: direction is uploaded, usage is nil and deletable is true. Attach it to a send as {fileId: file[:id]} in the attachments of emails.send, which is how a file larger than the inline cap goes out.

data is a binary String (File.binread), an IO or a Pathname, sent as the request body. The name travels as the filename query parameter, and it is cleaned rather than refused: characters a file name cannot hold become _, and a name longer than 255 characters is cut, keeping its extension. Left out, filename: falls back to an upload's original_filename or the file's own name, so only plain bytes need it. The type is content_type:, or an upload's own content_type when that is left out, then the type the file's extension names, and application/octet-stream without any of them. A value that is not shaped like a MIME type is stored as application/octet-stream too.

A key limited to particular addresses or domains uploads to the first address it holds, which becomes deliveredTo. An unlimited key uploads for the whole workspace and deliveredTo is nil, so a narrowed key never reaches that file afterwards.

Paramètres

dataString, IO or PathnameObligatoire

The file, as a binary String, an IO or a Pathname, not empty and at most 100 MB.

filenameString

The name the file is stored and downloaded under, such as report.pdf. Left out, it is an upload's original_filename or the file's own name, so it is needed only for plain bytes. A missing or blank name raises an ArgumentError before anything is sent.

content_typeString

The MIME type, such as application/pdf. Left out, an upload's own content_type is used, else the type the file's extension names, else application/octet-stream.

timeoutNumeric

How long the upload may take, in seconds. Left out, it is 600 seconds (10 minutes), or the client timeout when that is longer. 0 waits as long as it takes.

api_keyString

Overrides the client API key for this call only.

Retourne

A Hash for the new file, with direction: "uploaded", usage: nil and deletable: true.

Exemple

file = client.files.upload(File.binread("report.pdf"), filename: "report.pdf", content_type: "application/pdf") client.emails.send(  from: "[email protected]",  to: "[email protected]",  subject: "Your report",  text: "The report is attached.",  attachments: [{fileId: file[:id]}])

Remarques

  • Needs files:write, the same scope that deletes files.

  • The SDK does not retry an upload, because a second attempt after a lost response could store the file twice. Look for it with list before trying again.

  • An empty file is a 400 upload_empty, a program or script, judged by its name, is a 400 upload_dangerous, and a file over 100 MB is a 413 upload_too_large. A key limited to addresses that holds none is a 403 upload_no_address.

  • A workspace keeps up to 10 GB of uploads, and past that a 507 upload_storage_full holds until some are deleted. It takes 500 uploads an hour, deleted ones included, and more is a 429 upload_rate_limited. A 502 upload_failed means storage failed and nothing was kept, so it is safe to try again.

Aussi disponible dans

API
POST /files
TypeScript
files.upload()
Python
files.upload()
CLI
openemail files upload

files.delete

Delete an uploaded file for good

Portéesfiles:write
Signature
delete(id, api_key: nil) -> Hash

Removes an uploaded file: its bytes are deleted from storage and it leaves the Files page. The row stays, marked deleted, so the index knows the file existed. There is no undo.

Only an upload that nothing depends on can be deleted, the files whose deletable is true. A file that was received or sent stays with its message, and so does an upload that went out as a download link that still works or is attached to a message that has not gone out yet. Those are refused with 409 file_in_use, and the message names the file and says why. An upload that was sent inside a message can still be deleted, because the message keeps its own copy, which is listed as a separate sent file.

delete_many deletes up to 100 in one call and reports the ones it kept instead of failing.

Paramètres

idStringObligatoire

The id from list.

api_keyString

Overrides the client API key for this call only.

Retourne

A Hash with object set to file, the id, and deleted set to true.

Exemple

begin  removed = client.files.delete("file_6bb640f5b99e47deb758f1f5")  puts removed[:deleted]rescue OpenEmail::ApiError => error  raise unless error.code == "file_in_use"   puts error.messageend

Remarques

  • Needs files:write, the same scope that uploads. A key limited to some addresses may delete only files that arrived at them, so an upload made for the whole workspace answers it 404.

  • A file that is unknown, already deleted or out of reach answers 404 resource_not_found. A file in use answers 409 file_in_use with param: "id", and its usage on get says which rule keeps it.

  • The SDK does not retry a delete. A 404 on your own second attempt after a lost response means the first one worked.

Aussi disponible dans

API
DELETE /files/{id}
TypeScript
files.delete()
Python
files.delete()
CLI
openemail files delete

files.delete_many

Delete up to 100 files in one call

Portéesfiles:write
Signature
delete_many(ids, api_key: nil) -> Hash

Deletes every file in ids that can be deleted, the way delete deletes one, and reports the rest instead of failing. It is what selecting several files on the Files page and pressing Delete does.

Only an uploaded file that nothing depends on can be deleted. A file that was received or sent stays with its message, and so does an upload that went out as a download link that still works or is attached to a message that has not gone out yet. Each of those comes back in kept with its usage and a reason in plain words. An id that is unknown, already deleted or outside the addresses a narrowed key holds comes back in missing. The rule is checked again at the moment of deleting, so a file that became used in between is kept.

There is no undo.

Paramètres

idsArray<String>Obligatoire

1 to 100 file ids from list. More than 100, or none, is a 422 on ids. A repeated id counts once.

api_keyString

Overrides the client API key for this call only.

Retourne

A Hash with object set to file_batch_delete, deleted, kept and missing. deleted and missing hold ids, and each entry of kept is a Hash with id, filename, usage and reason.

Exemple

result = client.files.delete_many(["file_6bb640f5b99e47deb758f1f5", "file_0c3e2a91d4b7f6058e1a2b3c"]) puts "#{result[:deleted].size} deleted" result[:kept].each { |file| puts "#{file[:filename]} #{file[:reason]}" }

Remarques

  • Needs files:write, the same scope that uploads.

  • A partial result returns normally rather than raising, so read kept and missing to see what stayed.

  • The SDK does not retry it. Calling it again after a lost response reports the files the first call deleted in missing.

  • To clear out every upload that can go, keep the rows of list_all whose deletable is true and pass their ids 100 at a time.

Aussi disponible dans

API
POST /files/batch-delete
TypeScript
files.deleteMany()
Python
files.delete_many()
CLI
openemail files delete-many

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

Ouvrir le courrierCommencer
Produits
EntreprisesDéveloppeursIA et agentsParticuliers
OpenEmail
TarifsFonctionnalitésFonctionnalités pour développeursFonctionnalités pour agentsTéléchargerComparerIntégrationsSécurité et montée en chargeÀ proposContactPolitique de confidentialitéConditions d'utilisation
Ressources
DocumentationRéférence de l’APISDK TypeScriptSDK PythonSDK RubyLigne de commandeServeur MCPModèles d’e-mailCas d'usageÉtat
Outils
Générateur de modèles par IAVérificateur de délivrabilitéVérificateur de logo BIMIAdresse e-mail temporaireGénérateur d'enregistrement DMARCCalculateur de coût e-mail
© 2026 OpenEmail. Tous droits réservés.