client.contacts
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
The workspace address book: people it has written to, plus anybody you save yourself.
contacts.list
List the workspace contacts, most recently seen first
list(source: nil, q: nil, limit: nil, cursor: nil, api_key: nil) -> Nextmail::PageReturns one page of the workspace address book, ordered by lastSeenAt with the most recent first and contacts that have never been mailed last. source says where a row came from: manual for a contact somebody saved, in the app or through create, and auto for an address recorded when a member sent mail to it from the app composer. A saved contact stays manual when it is mailed later.
source: narrows the page to one origin, so source: "manual" is the contacts somebody saved on purpose and source: "auto" the ones the composer recorded. q: searches the name and the address.
This lists saved contacts only. list_people lists everyone the Contacts page in the app shows, the addresses seen in mail included, with thread counts.
Paging is keyset. limit: takes 1 to 200 and defaults to 50, and next_cursor goes back as cursor: while has_more? is true. Never build a cursor yourself.
Contacts belong to the whole workspace rather than to any one address, so a key limited to particular addresses or domains reads and writes the same book as every other key. An app connected by a member who reaches only some addresses is refused with 422 capability_unsupported on addressAllowlist, on every contacts, audiences and broadcasts route.
Parameters
limitIntegerRows per page, a whole number from 1 to 200. The server defaults to 50.
cursorStringThe
next_cursorfrom the previous page. Never build one yourself.sourceStringmanual,autoorform. Leave it out for the whole book.qStringSearches the name and the address, up to 200 characters. When nothing matches exactly on the first page, close spellings are returned instead, and the pages that follow keep matching the same way.
api_keyStringOverrides the client's API key for this call only.
Returns
The Nextmail::Page with items, has_more? and next_cursor. Each contact is a Hash with email, name, source, notes, attributes, photoUrl and lastSeenAt.
Example
saved = client.contacts.list(source: "manual", limit: 200) p saved.items.map { |contact| contact[:name] || contact[:email] }Notes
Mail sent through this API adds no contacts. Only sends from the app composer record recipients, and
createis the way to add one deliberately.Every member of the workspace reads and writes the same book, so a contact saved by one person is visible to the rest.
A contact that has never been mailed has
lastSeenAtnil and sorts last, after every contact with a date.Addresses are stored lower cased.
Also available in
contacts.list_all
Collect the whole address book into one array
list_all(source: nil, q: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Follows next_cursor from page to page and returns every contact in the workspace, most recently seen first and never-mailed contacts last. It takes the same source: and q: filters as list.
Everything is held in memory before the call returns, and an address book grows with every recipient the composer records. Prefer iterate when you can stop early. limit: sets the page size of each request, not the total.
Parameters
sourceStringmanual,autoorform. Leave it out for the whole book.qStringSearches the name and the address, up to 200 characters. When nothing matches exactly on the first page, close spellings are returned instead, and the pages that follow keep matching the same way.
limitIntegerPage size per request, from 1 to 200, defaulting to 50 on the server.
cursorStringA cursor from an earlier page to start after.
api_keyStringOverrides the client's API key for every page of this walk.
Returns
An Array of Hashes holding every contact across all pages.
Example
saved = client.contacts.list_all(source: "manual", limit: 200) puts "#{saved.size} contacts saved on purpose"Notes
A failure on any page raises out of the whole call, and the contacts already fetched are discarded.
Also available in
contacts.iterate
Stream the address book one contact at a time
iterate(source: nil, q: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>Returns an Enumerator that yields contacts individually, most recently seen first, or yields each one to a block when given one, 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
sourceStringmanual,autoorform. Leave it out for the whole book.qStringSearches the name and the address, up to 200 characters. When nothing matches exactly on the first page, close spellings are returned instead, and the pages that follow keep matching the same way.
limitIntegerPage size per request, from 1 to 200, defaulting to 50 on the server.
cursorStringA cursor from an earlier page to start after.
api_keyStringOverrides the client's API key for every page of this walk.
Returns
An Enumerator of Hashes, one contact per step, or yields each one to a block.
Example
client.contacts.iterate(source: "auto") do |contact| break if contact[:lastSeenAt].nil? puts "#{contact[:email]} #{contact[:lastSeenAt]}"endNotes
The Enumerator is lazy, so an abandoned loop costs only the pages you consumed.
Also available in
contacts.get
Read one contact by email address
get(email, api_key: nil) -> HashLooks up a contact by address in the workspace address book. The address is trimmed and lower cased before the lookup, so Grace@Example.com finds grace@example.com, and the SDK URL encodes it for the path.
A 404 means only that the address is not in the book. It says nothing about whether mail has been exchanged with it, since received mail never creates contacts.
Parameters
emailStringRequiredThe contact's address, matched case insensitively.
api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with email, name, source, notes, attributes, the custom fields as a Hash of keys and text values, photoUrl and lastSeenAt, plus audiences, every audience the contact is in as a Hash with id, name and builtin. builtin is default on the audience every contact belongs to and nil on one somebody created. A key that also holds forms:read gets signUps, what this address sent through sign-up forms, newest first and at most 20. Each is a Hash with id, formId, formName, status (pending or added), answers, sourceUrl, createdAt and confirmedAt.
Example
begin contact = client.contacts.get("grace@example.com") puts contact[:name], contact[:notes]rescue Nextmail::NotFoundError puts "not in the address book"endNotes
nameis nil for an address recorded automatically without a display name, andnotesis free text somebody set in the app or throughupdate.The address is the contact's identity here and on every other contacts route. There is no id in the public contract.
Also available in
contacts.create
Save a contact in the workspace address book
create(body = nil, api_key: nil, **fields) -> HashAdds one address to the workspace address book and returns the saved row. email is trimmed and lower cased before it is stored, so Grace@Example.com and grace@example.com are the same contact.
The contact is saved with source set to manual, the same value a contact typed into the app carries, and it joins the default audience as it is written. Every contact is in that audience for as long as it exists, so there is nothing to add afterwards. Name audiences of your own in audienceIds to put it in them in the same call, or add it later with audiences.add_contact. Sending audienceIds also requires the audiences:write scope, since it writes memberships as well as a contact.
An address can be in the book once. A second create for an address that is already there is refused with 409 contact_exists rather than merged, so a retry cannot quietly overwrite a name somebody edited in the app. Read the existing row with get and change it with update.
Parameters
emailStringRequiredThe address to save, trimmed and lower cased before it is stored.
nameStringDisplay name. Leave it out to save the contact without one.
notesStringFree text kept with the contact and shown beside it in the app.
attributesHashCustom fields to set, as a Hash of keys and text values such as
{plan: "team"}. A key starts with a letter and holds up to 64 letters, digits and underscores, and a value is text of up to 500 characters, trimmed before it is stored.nilor an empty string removes a field, a field you leave out keeps its value, and a contact holds at most 50.audienceIdsArray<String>Up to 25 audience ids to put the new contact in. The default audience is joined whether or not it is named. When this is present the key also needs
audiences:write, or the call is refused with 403 before anything is saved.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with email, name, source as manual, notes, attributes and lastSeenAt, which is nil until mail goes to the address from the app composer, plus audiences, every audience the contact is now in, the default one included.
Example
contact = client.contacts.create( email: "grace@example.com", name: "Grace Hopper", notes: "Met at the compiler workshop", attributes: {plan: "team"}) puts contact[:email], contact[:source]p contact[:attributes]Notes
The SDK does not retry a create after a network failure. If you retry by hand after a lost response, a 409
contact_existsmeans the first attempt landed.Contacts belong to the workspace, so the contact this creates is the one every member and every other key sees.
An id in
audienceIdsthat is not an audience of this workspace fails the whole create. Nothing is saved.A custom field that breaks a rule is 422
invalid_contact, withparamset toattributes.<key>for a bad key or a value over 500 characters and toattributesfor a 51st field. Nothing is written.
Also available in
contacts.update
Change a contact's name, notes or custom fields
update(email, patch = nil, api_key: nil, **fields) -> HashChanges the fields you send and leaves the rest alone. A key you leave out keeps its stored value, and an explicit nil clears it, so notes: nil empties the notes while an empty patch changes nothing. attributes: is merged key by key: a String sets a custom field, nil removes one and the fields you do not name are kept.
The address cannot be changed. It is the contact's identity, its path segment and the unique key of the book, so moving a contact to a new address is a delete and a create, and that new contact starts with no audience membership beyond the default one.
source and lastSeenAt are the server's to set and are not accepted here. A contact recorded automatically stays auto after you give it a name.
Parameters
emailStringRequiredThe contact's address, matched case insensitively.
nameStringNew display name.
nilclears it.notesStringNew notes.
nilclears them.attributesHashCustom fields to set, as a Hash of keys and text values such as
{plan: "team"}. A key starts with a letter and holds up to 64 letters, digits and underscores, and a value is text of up to 500 characters, trimmed before it is stored.nilor an empty string removes a field, a field you leave out keeps its value, and a contact holds at most 50.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash, the contact as it stands after the change, with audiences alongside it.
Example
contact = client.contacts.update( "grace@example.com", name: "Grace Hopper", notes: nil, attributes: {plan: "team", trial: nil}) p contact[:name], contact[:notes], contact[:attributes]Notes
The SDK retries this call after a network failure, since the same patch sent twice leaves the same contact.
An address that is not in the book is a 404, the same as
get.A custom field that breaks a rule is 422
invalid_contact, withparamset toattributes.<key>for a bad key or a value over 500 characters and toattributesfor a 51st field. Nothing is written.Audience membership is not touched here. Use
set_audiencesto set the whole list, oraudiences.add_contactandaudiences.remove_contactfor one audience.
Also available in
contacts.delete
Delete somebody from the contacts and hide the address
delete(email, api_key: nil) -> HashDoes what Delete does on the Contacts page in the app. A saved contact goes with its notes, its photo and every audience it was in, the default one included. The address is then hidden: list_people leaves it out, and mail sent to it from the app composer no longer records it as a contact. The address can be one that was only ever seen in mail, which is how you take somebody off the people list, and wasSaved says which it was.
Nothing else moves: the mail exchanged with the address stays in the mailbox, and the address can still be written to. There is no undo. create or save afterwards brings the address back as a new contact with no name, no notes and no membership beyond the default audience.
Parameters
emailStringRequiredThe contact's address, matched case insensitively.
api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with object set to contact, email, deleted set to true and wasSaved.
Example
removed = client.contacts.delete("grace@example.com") puts removed[:email], removed[:deleted]Notes
An address that is not in the book is no longer a 404: it is hidden and answers with
wasSavedfalse. Something that is not an address is a 422invalid_contact.The SDK does not retry a delete, though a second attempt is harmless: it answers with
wasSavedfalse.delete_manydeletes up to 200 addresses in one call.
Also available in
contacts.set_audiences
Set exactly which audiences a contact is in
set_audiences(email, body = nil, api_key: nil, **fields) -> HashMakes the contact's audiences match the list you send, the way the audience picker on a contact does in the app. The contact joins every listed audience it is not in yet and leaves every other one, in one transaction, and memberships it keeps keep their addedAt.
The default audience is always kept, whether or not you name it, so audienceIds: [] leaves the contact in the default audience alone. To add or remove one audience without restating the rest, use audiences.add_contact or audiences.remove_contact.
The address is trimmed and lower cased, the SDK URL encodes it for the path, and it has to be a contact already: an address that is not in the book is a 404 contact_not_found on email. Create it with create, which takes audienceIds too. An id that is not an audience of this workspace is a 404 audience_not_found on audienceIds, and nothing is changed.
Parameters
emailStringRequiredThe contact's address, matched case insensitively.
audienceIdsArray<String>RequiredEvery audience the contact should be in, up to 100 ids. A repeated id counts once. More than 100 is a 422
invalid_parameteronaudienceIds, and an empty id is the same error on that entry, such asaudienceIds.0.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash, the contact as it stands after the change, with audiences, every audience the contact is now in as a Hash with id, name and builtin, the default one included.
Example
contact = client.contacts.set_audiences( "grace@example.com", audienceIds: ["aud_9f2c4b7e1a0d63d84c5f2e7b", "aud_1c4e7a9b2d0f36e85a7c1b4d"]) p contact[:audiences].map { |audience| audience[:name] }Notes
audiences:writeis the only scope checked, because this writes memberships rather than the contact.Safe to replay: sending the same list again changes nothing. The SDK retries it after a network failure.
Read the current list with
getfirst when you mean to add one audience to what the contact already has, or useaudiences.add_contact.
Also available in
contacts.list_people
List everyone on the Contacts page, saved or seen in mail
list_people(q: nil, email: nil, sort: nil, blocked: nil, limit: nil, cursor: nil, api_key: nil) -> Nextmail::PeoplePageReturns one page of the people the Contacts page in the app lists: the saved contacts, and every address seen in mail as the sender or a recipient of a thread's newest message. Each row says whether it is saved, how many threads it shares with the mailbox and when mail last moved (lastAt). A person seen in mail and saved is one row. list is the saved contacts alone.
The addresses seen in mail are included only when the key also holds threads:read, because they are read out of the mail. Without it the page holds the saved contacts and seen is false. Deleted addresses and the mailbox's own addresses are never listed.
sort: is recent, newest mail first and saved contacts never seen in mail after them, name, by name or else by address, ignoring case, or threads, most threads first. blockedBy on each row names the workspace blocklist rule that blocks it, and blocked: true narrows the page to those rows.
Paging is keyset. limit: takes 1 to 100 and defaults to 25, and next_cursor goes back as cursor:, with the same sort:, q: and blocked:, while has_more? is true.
Parameters
qStringSearches names, addresses and notes, up to 200 characters. When nothing matches exactly on the first page, close spellings are returned instead.
emailStringOne address only, matched case insensitively: the way to read one person's thread count and last mail.
sortStringrecent(the default),nameorthreads.blockedBooleantruefor only the people the workspace blocklist blocks, whole-domain rules included.limitIntegerRows per page, 1 to 100. The server defaults to 25.
cursorStringThe
next_cursorfrom the previous page. Never build one yourself.api_keyStringOverrides the client's API key for this call only.
Returns
The Nextmail::PeoplePage with items, has_more?, next_cursor and seen. Each person is a Hash with email, displayEmail, name, saved, source, notes, attributes, which is empty for an address only seen in mail, photoUrl, threads, lastAt, createdAt, updatedAt and blockedBy.
Example
page = client.contacts.list_people(sort: "threads", limit: 50) page.items.each do |person| kind = person[:saved] ? "saved" : "seen in mail" puts "#{person[:name] || person[:email]} #{person[:threads]} #{kind}"endNotes
emailis lower cased and is what every other contacts method takes.displayEmailkeeps the capitals the newest message wrote.A malformed or stale cursor is a 400
invalid_cursor. Start again without one.A key limited to particular addresses or domains gets the saved contacts alone, with
seenfalse, even when it holdsthreads:read, because the addresses seen in mail would be read from the mail of every address in the workspace.
Also available in
contacts.list_all_people
Collect everyone on the Contacts page into one array
list_all_people(q: nil, email: nil, sort: nil, blocked: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Follows next_cursor from page to page and returns every person list_people would list, in the same order and with the same filters. It is how you count the people a blocklist blocks: client.contacts.list_all_people(blocked: true).size.
Everything is held in memory before the call returns, and a busy mailbox has seen a great many addresses. Prefer iterate_people when you can stop early.
Parameters
qStringSearches names, addresses and notes, up to 200 characters. When nothing matches exactly on the first page, close spellings are returned instead.
emailStringOne address only, matched case insensitively: the way to read one person's thread count and last mail.
sortStringrecent(the default),nameorthreads.blockedBooleantruefor only the people the workspace blocklist blocks, whole-domain rules included.limitIntegerPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorStringA cursor from an earlier page to start after.
api_keyStringOverrides the client's API key for every page of this walk.
Returns
An Array of Hashes holding every person across all pages.
Example
blocked = client.contacts.list_all_people(blocked: true, limit: 100) puts "#{blocked.size} people are blocked"Notes
A failure on any page raises out of the whole call, and the people already fetched are discarded.
seenis not reported here. Read one page withlist_peopleto learn whether the key reads the people seen in mail.
Also available in
contacts.iterate_people
Stream everyone on the Contacts page one person at a time
iterate_people(q: nil, email: nil, sort: nil, blocked: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>Returns an Enumerator that yields the people list_people lists, one at a time, or yields each one to a block when given one, 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
qStringSearches names, addresses and notes, up to 200 characters. When nothing matches exactly on the first page, close spellings are returned instead.
emailStringOne address only, matched case insensitively: the way to read one person's thread count and last mail.
sortStringrecent(the default),nameorthreads.blockedBooleantruefor only the people the workspace blocklist blocks, whole-domain rules included.limitIntegerPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorStringA cursor from an earlier page to start after.
api_keyStringOverrides the client's API key for every page of this walk.
Returns
An Enumerator of Hashes, one person per step, or yields each one to a block.
Example
client.contacts.iterate_people(sort: "recent") do |person| client.contacts.save(person[:email]) if !person[:saved] && person[:threads].to_i > 5endNotes
The Enumerator is lazy, so an abandoned loop costs only the pages you consumed.
Also available in
contacts.save
Save an address as a contact, or keep one that was recorded
save(email, body = nil, api_key: nil, **fields) -> HashDoes what Add to contacts and Keep in contacts do in the app, and is safe to call whatever state the address is in. An address that is not a contact yet becomes one with source manual. A contact recorded from a send becomes manual. A contact already saved keeps what it has. A deleted address is brought back.
name replaces the stored name and leaving it out keeps it. notes replaces the stored notes and nil clears them. attributes: sets the custom fields it names and keeps the rest. Unlike create, an address already in the book is not an error, and unlike update, an address not in the book is not one either.
Parameters
emailStringRequiredThe address, trimmed and lower cased on the server.
nameStringUp to 200 characters. Left out, the stored name is kept.
notesStringUp to 5,000 characters.
nilclears the notes, and left out, they are kept.attributesHashCustom fields to set, as a Hash of keys and text values such as
{plan: "team"}. A key starts with a letter and holds up to 64 letters, digits and underscores, and a value is text of up to 500 characters, trimmed before it is stored.nilor an empty string removes a field, a field you leave out keeps its value, and a contact holds at most 50.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash, the contact as it stands after the save, with audiences.
Example
contact = client.contacts.save("grace@example.com", name: "Grace Hopper") puts contact[:source]Notes
The server answers 201 for a new contact and 200 for one that was there. The SDK returns the contact the same way for both, so compare
createdAtwithupdatedAtif you need to tell them apart.Safe to replay, so the SDK retries it after a network failure.
A new contact joins the default audience, as it does from
create.
Also available in
contacts.delete_many
Delete up to 200 contacts in one call
delete_many(emails, api_key: nil) -> HashDeletes every address in emails the way delete deletes one: a saved contact goes with its notes, its photo and every audience membership, and every address is hidden, so mail sent to it from the app composer does not record it again. Addresses that were only seen in mail are hidden too.
An entry that is not an address comes back in invalid and the rest still go through. A repeated address counts once. There is no undo.
Parameters
emailsArray<String>Required1 to 200 addresses, matched case insensitively. More than 200, or none, is a 422 on
emails.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with object set to contact_batch_delete, deleted, saved and invalid. deleted counts the addresses deleted and hidden, saved how many of them were saved contacts.
Example
result = client.contacts.delete_many(["ada@example.com", "grace@example.com"]) puts "#{result[:deleted]} deleted, #{result[:saved]} of them saved contacts"Notes
Safe to replay: deleting an address twice leaves it deleted and hidden, so the SDK retries it after a network failure.
No mail is deleted, and nobody is unsubscribed from anything.
Also available in
contacts.set_photo
Upload the photo shown for a contact
set_photo(email, data, content_type: nil, api_key: nil) -> HashSends the image bytes as the request body, replacing any photo the contact had. PNG, JPEG, WebP and GIF are accepted, up to 5 MB. The server fits the image into a 512 pixel square, stores it as WebP, keeps the first frame of an animation, and answers with the contact and its new photoUrl.
data is a binary String, an IO or a Pathname. The type is read from content_type:, or, when that is left out, from data itself: a content_type it answers to, or the extension of its file name, as for a File or a Pathname. Without either the bytes go as application/octet-stream and the server refuses them with 422 invalid_image.
The address has to be a saved contact already: save it first.
Parameters
emailStringRequiredThe contact's address, matched case insensitively.
dataString, IO or PathnameRequiredThe image: a binary
String, anIOor aPathname.content_typeStringimage/png,image/jpeg,image/webporimage/gif. Required unlessdatacarries its own type, such as aFileorPathnamewhose name ends in.png,.jpg,.jpeg,.webpor.gif.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash, the contact with its new photoUrl.
Example
contact = client.contacts.set_photo("grace@example.com", File.binread("photo.jpg"), content_type: "image/jpeg") puts contact[:photoUrl]Notes
An address that is not a saved contact is a 404
contact_not_found.A busy image service answers 503
image_busy, which the SDK retries like any other 503.Every upload gets a new URL, so a cached old photo never shows under the new one.
Also available in
contacts.remove_photo
Remove a contact photo
remove_photo(email, api_key: nil) -> HashTakes the photo off the contact and deletes the stored image, the way Remove does on a contact in the app. The contact answers with photoUrl nil. Removing a photo from a contact that has none changes nothing.
Parameters
emailStringRequiredThe contact's address, matched case insensitively.
api_keyStringOverrides the client's API key for this call only.
Returns
A Hash, the contact with photoUrl nil.
Example
client.contacts.remove_photo("grace@example.com")Notes
An address that is not a saved contact is a 404
contact_not_found.Safe to replay, so the SDK retries it after a network failure.
Also available in
contacts.block
Block an address
block(email, api_key: nil) -> HashPuts the address on the workspace blocklist, the same list settings.update edits as blockedSenders, so mail from it is refused from then on. This is Block on a contact in the app. A plus tag is dropped: blocking ada+news@example.com blocks ada@example.com, and every tag of it.
When a rule already blocks the address, a whole-domain rule included, nothing is added: created is false and blockedBy names that rule. The address does not have to be a contact.
Parameters
emailStringRequiredThe address to block.
api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with object set to contact_block, email, blocked set to true, blockedBy and created.
Example
result = client.contacts.block("spammer@example.com") puts result[:created] ? "blocked" : "already blocked by #{result.dig(:blockedBy, :rule)}"Notes
It needs
settings:writerather thancontacts:write, because it writes the blocklist rather than the contact.Safe to replay, so the SDK retries it after a network failure.
An address with fewer than two letters or numbers is refused with 422
blocklist_entry_too_broad.A key limited to particular addresses or domains gets 422
capability_unsupportedonaddressAllowlist, because the blocklist belongs to the whole workspace and filters the mail of every address in it.
Also available in
contacts.unblock
Unblock an address
unblock(email, api_key: nil) -> HashTakes every workspace blocklist rule that blocks the address off the list and lists them in removed. This is Unblock on a contact in the app.
When one of them is a whole-domain rule, in blockedDomains, everybody at that domain is unblocked with it, so check removed when that matters. Rules set for one address or one domain in the settings are not touched. An address that no rule blocks answers with removed empty.
Parameters
emailStringRequiredThe address to unblock.
api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with object set to contact_block, email, blocked set to false and removed, each entry of removed a Hash with rule and list.
Example
result = client.contacts.unblock("friend@example.com") Array(result[:removed]).each { |hit| puts "#{hit[:list]} #{hit[:rule]}" }Notes
Safe to replay, so the SDK retries it after a network failure.
A key limited to particular addresses or domains gets 422
capability_unsupportedonaddressAllowlist, because the blocklist belongs to the whole workspace and filters the mail of every address in it.
Also available in
contacts.list_threads
List the conversations with one person
list_threads(email, q: nil, sort: nil, limit: nil, cursor: nil, api_key: nil) -> Nextmail::PageReturns one page of the threads the address wrote or was written to, in every folder: the Mail tab on a contact in the app. Each row is a summary, subject, from, receivedAt, messageCount, hasUnread and labels, and threads.get reads the messages behind its id.
limit: takes 1 to 100 and defaults to 25. Pass next_cursor back as cursor:, with the same q: and sort:, while has_more? is true.
Parameters
emailStringRequiredThe address. It does not have to be a saved contact.
qStringSearches inside those threads, with the mailbox search syntax, up to 200 characters.
sortStringnewest(the default),oldest,senderorsubject.limitIntegerThreads per page, 1 to 100. The server defaults to 25.
cursorStringThe
next_cursorfrom the previous page. Never build one yourself.api_keyStringOverrides the client's API key for this call only.
Returns
The Nextmail::Page of thread Hashes with items, has_more? and next_cursor.
Example
page = client.contacts.list_threads("ada@example.com", q: "invoice") page.items.each { |thread| puts "#{thread[:receivedAt]} #{thread[:subject]}" }Notes
It needs
threads:read, because it reads mail rather than the contact.A key limited to particular addresses or domains gets 422
capability_unsupportedonaddressAllowlist, because a contact's threads and activity are read from the mail of every address in the workspace.
Also available in
contacts.list_all_threads
Collect every conversation with one person into one array
list_all_threads(email, q: nil, sort: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Follows next_cursor from page to page and returns every thread list_threads would list for the address, in the same order.
Everything is held in memory before the call returns. Prefer iterate_threads when you can stop early.
Parameters
emailStringRequiredThe address. It does not have to be a saved contact.
qStringSearches inside those threads, with the mailbox search syntax, up to 200 characters.
sortStringnewest(the default),oldest,senderorsubject.limitIntegerPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorStringA cursor from an earlier page to start after.
api_keyStringOverrides the client's API key for every page of this walk.
Returns
An Array of Hashes holding every thread across all pages.
Example
threads = client.contacts.list_all_threads("ada@example.com") puts "#{threads.size} conversations with Ada"Notes
A failure on any page raises out of the whole call, and the threads already fetched are discarded.
Also available in
contacts.iterate_threads
Stream the conversations with one person one thread at a time
iterate_threads(email, q: nil, sort: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>Returns an Enumerator that yields the threads list_threads lists for the address, one at a time, or yields each one to a block when given one, 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
emailStringRequiredThe address. It does not have to be a saved contact.
qStringSearches inside those threads, with the mailbox search syntax, up to 200 characters.
sortStringnewest(the default),oldest,senderorsubject.limitIntegerPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorStringA cursor from an earlier page to start after.
api_keyStringOverrides the client's API key for every page of this walk.
Returns
An Enumerator of Hashes, one thread per step, or yields each one to a block.
Example
client.contacts.iterate_threads("ada@example.com") do |thread| puts "unread: #{thread[:subject]}" if thread[:hasUnread]endNotes
The Enumerator is lazy, so an abandoned loop costs only the pages you consumed.
Also available in
contacts.activity
Read how mail with one person has gone over a window
activity(email, minutes: nil, grain: nil, offset_minutes: nil, api_key: nil) -> HashReturns the numbers behind the Activity tab on a contact in the app, over a window that ends now: messages received from the address and sent to it per bucket, the threads that moved, the threads whose newest message is theirs and so waits on a reply from the mailbox, when each side last wrote, and the median time each side takes to answer, in milliseconds.
minutes: sets how far back the window reaches, 90 days by default. grain: sets the bucket width and the key shape, YYYY-MM-DD, YYYY-MM-DDTHH or YYYY-MM-DDTHH:MM, and offset_minutes: shifts the boundaries so days break where the reader's day does. buckets is sparse and oldest first. Mail in the bin or in spam is left out.
Parameters
emailStringRequiredThe address. It does not have to be a saved contact.
minutesIntegerWindow length in minutes, from 1 to about 20 years. The server defaults to 90 days.
grainStringBucket width:
minute,hourorday, defaulting today.offset_minutesIntegerMinutes east of UTC to cut the buckets in, from -840 to 840, defaulting to 0. Pass
Time.now.utc_offset / 60for the local zone.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with object set to contact_activity, email, since, until, grain, buckets, totals and replyTime. totals has received, sent, threads, waiting, lastReceivedAt and lastSentAt, and replyTime has yours and theirs, each nil when there is no reply to measure.
Example
activity = client.contacts.activity("ada@example.com", minutes: 30 * 24 * 60)totals = activity[:totals] puts "#{totals[:received]} in, #{totals[:sent]} out, #{totals[:waiting]} waiting on you"Notes
It needs
threads:read, because it reads mail rather than the contact.Read only, so the SDK retries it after a network failure like any other read.
A key limited to particular addresses or domains gets 422
capability_unsupportedonaddressAllowlist, because a contact's threads and activity are read from the mail of every address in the workspace.
Also available in
contacts.list_events
List the events recorded for one contact
list_events(email, name: nil, limit: nil, cursor: nil, api_key: nil) -> Nextmail::PageReturns one page of the events events.send recorded for a contact in the last 90 days, the most recent first by when they happened. Each has its name, properties, occurredAt and mode, which is test for an event a test key sent.
limit: takes 1 to 200 and defaults to 50. Pass next_cursor back as cursor:, with the same name:, while has_more? is true. list_all_events and iterate_events do that walk for you.
Parameters
emailStringRequiredThe contact, by email address, compared without case. The
contactIdan event or an enrollment carries works here too.nameStringOnly events with exactly this name.
limitIntegerEvents per page, a whole number from 1 to 200. The server defaults to 50.
cursorStringThe
next_cursorfrom the previous page, passed back exactly as it came. One that names no event of this contact is a 400invalid_cursor.api_keyStringOverrides the client's API key for this call only.
Returns
The Nextmail::Page with items, has_more? and next_cursor. Each item is a Hash with id, contactId, email, name, properties, occurredAt, mode and createdAt.
Example
page = client.contacts.list_events("ada@example.com", name: "order.placed") page.items.each { |event| puts "#{event[:occurredAt]} #{event[:name]} #{event[:properties]}" }Notes
An address or id nobody you can reach has is 404
contact_not_found. An app a member connected reads only the contacts that member added.Read only, so the SDK retries it after a network failure like any other read.
Also available in
contacts.list_all_events
Collect every event of one contact into one array
list_all_events(email, name: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Follows next_cursor from page to page and returns every event recorded for the contact in the last 90 days, the most recent first, in the shape list_events returns. limit sets the page size of each request, not the total.
Parameters
emailStringRequiredThe contact, by email address, compared without case. The
contactIdan event or an enrollment carries works here too.nameStringOnly events with exactly this name.
limitIntegerPage size per request, from 1 to 200, defaulting to 50 on the server.
cursorStringA
next_cursorfrom an earlier page to start after.api_keyStringOverrides the client's API key for every page of this walk.
Returns
An Array of Hashes holding every matching event across all pages, each shaped like an item of list_events.
Example
events = client.contacts.list_all_events("ada@example.com") names = events.map { |event| event[:name] }.uniq puts events.size, namesNotes
A failure on any page raises, and the events already fetched are discarded.
Also available in
contacts.iterate_events
Stream the events of one contact one at a time
iterate_events(email, name: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>Returns an Enumerator that yields the events of a contact one by one, the most recent first, or passes each one to the block you give it. It requests the next page only once the current one is drained, and breaking out of the loop stops the requests.
Parameters
emailStringRequiredThe contact, by email address, compared without case. The
contactIdan event or an enrollment carries works here too.nameStringOnly events with exactly this name.
limitIntegerPage size per request, from 1 to 200, defaulting to 50 on the server.
cursorStringA
next_cursorfrom an earlier page to start after.api_keyStringOverrides the client's API key for every page of this walk.
Returns
An Enumerator of Hashes, one event per step, each shaped like an item of list_events, or yields each one to a block.
Example
client.contacts.iterate_events("ada@example.com") do |event| next unless event[:name] == "plan.cancelled" puts "cancelled on #{event[:occurredAt]}" breakendNotes
Pages are fetched only as the loop reaches them, so an abandoned loop costs only the pages you consumed.
Also available in
contacts.list_cards
List the address book as contact cards
list_cards(email: nil, without_email: nil, kind: nil, group_id: nil, limit: nil, cursor: nil, api_key: nil) -> Nextmail::PageReturns one page of contact cards, newest first. A card is a saved contact with everything an address book keeps for it: phone numbers, other email addresses, postal addresses, websites, organisation, department, job title, birthday, nickname and the name in parts. Cards with no email address, such as a plumber saved on a phone, are listed too. It is the address book phones and computers sync over CardDAV.
email: finds the card of one saved contact, and without_email: true lists only the cards with no address. An address that was only ever mailed, and never saved, has no card.
Paging is keyset. limit: takes 1 to 200 and defaults to 50, and next_cursor goes back as cursor: while has_more? is true. Never build a cursor yourself.
Parameters
limitIntegerCards per page, a whole number from 1 to 200. The server defaults to 50.
cursorStringThe
next_cursorfrom the previous page. Never build one yourself.emailStringOnly the card of the saved contact with this address.
without_emailBooleantruelists only the cards that have no email address.kindStringgrouplists only the groups,individualonly the people and companies, one ofNextmail::CONTACT_CARD_KINDS.group_idStringOnly the cards in the group with this id.
api_keyStringOverrides the client's API key for this call only.
Returns
The Nextmail::Page with items, has_more? and next_cursor. Each card is a Hash with id, uid, email, name, nameParts, nickname, organization, department, title, birthday, notes, the Arrays emails, phones, addresses and urls, photoUrl, createdAt and updatedAt.
Example
page = client.contacts.list_cards(without_email: true) page.items.each do |card| puts "#{card[:name]}: #{card[:phones].map { |phone| phone[:value] }.join(", ")}"endNotes
Every member reads the same address book through a key, since a key acts for the workspace owner.
A cursor that names no card is a 400
invalid_cursor. Start again without one.
Also available in
contacts.list_all_cards
Collect every contact card into one array
list_all_cards(email: nil, without_email: nil, kind: nil, group_id: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Follows next_cursor from page to page and returns every card in the address book, newest first. It takes the same email: and without_email: filters as list_cards.
Everything is held in memory before the call returns. Prefer iterate_cards when you can stop early. limit: sets the page size of each request, not the total.
Parameters
emailStringOnly the card of the saved contact with this address.
without_emailBooleantruelists only the cards that have no email address.kindStringgrouplists only the groups,individualonly the people and companies, one ofNextmail::CONTACT_CARD_KINDS.group_idStringOnly the cards in the group with this id.
limitIntegerPage size per request, from 1 to 200, defaulting to 50 on the server.
cursorStringA cursor from an earlier page to start after.
api_keyStringOverrides the client's API key for every page of this walk.
Returns
An Array of Hashes holding every card across all pages.
Example
cards = client.contacts.list_all_cards puts "#{cards.size} cards in the address book"Notes
A failure on any page raises out of the whole call, and the cards already fetched are discarded.
Also available in
contacts.iterate_cards
Stream the address book one card at a time
iterate_cards(email: nil, without_email: nil, kind: nil, group_id: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>Returns an Enumerator that yields cards 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. Nothing is fetched until you consume it, and breaking out of the loop stops the requests. It takes the same email: and without_email: filters as list_cards.
Parameters
emailStringOnly the card of the saved contact with this address.
without_emailBooleantruelists only the cards that have no email address.kindStringgrouplists only the groups,individualonly the people and companies, one ofNextmail::CONTACT_CARD_KINDS.group_idStringOnly the cards in the group with this id.
limitIntegerPage size per request, from 1 to 200, defaulting to 50 on the server.
cursorStringA cursor from an earlier page to start after.
api_keyStringOverrides the client's API key for every page of this walk.
Returns
An Enumerator of Hashes, one card per step, or yields each one to a block.
Example
client.contacts.iterate_cards do |card| puts "#{card[:name]}: #{card[:birthday]}" if card[:birthday]endNotes
The Enumerator is lazy, so an abandoned loop costs only the pages you consumed.
Also available in
contacts.get_card
Get one contact card
get_card(id, api_key: nil) -> HashReturns one card with everything it holds. To find the card of a saved contact by its address, pass email: to list_cards.
Parameters
idStringRequiredThe card id,
ccd_followed by 24 characters, fromlist_cardsorget_card.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with id, uid, the vCard UID that phones and computers know the card by, email, nil on a card with no address, name, nameParts, nickname, organization, department, title, birthday, notes, photoUrl, createdAt and updatedAt. emails, phones and urls are Arrays of Hashes with value, label and customLabel, and addresses is an Array of Hashes with label, customLabel, street, locality, region, postalCode and country.
Example
card = client.contacts.get_card("ccd_0123456789abcdef01234567") puts card[:name], card[:organization]p card[:phones]Notes
An id that names no card is a 404
contact_card_not_found, raised asNextmail::NotFoundError.
Also available in
contacts.create_card
Add a card to the address book
create_card(body = nil, api_key: nil, **fields) -> HashAdds a contact card. With email the card is a saved contact as well, the same one create makes, and an address the workspace already knows from mail becomes saved. Without one it is a card on its own, kept for its name, phone numbers and the rest. A card needs at least a name, an email address, a phone number or an organisation.
Each entry in emails, phones and urls is a Hash with value, and optionally label, one of Nextmail::CONTACT_CARD_LABELS, and customLabel, a label of your own.
Phones and computers that sync the address book over CardDAV get the new card on their next sync.
Parameters
emailStringThe address Nextmail knows the contact by. With it the card is a saved contact as well. A saved contact keeps its address, so put any other address in
emails.nameStringThe full name the address book shows, up to 200 characters.
namePartsHashThe name in parts, a Hash with
prefix,given,middle,familyandsuffix, the way phones keep it.nicknameStringA nickname.
organizationStringThe company or organisation.
departmentStringThe department within the organisation.
titleStringThe job title.
birthdayStringYYYY-MM-DD, or--MM-DDwhen the year is not known.notesStringFree-form notes. On a saved contact these are the notes the contact page shows.
emailsArray<Hash>Other email addresses besides
email, each a Hash withvalue, and optionallylabelandcustomLabel.phonesArray<Hash>Phone numbers, each a Hash with
value, and optionallylabelandcustomLabel.addressesArray<Hash>Postal addresses, each a Hash with any of
label,customLabel,street,locality,region,postalCodeandcountry.urlsArray<Hash>Websites and profile links, each a Hash with
value, and optionallylabelandcustomLabel.kindStringgroupmakes a group, the kind phones keep, which needsnameand takesmembersinstead of an address.individualwhen left out.membersArray<String>For a group, the ids of the cards in it, up to 2,000. Groups cannot hold other groups.
api_keyStringOverrides the client's API key for this call only.
Returns
The new card, a Hash with the fields get_card returns.
Example
card = client.contacts.create_card( email: "ada@example.com", name: "Ada Lovelace", organization: "Analytical Engines", phones: [{value: "+44 20 7946 0000", label: "work"}], birthday: "1815-12-10") puts card[:id], card[:email]Notes
The SDK does not retry it after a network failure, because a second call would make a second card.
An address that already belongs to another card is a 409
contact_card_email_taken, and a card with nothing to keep a 422invalid_contact_card.A workspace that already keeps as many cards as it may gets a 409
contact_card_limit. Delete some before you add more.
Also available in
contacts.update_card
Change a contact card
update_card(id, patch = nil, api_key: nil, **fields) -> HashChanges the fields you send and leaves the rest alone. nil clears a field, and a list you send (emails, phones, addresses or urls) replaces the whole list, so read the card first when you mean to add one entry.
On a saved contact, name and notes are the contact's own, so the contact page shows the change. email can only be given to a card that has none, which makes it a saved contact. A saved contact keeps its address: add another address to emails instead.
Phones and computers that sync the address book over CardDAV get the change on their next sync.
Parameters
idStringRequiredThe card id,
ccd_followed by 24 characters, fromlist_cardsorget_card.emailStringThe address Nextmail knows the contact by. Given to a card that has none, it makes the card a saved contact. A saved contact keeps its address, so put any other address in
emails.nameStringThe full name the address book shows, up to 200 characters.
namePartsHashThe name in parts, a Hash with
prefix,given,middle,familyandsuffix, the way phones keep it.nicknameStringA nickname.
organizationStringThe company or organisation.
departmentStringThe department within the organisation.
titleStringThe job title.
birthdayStringYYYY-MM-DD, or--MM-DDwhen the year is not known.notesStringFree-form notes. On a saved contact these are the notes the contact page shows.
emailsArray<Hash>Other email addresses besides
email, each a Hash withvalue, and optionallylabelandcustomLabel. The list replaces the one the card has.phonesArray<Hash>Phone numbers, each a Hash with
value, and optionallylabelandcustomLabel. The list replaces the one the card has.addressesArray<Hash>Postal addresses, each a Hash with any of
label,customLabel,street,locality,region,postalCodeandcountry. The list replaces the one the card has.urlsArray<Hash>Websites and profile links, each a Hash with
value, and optionallylabelandcustomLabel. The list replaces the one the card has.kindStringWhat the card already is. A person cannot become a group or a group a person, so any other value is a 422
invalid_contact_card.membersArray<String>For a group, the ids of the cards in it. Given, it replaces the whole list, so send the ids already in it with the ones you add.
api_keyStringOverrides the client's API key for this call only.
Returns
A Hash, the card as it stands after the change.
Example
card = client.contacts.get_card("ccd_0123456789abcdef01234567") updated = client.contacts.update_card(card[:id], phones: [*card[:phones], {value: "+1 555 0100", label: "mobile"}]) puts updated[:phones].sizeNotes
The SDK retries this call after a network failure, since the same patch sent twice leaves the same card.
Changing the address of a saved contact is a 422
invalid_contact_card, and an address that already belongs to another card a 409contact_card_email_taken.An id that names no card is a 404
contact_card_not_found.
Also available in
contacts.delete_card
Delete a contact card
delete_card(id, api_key: nil) -> HashRemoves the card from the address book and from every phone and computer that syncs it. On a saved contact it is the same as delete: the contact goes with its notes, photo and audiences, and the address is hidden from the people list and the suggestions.
Parameters
idStringRequiredThe card id,
ccd_followed by 24 characters, fromlist_cardsorget_card.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with object set to contact_card, id and deleted set to true.
Example
removed = client.contacts.delete_card("ccd_0123456789abcdef01234567") puts removed[:id], removed[:deleted]Notes
There is no undo, and the SDK does not retry it after a network failure.
An id that names no card is a 404
contact_card_not_found.
Also available in
contacts.find_duplicate_cards
Find duplicate contact cards
find_duplicate_cards(api_key: nil) -> HashFinds the cards in the address book that look like the same person, as Find duplicates on the Contacts page of the app does: cards that share an email address or a phone number, or that have the same full name. Each group in data lists its cards with the most complete one first, which is the card to keep when you pass the rest to merge_cards.
Groups found by a shared address come first, then by phone number, then by name. Phone numbers match on their last nine digits, so +44 20 7946 0000 and 020 7946 0000 are the same number. Group cards are never compared.
Parameters
api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with data, each group a Hash with object set to contact_card_duplicates, reason, one of Nextmail::CONTACT_CARD_DUPLICATE_REASONS, and cards, and hasMore, true when more than 100 groups were found.
Example
found = client.contacts.find_duplicate_cards found[:data].each do |group| keep, *others = group[:cards] puts "#{group[:reason]}: keep #{keep[:name]}, merge #{others.map { |card| card[:id] }.join(", ")}"endNotes
It reads every card, so call it when somebody asks rather than on every page load.
With
hasMore, merge the groups you have and call it again for the rest.
Also available in
contacts.merge_cards
Merge contact cards
merge_cards(id, body = nil, api_key: nil, **fields) -> HashFolds other cards into the card id names and deletes them, as Merge does in Find duplicates on the Contacts page of the app. Fields the kept card leaves empty are filled from the others, notes are joined, and every email address, phone number, postal address and website is kept. Groups that held the other cards hold the kept one instead.
A saved contact among the others stays known by its address, in the people list and in its audiences, but it leaves the address book. When the kept card has no address of its own, it becomes the saved contact of the first address the others had. Phones and computers that sync the address book over CardDAV get the change on their next sync.
Parameters
idStringRequiredThe card to keep, from
list_cards,get_cardorfind_duplicate_cards.cardIdsArray<String>RequiredThe cards to fold into it, 1 to 10 of them. They are deleted once their details are kept.
api_keyStringOverrides the client's API key for this call only.
Returns
The card that kept everything, as a Hash.
Example
card = client.contacts.merge_cards("ccd_0123456789abcdef01234567", cardIds: ["ccd_89abcdef0123456789abcdef"]) puts card[:name], card[:emails].sizeNotes
There is no undo, and the SDK does not retry it after a network failure.
Naming the kept card among
cardIds, or a group anywhere, is a 422invalid_contact_card, and an id that names no card a 404contact_card_not_found.
Also available in
contacts.list_birthdays
List birthdays
list_birthdays(from:, to:, timezone: nil, api_key: nil) -> Array<Hash>Returns the birthdays of the people in the address book that fall between from: and to:, the birthdays calendar the Calendar page of the app can show. There is one entry for each date, so a window of a whole year can hold somebody twice, and age is how old they turn that day when the card holds the year of birth. Somebody born on 29 February has their birthday on 28 February in other years.
from: and to: take a Time or an ISO 8601 string and may be at most 366 days apart. timezone:, UTC unless you say, decides which day the window starts and ends on.
Parameters
fromTime | StringRequiredThe start of the window.
toTime | StringRequiredThe end of the window, after
from:and at most 366 days later.timezoneStringIANA zone such as
Europe/London, at most 64 characters. Defaults toUTC.api_keyStringOverrides the client's API key for this call only.
Returns
An Array of Hashes sorted by date and then by name, each with cardId, contactId, email, name, birthday, date, age and photoUrl.
Example
from = Time.nowbirthdays = client.contacts.list_birthdays(from:, to: from + (30 * 24 * 60 * 60), timezone: "Europe/London") birthdays.each { |birthday| puts "#{birthday[:date]} #{birthday[:name]} #{birthday[:age] || "age not known"}" }Notes
A value that does not parse, a reversed or overlong window, or an unknown zone is a 400
invalid_parameternaming the field.
Also available in
contacts.import_vcf
Import a contacts file
import_vcf(data, filename: nil, api_key: nil) -> HashSends a vCard (.vcf) file as the request body and queues it. Every card in it becomes a contact card, with its phone numbers, addresses and the rest. Poll get_import until status is completed.
The file may be 20 MB. Imported contacts join no audience, so a broadcast never reaches them because of an import. A card whose address or UID is already in the address book is counted under merged and left as it is, and a card with no address is matched on its phone number. A workspace keeps 20,000 cards, and the cards past that are counted under skipped.
data is a binary String, an IO or a Pathname, and it goes out as text/vcard. Left out, filename: falls back to an upload's original_filename or the file's own name, so only plain bytes need it.
Parameters
dataString, IO or PathnameRequiredThe .vcf file: a binary
String, anIOor aPathname.filenameStringThe name to show for the file in the list of imports, at most 255 characters. Left out, it is an upload's
original_filenameor the file's own name, and plain bytes are listed without a name.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash for the import, shaped like the one get_import returns, with status set to queued.
Example
queued = client.contacts.import_vcf(File.binread("contacts.vcf"), filename: "contacts.vcf") puts queued[:id], queued[:status]Notes
A body that holds no vCard is a 400
not_a_contacts_file, and an empty one a 400item_import_empty.A file over 20 MB is a 413
item_import_too_large.Text you already hold goes in as it is, since a String is sent byte for byte.
An upload that outlasts the client
timeoutfails as a network error, so raise it on the client for a large file on a slow connection.Not retried automatically.
Also available in
contacts.list_imports
List contacts imports
list_imports(limit: nil, cursor: nil, api_key: nil) -> Nextmail::PageReturns one page of the contacts files and address books brought in, newest first, each with what it added and what it left out. Beside the files sent with import_vcf it lists the address books that came with a mailbox import, and those carry the id of that import in parentImportId.
Paging is keyset. limit: takes 1 to 100 and defaults to 25, and next_cursor goes back as cursor: while has_more? is true. list_all_imports and iterate_imports do that walk for you.
Parameters
limitIntegerImports per page, a whole number from 1 to 100. The server defaults to 25.
cursorStringThe
next_cursorfrom the previous page. Never build one yourself.api_keyStringOverrides the client's API key for this call only.
Returns
The Nextmail::Page with items, has_more? and next_cursor. Each import is a Hash shaped like the one get_import returns.
Example
page = client.contacts.list_imports(limit: 50) page.items.each do |item| puts "#{item[:fileName]} #{item[:status]} #{item[:counts][:imported]} #{item[:counts][:merged]}"endNotes
sourceisfilefor an upload.takeout,carddavandmicrosoftcame with a mailbox import.A cursor that names no import is a 400
invalid_cursor.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
contacts.list_all_imports
Collect every contacts import into one array
list_all_imports(limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Follows next_cursor from page to page and returns every contacts import, newest first.
Everything is held in memory before the call returns. Prefer iterate_imports when you can stop early. limit: sets the page size of each request, not the total.
Parameters
limitIntegerPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorStringA cursor from an earlier page to start after.
api_keyStringOverrides the client's API key for every page of this walk.
Returns
An Array of Hashes holding every import across all pages.
Example
imports = client.contacts.list_all_imports added = imports.sum { |item| item[:counts][:imported] } puts "#{added} cards came from #{imports.size} imports"Notes
A failure on any page raises out of the whole call, and the imports already fetched are discarded.
Also available in
contacts.iterate_imports
Stream contacts imports one at a time
iterate_imports(limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>Returns an Enumerator that yields contacts 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. Nothing is fetched until you consume it, and breaking out of the loop stops the requests.
Parameters
limitIntegerPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorStringA cursor from an earlier page to start after.
api_keyStringOverrides the client's API key for every page of this walk.
Returns
An Enumerator of Hashes, one import per step, or yields each one to a block.
Example
running = client.contacts.iterate_imports.find { |item| item[:status] == "running" } puts "still running #{running[:id]} #{running[:counts][:total]}" if runningNotes
The Enumerator is lazy, so an abandoned loop costs only the pages you consumed.
Also available in
contacts.get_import
Get a contacts import
get_import(id, api_key: nil) -> HashReturns one contacts import with its counts and its report: the files it read, how many cards it left out and why, and up to 20 of the cards it left out. Poll it after import_vcf until status is completed or failed.
counts[:imported] is what was added, counts[:merged] the cards left as they were because they were already in the address book, and counts[:skipped] what was left out, which report[:skipped] breaks down by reason: limit for a card past the 20,000 a workspace keeps, invalid for one that could not be read and empty for one that held nothing.
Parameters
idStringRequiredContacts import id,
iimp_followed by 24 hex characters.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with object, id, kind, source, one of Nextmail::ITEM_IMPORT_SOURCES, status, one of Nextmail::ITEM_IMPORT_STATUSES, fileName, fileBytes, parentImportId, counts, report, lastError, undoable and when it was created, started, finished and undone in createdAt, startedAt, finishedAt and undoneAt. counts holds total, imported, merged, skipped and failed. report holds collections, an Array of Hashes with name and items, skipped, a Hash of counts keyed by reason, and samples, an Array of Hashes with name and reason.
Example
item = client.contacts.get_import("iimp_7b1e4d8f60a5c7b92d3f9c2a") puts item[:status], item[:counts][:imported], item[:counts][:merged], item[:counts][:skipped] item[:report][:samples].each { |sample| puts "#{sample[:name]} #{sample[:reason]}" }Notes
An id that names no contacts import is a 404
item_import_not_found.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
contacts.undo_import
Remove what a contacts import added
undo_import(id, api_key: nil) -> HashDeletes every contact and card the import added, changed since or not, and marks the import undone. Contacts that were already in the address book are not touched.
Parameters
idStringRequiredContacts import id,
iimp_followed by 24 hex characters.api_keyStringOverrides the client's API key for this call only.
Returns
The import Hash, shaped like the one get_import returns, with status set to undone and undoneAt set.
Example
undone = client.contacts.undo_import("iimp_7b1e4d8f60a5c7b92d3f9c2a") puts undone[:status], undone[:undoneAt], undone[:counts][:imported]Notes
An import that is still running, or was already removed, is a 409
item_import_not_undoable.undoableon the import says whether the call would remove anything.An id that names no contacts import is a 404
item_import_not_found.Not retried automatically.
Google Workspace
Fastmail