Skip to the documentation
Go

client.Files

Every method in this namespace: its signature, its parameters, what it returns and an example.

Methods

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

Scopesfiles:readPages through results
Signature
List(ctx context.Context, opts ...openemail.RequestOption) (*openemail.Page, error)

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. ListAll 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.ListAttachments reads them.

Parameters

openemail.WithQstring

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

openemail.WithKindstring

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

openemail.WithDirectionstring

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.

openemail.WithAddressstring

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

openemail.WithSincetime.Time

Keeps files added at or after this moment. A time.Time.

openemail.WithUntiltime.Time

Keeps files added before this moment. A time.Time.

openemail.WithSortstring

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

openemail.WithLimitint

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

openemail.WithCursorstring

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

openemail.WithAPIKeystring

Overrides the client API key for this call only.

Returns

A *openemail.Page with Items, HasMore and NextCursor. Each item has id, filename, mimeType, sizeBytes, direction, threadId, messageId, deliveredTo, usage, deletable and createdAt.

Example

page, err := client.Files.List(ctx, openemail.WithKind("pdf"), openemail.WithSort("largest"))if err != nil {	return err} for _, file := range page.Items {	fmt.Println(file.String("filename"), file.Int("sizeBytes"))} fmt.Println(page.HasMore, page.NextCursor)

Notes

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

Also available in

API
GET /files
TypeScript
files.list()
Python
files.list()
Ruby
files.list
PHP
files->list
Java
files().list
C#
Files.ListAsync
CLI
openemail files list

Files.ListAll

Collect every file into one slice

Scopesfiles:readPages through results
Signature
ListAll(ctx context.Context, opts ...openemail.RequestOption) ([]openemail.Object, error)

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

Parameters

openemail.WithQstring

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

openemail.WithKindstring

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

openemail.WithDirectionstring

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.

openemail.WithAddressstring

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

openemail.WithSincetime.Time

Keeps files added at or after this moment. A time.Time.

openemail.WithUntiltime.Time

Keeps files added before this moment. A time.Time.

openemail.WithSortstring

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

openemail.WithLimitint

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

openemail.WithCursorstring

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

openemail.WithAPIKeystring

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

Returns

A []openemail.Object holding every file.

Example

all, err := client.Files.ListAll(ctx, openemail.WithQ("invoice"))if err != nil {	return err} for _, file := range all {	fmt.Println(file.String("id"), file.String("object"))}

Notes

  • If any page fails the call fails and the rows already fetched are discarded.

Also available in

API
GET /files
TypeScript
files.listAll()
Python
files.list_all()
Ruby
files.list_all
PHP
files->listAll
Java
files().listAll
C#
Files.ListAllAsync

Files.Iterate

Stream the files one at a time

Scopesfiles:readPages through results
Signature
Iterate(ctx context.Context, opts ...openemail.RequestOption) *openemail.Iterator

Returns an iterator 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.

Parameters

openemail.WithQstring

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

openemail.WithKindstring

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

openemail.WithDirectionstring

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.

openemail.WithAddressstring

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

openemail.WithSincetime.Time

Keeps files added at or after this moment. A time.Time.

openemail.WithUntiltime.Time

Keeps files added before this moment. A time.Time.

openemail.WithSortstring

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

openemail.WithLimitint

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

openemail.WithCursorstring

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

openemail.WithAPIKeystring

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

Returns

An *openemail.Iterator yielding one file per step.

Example

for file, err := range client.Files.Iterate(ctx, openemail.WithSort("oldest")).All() {	if err != nil {		return err	} 	fmt.Println(file.String("createdAt"), file.String("filename"))}

Notes

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

Also available in

API
GET /files
TypeScript
files.iterate()
Python
files.iterate()
Ruby
files.iterate
PHP
files->iterate
Java
files().iterate
C#
Files.IterateAsync

Files.Get

Read one file by id

Scopesfiles:read
Signature
Get(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)

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.

Parameters

idstringRequired

The id from List, file_ and 24 hex.

openemail.WithAPIKeystring

Overrides the client API key for this call only.

Returns

An openemail.Object, with usage and deletable.

Example

file, err := client.Files.Get(ctx, "file_6bb640f5b99e47deb758f1f5")if err != nil {	return err} fmt.Println(file.String("filename"), file.String("mimeType"))

Notes

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

Also available in

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

Files.Stats

Count the files and the space they take

Scopesfiles:read
Signature
Stats(ctx context.Context, opts ...openemail.RequestOption) (openemail.Object, error)

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.

Parameters

openemail.WithAPIKeystring

Overrides the client API key for this call only.

Returns

An openemail.Object with totals, received, sent and uploaded, each a map with files and bytes, then types, byDay, addresses and links.

Example

stats, err := client.Files.Stats(ctx)if err != nil {	return err} fmt.Println(stats.Object("totals").Int("files"), stats.Object("totals").Int("bytes"), stats.Object("uploaded").Int("files"))

Notes

  • 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 null when none was ever fetched. Scanners and link previewers are left out of the count.

Also available in

API
GET /files/stats
TypeScript
files.stats()
Python
files.stats()
Ruby
files.stats
PHP
files->stats
Java
files().stats
C#
Files.StatsAsync
CLI
openemail files stats

Files.Download

Fetch the bytes of a file

Scopesfiles:read
Signature
Download(ctx context.Context, id string, opts ...openemail.RequestOption) ([]byte, error)

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.

Parameters

idstringRequired

The id from List.

openemail.WithAPIKeystring

Overrides the client API key for this call only.

Returns

A []byte holding the file.

Example

data, err := client.Files.Download(ctx, "file_6bb640f5b99e47deb758f1f5")if err != nil {	return err} fmt.Println(len(data), "bytes")

Notes

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

Also available in

API
GET /files/{id}/content
TypeScript
files.download()
Python
files.download()
Ruby
files.download
PHP
files->download
Java
files().download
C#
Files.DownloadAsync
CLI
openemail files download

Files.Upload

Upload a file to the Files page

Scopesfiles:write
Signature
Upload(ctx context.Context, data io.Reader, filename string, opts ...openemail.RequestOption) (openemail.Object, error)

Stores the bytes as a new file, the way the Upload button on the Files page does, and returns with it: direction is uploaded, usage is null and deletable is true. Attach it to a send as a map with fileId in Emails.Send, which is how a file larger than the inline cap goes out.

data is an io.Reader, 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. The type is openemail.WithContentType, and application/octet-stream without it. 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 null, so a narrowed key never reaches that file afterwards.

Parameters

dataio.ReaderRequired

The file: an io.Reader, not empty and at most 100 MB.

filenamestringRequired

The name the file is stored and downloaded under, such as report.pdf. A missing or blank name is refused before anything is sent.

openemail.WithContentTypestring

The MIME type, such as application/pdf. Left out, it is application/octet-stream.

openemail.WithTimeouttime.Duration

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

openemail.WithAPIKeystring

Overrides the client API key for this call only.

Returns

An openemail.Object for the new file, with direction: 'uploaded', usage: null and deletable: true.

Example

source, err := os.Open("report.pdf")if err != nil {	return err} defer source.Close() file, err := client.Files.Upload(ctx, source, "report.pdf", openemail.WithContentType("application/pdf"))if err != nil {	return err} fmt.Println(file.String("id"))

Notes

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

Also available in

API
POST /files
TypeScript
files.upload()
Python
files.upload()
Ruby
files.upload
PHP
files->upload
Java
files().upload
C#
Files.UploadAsync
CLI
openemail files upload

Files.Delete

Delete an uploaded file for good

Scopesfiles:write
Signature
Delete(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)

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.

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

Parameters

idstringRequired

The id from List.

openemail.WithAPIKeystring

Overrides the client API key for this call only.

Returns

An openemail.Object with object set to file, id and deleted set to true.

Example

removed, err := client.Files.Delete(ctx, "file_6bb640f5b99e47deb758f1f5")if err != nil {	return err} fmt.Println(removed.Bool("deleted"))

Notes

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

Also available in

API
DELETE /files/{id}
TypeScript
files.delete()
Python
files.delete()
Ruby
files.delete
PHP
files->delete
Java
files().delete
C#
Files.DeleteAsync
CLI
openemail files delete

Files.DeleteMany

Delete up to 100 files in one call

Scopesfiles:write
Signature
DeleteMany(ctx context.Context, ids []string, opts ...openemail.RequestOption) (openemail.Object, error)

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.

Parameters

ids[]stringRequired

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

openemail.WithAPIKeystring

Overrides the client API key for this call only.

Returns

An openemail.Object with object set to file_batch_delete, deleted, kept and missing. deleted and missing hold ids, and each entry of kept is a map with id, filename, usage and reason.

Example

result, err := client.Files.DeleteMany(ctx, []string{"file_6bb640f5b99e47deb758f1f5", "file_0c3e2a91d4b7f6058e1a2b3c"})if err != nil {	return err} fmt.Println(result.String("object"))

Notes

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

  • A partial result is returned rather than an error, 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 ListAll whose deletable is true and pass their ids 100 at a time.

Also available in

API
POST /files/batch-delete
TypeScript
files.deleteMany()
Python
files.delete_many()
Ruby
files.delete_many
PHP
files->deleteMany
Java
files().deleteMany
C#
Files.DeleteManyAsync
CLI
openemail files delete-many