$client->contacts
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
The workspace address book: the contacts somebody saved and the ones the app composer recorded, everyone seen in mail beside them, and for each person their audiences, photo, blocking, conversations and activity.
contacts->list
List the workspace contacts, most recently seen first
list( ?string $source = null, ?string $q = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): 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 contacts->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. contacts->listPeople 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 nextCursor goes back as cursor: while hasMore 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
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.
limitintRows per page, a whole number from 1 to 200. The server defaults to 50.
cursorstringThe
nextCursorfrom the previous page. Never build one yourself.apiKeystringOverrides the client's API key for this call only.
Returns
A Page of contact arrays, with items, hasMore and nextCursor. Each contact has email, name, source, notes, attributes, photoUrl and lastSeenAt.
Example
$page = $client->contacts->list(source: 'manual', limit: 50); foreach ($page as $contact) { echo $contact['name'] ?? $contact['email'], ', last mailed ', $contact['lastSeenAt'] ?? 'never', PHP_EOL;} if ($page->hasMore) { $next = $client->contacts->list(source: 'manual', limit: 50, cursor: $page->nextCursor); echo count($next), ' more', PHP_EOL;}Notes
Mail sent through this API adds no contacts. Only sends from the app composer record recipients, and
contacts->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
lastSeenAtnull and sorts last, after every contact with a date.Addresses are stored lower cased.
Also available in
- API
GET /contacts- TypeScript
nextmail.contacts.list()- Python
contacts.list()- Ruby
contacts.list- Go
Contacts.List- Java
contacts().list- C#
Contacts.ListAsync- CLI
nextmail contacts list
contacts->listAll
Collect the whole address book into one array
listAll( ?string $source = null, ?string $q = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): arrayFollows nextCursor 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 contacts->list.
Everything is held in memory before the call returns, and an address book grows with every recipient the composer records. Prefer contacts->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.
limitintPage size per request, from 1 to 200, defaulting to 50 on the server.
cursorstringA cursor from an earlier page to start after.
apiKeystringOverrides the client's API key for every page of this walk.
Returns
A list of contact arrays holding every contact across all pages.
Example
$saved = $client->contacts->listAll(source: 'manual', limit: 200); echo count($saved), ' contacts saved on purpose', PHP_EOL;echo implode(PHP_EOL, array_column($saved, 'email')), PHP_EOL;Notes
A failure on any page throws 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( ?string $source = null, ?string $q = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): GeneratorReturns a Generator that yields contacts one at a time, most recently seen first, and requests the next page only once the current one is used up. Nothing is fetched until the loop starts, and breaking out of the foreach 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.
limitintPage size per request, from 1 to 200, defaulting to 50 on the server.
cursorstringA cursor from an earlier page to start after.
apiKeystringOverrides the client's API key for every page of this walk.
Returns
A Generator that yields one contact array per step.
Example
foreach ($client->contacts->iterate(source: 'auto') as $contact) { if ($contact['lastSeenAt'] === null) { break; } echo $contact['email'], ' ', $contact['lastSeenAt'], PHP_EOL;}Notes
The generator is lazy, so an abandoned loop costs only the pages you consumed.
Also available in
contacts->get
Read one contact by email address
get(string $email, ?string $apiKey = null): arrayLooks 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.
apiKeystringOverrides the client's API key for this call only.
Returns
An array with email, name, source, notes, attributes, the custom fields as an array of keys and text values, photoUrl and lastSeenAt, plus audiences, every audience the contact is in as an array with id, name and builtin. builtin is default on the audience every contact belongs to and null 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 an array with id, formId, formName, status (pending or added), answers, sourceUrl, createdAt and confirmedAt.
Example
use Nextmail\Exception\NotFoundException; try { $contact = $client->contacts->get('Grace@Example.com'); echo $contact['name'] ?? $contact['email'], ' is in ', implode(', ', array_column($contact['audiences'], 'name')), PHP_EOL;} catch (NotFoundException) { echo 'Not in the address book', PHP_EOL;}Notes
nameis null for an address recorded automatically without a display name, andnotesis free text somebody set in the app or throughcontacts->update.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
- API
GET /contacts/{email}- TypeScript
nextmail.contacts.get()- Python
contacts.get()- Ruby
contacts.get- Go
Contacts.Get- Java
contacts().get- C#
Contacts.GetAsync- CLI
nextmail contacts get
contacts->create
Save a contact in the workspace address book
create(array $body, ?string $apiKey = null): arrayAdds 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->addContact. 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 contacts->get and change it with contacts->update.
Parameters
emailstringRequiredThe address to save, trimmed and lower cased before it is stored.
namestring|nullDisplay name. Leave it out to save the contact without one.
notesstring|nullFree text kept with the contact and shown beside it in the app.
attributesarrayCustom fields to set, as an array 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. Null or an empty string removes a field, a field you leave out keeps its value, and a contact holds at most 50.audienceIdsstring[]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.apiKeystringOverrides the client's API key for this call only.
Returns
An array with email, name, source as manual, notes, attributes and lastSeenAt, which is null until mail goes to the address from the app composer, plus audiences, every audience the contact is now in, the default one included.
Example
use Nextmail\Exception\ConflictException; try { $contact = $client->contacts->create([ 'email' => 'Grace@Example.com', 'name' => 'Grace Hopper', 'notes' => 'Met at the compiler workshop.', 'attributes' => ['plan' => 'team'], 'audienceIds' => ['aud_9f2c4b7e1a0d63d84c5f2e7b'], ]); echo 'Saved ', $contact['email'], ' in ', count($contact['audiences']), ' audiences', PHP_EOL;} catch (ConflictException) { echo 'Already in the book, so change it with contacts->update', PHP_EOL;}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(string $email, array $patch, ?string $apiKey = null): arrayChanges the fields you send and leaves the rest alone. A key you leave out keeps its stored value, and an explicit null clears it, so ['notes' => null] empties the notes while [] changes nothing. attributes is merged key by key: a string sets a custom field, null 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 contacts->delete and a contacts->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.
namestring|nullNew display name. Null clears it.
notesstring|nullNew notes. Null clears them.
attributesarrayCustom fields to set, as an array 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. Null or an empty string removes a field, a field you leave out keeps its value, and a contact holds at most 50.apiKeystringOverrides the client's API key for this call only.
Returns
An array for the contact as it stands after the change, with audiences alongside it.
Example
$contact = $client->contacts->update('grace@example.com', [ 'name' => 'Grace Hopper', 'notes' => null, 'attributes' => ['plan' => 'team', 'trial' => null],]); echo $contact['name'], ', notes ', $contact['notes'] === null ? 'cleared' : 'kept', ', plan ', $contact['attributes']['plan'] ?? 'none', PHP_EOL;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
contacts->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
contacts->setAudiencesto set the whole list, oraudiences->addContactandaudiences->removeContactfor one audience.
Also available in
contacts->delete
Delete somebody from the contacts and hide the address
delete(string $email, ?string $apiKey = null): arrayDoes 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: contacts->listPeople 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. contacts->create or contacts->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.
apiKeystringOverrides the client's API key for this call only.
Returns
An array with object set to contact, email, deleted set to true and wasSaved.
Example
$removed = $client->contacts->delete('grace@example.com'); echo $removed['email'], $removed['wasSaved'] ? ' was a saved contact' : ' was only seen in mail', ' and is now hidden', PHP_EOL;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.contacts->deleteManydeletes up to 200 addresses in one call.
Also available in
contacts->setAudiences
Set exactly which audiences a contact is in
setAudiences(string $email, array $body, ?string $apiKey = null): arrayMakes 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->addContact or audiences->removeContact.
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 contacts->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.
audienceIdsstring[]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.apiKeystringOverrides the client's API key for this call only.
Returns
An array for the contact as it stands after the change, with audiences, every audience the contact is now in as an array with id, name and builtin, the default one included.
Example
$contact = $client->contacts->setAudiences('grace@example.com', [ 'audienceIds' => ['aud_9f2c4b7e1a0d63d84c5f2e7b', 'aud_1c4e7a9b2d0f36e85a7c1b4d'],]); foreach ($contact['audiences'] as $audience) { echo $audience['name'], $audience['builtin'] === 'default' ? ', everyone' : '', PHP_EOL;}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
contacts->getfirst when you mean to add one audience to what the contact already has, or useaudiences->addContact.
Also available in
contacts->listPeople
List everyone on the Contacts page, saved or seen in mail
listPeople( ?string $q = null, ?string $email = null, ?string $sort = null, ?bool $blocked = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): 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. contacts->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 nextCursor goes back as cursor:, with the same sort:, q: and blocked:, while hasMore 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, also inNextmail\Constants\PeopleSorts.blockedbooltruefor only the people the workspace blocklist blocks, whole-domain rules included.limitintRows per page, 1 to 100. The server defaults to 25.
cursorstringThe
nextCursorfrom the previous page. Never build one yourself.apiKeystringOverrides the client's API key for this call only.
Returns
A PeoplePage with items, hasMore, nextCursor and seen. Each person is an array 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
use Nextmail\Constants\PeopleSorts; $people = $client->contacts->listPeople(sort: PeopleSorts::THREADS, limit: 50); if (!$people->seen) { echo 'Saved contacts only, since this key cannot read the mail', PHP_EOL;} foreach ($people as $person) { echo $person['name'] ?? $person['displayEmail'], ': ', $person['threads'], ' threads, ', $person['saved'] ? 'saved' : 'seen in mail', PHP_EOL;}Notes
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->listAllPeople
Collect everyone on the Contacts page into one array
listAllPeople( ?string $q = null, ?string $email = null, ?string $sort = null, ?bool $blocked = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): arrayFollows nextCursor from page to page and returns every person contacts->listPeople would list, in the same order and with the same filters. It is how you count the people a blocklist blocks: count($client->contacts->listAllPeople(blocked: true)).
Everything is held in memory before the call returns, and a busy mailbox has seen a great many addresses. Prefer contacts->iteratePeople 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.blockedbooltruefor only the people the workspace blocklist blocks, whole-domain rules included.limitintPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorstringA cursor from an earlier page to start after.
apiKeystringOverrides the client's API key for every page of this walk.
Returns
A list of person arrays holding every person across all pages.
Example
$blocked = $client->contacts->listAllPeople(blocked: true, limit: 100); echo count($blocked), ' people are blocked', PHP_EOL; foreach ($blocked as $person) { echo $person['email'], ' by ', $person['blockedBy']['rule'], ' in ', $person['blockedBy']['list'], PHP_EOL;}Notes
A failure on any page throws out of the whole call, and the people already fetched are discarded.
seenis not reported here. Read one page withcontacts->listPeopleto learn whether the key reads the people seen in mail.
Also available in
contacts->iteratePeople
Stream everyone on the Contacts page one person at a time
iteratePeople( ?string $q = null, ?string $email = null, ?string $sort = null, ?bool $blocked = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): GeneratorReturns a Generator that yields the people contacts->listPeople lists, one at a time, and requests the next page only once the current one is used up. Nothing is fetched until the loop starts, and breaking out of the foreach 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.blockedbooltruefor only the people the workspace blocklist blocks, whole-domain rules included.limitintPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorstringA cursor from an earlier page to start after.
apiKeystringOverrides the client's API key for every page of this walk.
Returns
A Generator that yields one person array per step.
Example
foreach ($client->contacts->iteratePeople(sort: 'threads') as $person) { if ($person['threads'] < 5) { break; } if (!$person['saved']) { $client->contacts->save($person['email']); }}Notes
The generator 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(string $email, ?array $body = null, ?string $apiKey = null): arrayDoes 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 in the body replaces the stored name and leaving it out keeps it. notes replaces the stored notes and null clears them. attributes sets the custom fields it names and keeps the rest. Unlike contacts->create, an address already in the book is not an error, and unlike contacts->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.
notesstring|nullUp to 5,000 characters. Null clears the notes, and left out, they are kept.
attributesarrayCustom fields to set, as an array 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. Null or an empty string removes a field, a field you leave out keeps its value, and a contact holds at most 50.apiKeystringOverrides the client's API key for this call only.
Returns
An array for the contact as it stands after the save, with audiences.
Example
$contact = $client->contacts->save('grace@example.com', ['name' => 'Grace Hopper']); echo $contact['email'], ' is ', $contact['source'], $contact['createdAt'] === $contact['updatedAt'] ? ', just added' : '', PHP_EOL;Notes
The server answers 201 for a new contact and 200 for one that was there. The SDK returns the same array 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
contacts->create.
Also available in
contacts->deleteMany
Delete up to 200 contacts in one call
deleteMany(array $emails, ?string $apiKey = null): arrayDeletes every address in emails the way contacts->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
emailsstring[]Required1 to 200 addresses, matched case insensitively. More than 200, or none, is a 422 on
emails.apiKeystringOverrides the client's API key for this call only.
Returns
An array 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->deleteMany(['ada@example.com', 'grace@example.com', 'not an address']); echo $result['deleted'], ' deleted, ', $result['saved'], ' of them saved contacts', PHP_EOL; if ($result['invalid'] !== []) { echo 'Skipped: ', implode(', ', $result['invalid']), PHP_EOL;}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->setPhoto
Upload the photo shown for a contact
setPhoto(string $email, mixed $data, ?string $contentType = null, ?string $apiKey = null): arraySends 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 string of bytes, a stream resource, an SplFileInfo or a PSR-7 stream or uploaded file. The type is read from contentType:, or when that is left out from the media type a PSR-7 uploaded file declares, or from the extension of the file an SplFileInfo or a stream points at. Without any of these 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: contacts->save it first.
Parameters
emailstringRequiredThe contact's address, matched case insensitively.
datastring|resource|SplFileInfo|StreamInterfaceRequiredThe image: a string of bytes, a stream resource, an
SplFileInfoor a PSR-7 stream or uploaded file.contentTypestringimage/png,image/jpeg,image/webporimage/gif. Required for a string of bytes, and for a file or stream whose name does not end in.png,.jpg,.jpeg,.webpor.gif.apiKeystringOverrides the client's API key for this call only.
Returns
An array for the contact with the new photoUrl.
Example
$client->contacts->save('grace@example.com'); $contact = $client->contacts->setPhoto('grace@example.com', file_get_contents('photo.jpg'), contentType: 'image/jpeg'); echo 'Photo at ', $contact['photoUrl'], PHP_EOL;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->removePhoto
Remove a contact photo
removePhoto(string $email, ?string $apiKey = null): arrayTakes 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 null. Removing a photo from a contact that has none changes nothing.
Parameters
emailstringRequiredThe contact's address, matched case insensitively.
apiKeystringOverrides the client's API key for this call only.
Returns
An array for the contact with photoUrl null.
Example
$contact = $client->contacts->removePhoto('grace@example.com'); echo $contact['email'], ' now shows ', $contact['photoUrl'] ?? 'initials', PHP_EOL;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(string $email, ?string $apiKey = null): arrayPuts 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.
apiKeystringOverrides the client's API key for this call only.
Returns
An array with object set to contact_block, email, blocked set to true, blockedBy and created.
Example
$block = $client->contacts->block('ada+news@example.com'); if ($block['created']) { echo 'Blocked ', $block['email'], PHP_EOL;} else { echo 'Already blocked by ', $block['blockedBy']['rule'], ' in ', $block['blockedBy']['list'], PHP_EOL;}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(string $email, ?string $apiKey = null): arrayTakes 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.
apiKeystringOverrides the client's API key for this call only.
Returns
An array with object set to contact_block, email, blocked set to false and removed, each entry of which is an array with rule and list.
Example
use Nextmail\Constants\ContactBlockLists; $unblock = $client->contacts->unblock('ada@example.com'); foreach ($unblock['removed'] as $removed) { if ($removed['list'] === ContactBlockLists::BLOCKED_DOMAINS) { echo 'Everybody at ', $removed['rule'], ' is unblocked too', PHP_EOL; }}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->listThreads
List the conversations with one person
listThreads( string $email, ?string $q = null, ?string $sort = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): 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 nextCursor back as cursor:, with the same q: and sort:, while hasMore 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, also inNextmail\Constants\ContactThreadSorts.limitintThreads per page, 1 to 100. The server defaults to 25.
cursorstringThe
nextCursorfrom the previous page. Never build one yourself.apiKeystringOverrides the client's API key for this call only.
Returns
A Page of thread summary arrays, with items, hasMore and nextCursor.
Example
$threads = $client->contacts->listThreads('grace@example.com', q: 'invoice', limit: 10); foreach ($threads as $thread) { echo $thread['receivedAt'], ' ', $thread['subject'], ' (', $thread['messageCount'], ')', $thread['hasUnread'] ? ', unread' : '', PHP_EOL;}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->listAllThreads
Collect every conversation with one person into one array
listAllThreads( string $email, ?string $q = null, ?string $sort = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): arrayFollows nextCursor from page to page and returns every thread contacts->listThreads would list for the address, in the same order.
Everything is held in memory before the call returns. Prefer contacts->iterateThreads 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.limitintPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorstringA cursor from an earlier page to start after.
apiKeystringOverrides the client's API key for every page of this walk.
Returns
A list of thread summary arrays holding every thread across all pages.
Example
$threads = $client->contacts->listAllThreads('grace@example.com', sort: 'oldest', limit: 100); $unread = array_filter($threads, static fn(array $thread): bool => $thread['hasUnread']); echo count($threads), ' conversations, ', count($unread), ' with unread mail', PHP_EOL;Notes
A failure on any page throws out of the whole call, and the threads already fetched are discarded.
Also available in
contacts->iterateThreads
Stream the conversations with one person one thread at a time
iterateThreads( string $email, ?string $q = null, ?string $sort = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): GeneratorReturns a Generator that yields the threads contacts->listThreads lists for the address, one at a time, and requests the next page only once the current one is used up. Nothing is fetched until the loop starts, and breaking out of the foreach 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.limitintPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorstringA cursor from an earlier page to start after.
apiKeystringOverrides the client's API key for every page of this walk.
Returns
A Generator that yields one thread summary array per step.
Example
foreach ($client->contacts->iterateThreads('grace@example.com') as $thread) { if ($thread['hasUnread']) { echo 'Newest unread: ', $thread['subject'], ' from ', $thread['from']['email'], PHP_EOL; break; }}Notes
The generator 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( string $email, ?int $minutes = null, ?string $grain = null, ?int $offsetMinutes = null, ?string $apiKey = null,): arrayReturns 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 offsetMinutes: 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.
minutesintWindow length in minutes, from 1 to about 20 years. The server defaults to 90 days.
grainstringBucket width:
minute,hourorday, defaulting today.offsetMinutesintMinutes east of UTC to cut the buckets in, from -840 to 840, defaulting to 0. Pass
intdiv((new DateTimeImmutable())->getOffset(), 60)for the local zone.apiKeystringOverrides the client's API key for this call only.
Returns
An array 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 null when there is no reply to measure.
Example
$activity = $client->contacts->activity( 'grace@example.com', minutes: 30 * 24 * 60, offsetMinutes: intdiv((new \DateTimeImmutable())->getOffset(), 60),); $totals = $activity['totals']; echo $totals['received'], ' received, ', $totals['sent'], ' sent, ', $totals['waiting'], ' waiting on a reply', PHP_EOL; if ($activity['replyTime']['yours'] !== null) { echo 'You answer in ', round($activity['replyTime']['yours'] / 3600000, 1), ' hours', PHP_EOL;}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->listEvents
List the events recorded for one contact
listEvents( string $email, ?string $name = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): 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 nextCursor back as cursor:, with the same name:, while hasMore is true. listAllEvents and iterateEvents 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.
limitintEvents per page, a whole number from 1 to 200. The server defaults to 50.
cursorstringThe
nextCursorfrom the previous page, passed back exactly as it came. One that names no event of this contact is a 400invalid_cursor.apiKeystringOverrides the client's API key for this call only.
Returns
A Page of arrays with items, hasMore and nextCursor. Each item has id, contactId, email, name, properties, occurredAt, mode and createdAt.
Example
$page = $client->contacts->listEvents('ada@example.com', name: 'order.placed'); foreach ($page as $event) { echo $event['occurredAt'], ' ', $event['name'], PHP_EOL;}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->listAllEvents
Collect every event of one contact into one array
listAllEvents( string $email, ?string $name = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): arrayFollows nextCursor from page to page and returns every event recorded for the contact in the last 90 days, the most recent first, in the shape listEvents 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.
limitintPage size per request, from 1 to 200, defaulting to 50 on the server.
cursorstringA
nextCursorfrom an earlier page to start after.apiKeystringOverrides the client's API key for every page of this walk.
Returns
A list of arrays holding every matching event across all pages, each shaped like an item of listEvents.
Example
$events = $client->contacts->listAllEvents('ada@example.com'); $names = array_unique(array_column($events, 'name')); echo count($events), ' events: ', implode(', ', $names), PHP_EOL;Notes
A failure on any page throws out of the whole call, and the events already fetched are discarded.
Also available in
contacts->iterateEvents
Stream the events of one contact one at a time
iterateEvents( string $email, ?string $name = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): GeneratorReturns a Generator that yields the events of a contact one by one, the most recent first, and requests the next page only once the current one is drained. 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.
limitintPage size per request, from 1 to 200, defaulting to 50 on the server.
cursorstringA
nextCursorfrom an earlier page to start after.apiKeystringOverrides the client's API key for every page of this walk.
Returns
A Generator that yields one event array per step.
Example
foreach ($client->contacts->iterateEvents('ada@example.com') as $event) { if ($event['name'] === 'plan.cancelled') { echo 'Cancelled on ', $event['occurredAt'], PHP_EOL; break; }}Notes
The generator is lazy, so an abandoned loop costs only the pages you consumed.
Also available in
contacts->listCards
List the address book as contact cards
listCards( ?string $email = null, ?bool $withoutEmail = null, ?string $kind = null, ?string $groupId = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): 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 withoutEmail: 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 nextCursor goes back as cursor: while hasMore is true. Never build a cursor yourself.
Parameters
emailstringOnly the card of the saved contact with this address.
withoutEmailboolTrue lists only the cards that have no email address.
kindstringgrouplists only the groups,individualonly the people and companies, as inContactCardKinds.groupIdstringOnly the cards in the group with this id.
limitintCards per page, a whole number from 1 to 200. The server defaults to 50.
cursorstringThe
nextCursorfrom the previous page. Never build one yourself.apiKeystringOverrides the client's API key for this call only.
Returns
A Page of card arrays, with items, hasMore and nextCursor. Each card has id, uid, email, name, nameParts, nickname, organization, department, title, birthday, notes, the lists emails, phones, addresses and urls, photoUrl, createdAt and updatedAt.
Example
$page = $client->contacts->listCards(withoutEmail: true); foreach ($page as $card) { echo $card['name'] ?? 'No name', ': ', implode(', ', array_column($card['phones'], 'value')), PHP_EOL;} if ($page->hasMore) { $next = $client->contacts->listCards(withoutEmail: true, cursor: $page->nextCursor); echo count($next), ' more', PHP_EOL;}Notes
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->listAllCards
Collect every contact card into one array
listAllCards( ?string $email = null, ?bool $withoutEmail = null, ?string $kind = null, ?string $groupId = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): arrayFollows nextCursor from page to page and returns every card in the address book, newest first. It takes the same email: and withoutEmail: filters as contacts->listCards.
Everything is held in memory before the call returns. Prefer contacts->iterateCards 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.
withoutEmailboolTrue lists only the cards that have no email address.
kindstringgrouplists only the groups,individualonly the people and companies, as inContactCardKinds.groupIdstringOnly the cards in the group with this id.
limitintPage size per request, from 1 to 200, defaulting to 50 on the server.
cursorstringA cursor from an earlier page to start after.
apiKeystringOverrides the client's API key for every page of this walk.
Returns
A list of card arrays holding every card across all pages.
Example
$cards = $client->contacts->listAllCards(); echo count($cards), ' cards in the address book', PHP_EOL;Notes
A failure on any page throws out of the whole call, and the cards already fetched are discarded.
Also available in
contacts->iterateCards
Stream the address book one card at a time
iterateCards( ?string $email = null, ?bool $withoutEmail = null, ?string $kind = null, ?string $groupId = null, ?int $limit = null, ?string $cursor = null, ?string $apiKey = null,): GeneratorReturns a Generator that yields cards one at a time, newest first, and requests the next page only once the current one is used up. Nothing is fetched until the loop starts, and breaking out of the foreach stops the requests. It takes the same email: and withoutEmail: filters as contacts->listCards.
Parameters
emailstringOnly the card of the saved contact with this address.
withoutEmailboolTrue lists only the cards that have no email address.
kindstringgrouplists only the groups,individualonly the people and companies, as inContactCardKinds.groupIdstringOnly the cards in the group with this id.
limitintPage size per request, from 1 to 200, defaulting to 50 on the server.
cursorstringA cursor from an earlier page to start after.
apiKeystringOverrides the client's API key for every page of this walk.
Returns
A Generator that yields one card array per step.
Example
foreach ($client->contacts->iterateCards() as $card) { if ($card['birthday'] !== null) { echo $card['name'], ': ', $card['birthday'], PHP_EOL; }}Notes
The generator is lazy, so an abandoned loop costs only the pages you consumed.
Also available in
contacts->getCard
Get one contact card
getCard(string $id, ?string $apiKey = null): arrayReturns one card with everything it holds. To find the card of a saved contact by its address, pass email: to contacts->listCards.
Parameters
idstringRequiredThe card id,
ccd_followed by 24 characters, fromcontacts->listCardsorcontacts->getCard.apiKeystringOverrides the client's API key for this call only.
Returns
An array with id, uid, the vCard UID that phones and computers know the card by, email, null on a card with no address, name, nameParts, nickname, organization, department, title, birthday, notes, photoUrl, createdAt and updatedAt. emails, phones and urls are lists of arrays with value, label and customLabel, and addresses is a list of arrays with label, customLabel, street, locality, region, postalCode and country.
Example
use Nextmail\Exception\NotFoundException; try { $card = $client->contacts->getCard('ccd_0123456789abcdef01234567'); echo $card['name'], ', ', $card['organization'] ?? 'no organisation', PHP_EOL;} catch (NotFoundException) { echo 'No card has that id', PHP_EOL;}Notes
An id that names no card is a 404
contact_card_not_found, thrown as aNotFoundException.
Also available in
contacts->createCard
Add a card to the address book
createCard(array $body, ?string $apiKey = null): arrayAdds a contact card. With email the card is a saved contact as well, the same one contacts->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 an array with value, and optionally label, one of Nextmail\Constants\ContactCardLabels, 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
emailstring|nullThe 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.namestring|nullThe full name the address book shows, up to 200 characters.
namePartsarray|nullThe name in parts, an array with
prefix,given,middle,familyandsuffix, the way phones keep it.nicknamestring|nullA nickname.
organizationstring|nullThe company or organisation.
departmentstring|nullThe department within the organisation.
titlestring|nullThe job title.
birthdaystring|nullYYYY-MM-DD, or--MM-DDwhen the year is not known.notesstring|nullFree-form notes. On a saved contact these are the notes the contact page shows.
emailsarrayOther email addresses besides
email, each an array withvalue, and optionallylabelandcustomLabel.phonesarrayPhone numbers, each an array with
value, and optionallylabelandcustomLabel.addressesarrayPostal addresses, each an array with any of
label,customLabel,street,locality,region,postalCodeandcountry.urlsarrayWebsites and profile links, each an array with
value, and optionallylabelandcustomLabel.kindstringgroupmakes a group, the kind phones keep, which needsnameand takesmembersinstead of an address.individualwhen left out.membersarrayFor a group, the ids of the cards in it, up to 2,000. Groups cannot hold other groups.
apiKeystringOverrides the client's API key for this call only.
Returns
An array for the new card, with the fields contacts->getCard returns.
Example
use Nextmail\Constants\ContactCardLabels; $card = $client->contacts->createCard([ 'email' => 'ada@example.com', 'name' => 'Ada Lovelace', 'organization' => 'Analytical Engines', 'phones' => [['value' => '+44 20 7946 0000', 'label' => ContactCardLabels::WORK]], 'birthday' => '1815-12-10',]); echo $card['id'], ' ', $card['email'], PHP_EOL;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->updateCard
Change a contact card
updateCard(string $id, array $patch, ?string $apiKey = null): arrayChanges the fields you send and leaves the rest alone. Null 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, fromcontacts->listCardsorcontacts->getCard.emailstring|nullThe 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.namestring|nullThe full name the address book shows, up to 200 characters.
namePartsarray|nullThe name in parts, an array with
prefix,given,middle,familyandsuffix, the way phones keep it.nicknamestring|nullA nickname.
organizationstring|nullThe company or organisation.
departmentstring|nullThe department within the organisation.
titlestring|nullThe job title.
birthdaystring|nullYYYY-MM-DD, or--MM-DDwhen the year is not known.notesstring|nullFree-form notes. On a saved contact these are the notes the contact page shows.
emailsarrayOther email addresses besides
email, each an array withvalue, and optionallylabelandcustomLabel. The list replaces the one the card has.phonesarrayPhone numbers, each an array with
value, and optionallylabelandcustomLabel. The list replaces the one the card has.addressesarrayPostal addresses, each an array with any of
label,customLabel,street,locality,region,postalCodeandcountry. The list replaces the one the card has.urlsarrayWebsites and profile links, each an array 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.membersarrayFor 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.
apiKeystringOverrides the client's API key for this call only.
Returns
An array for the card as it stands after the change.
Example
use Nextmail\Constants\ContactCardLabels; $card = $client->contacts->getCard('ccd_0123456789abcdef01234567'); $updated = $client->contacts->updateCard($card['id'], [ 'phones' => [...$card['phones'], ['value' => '+1 555 0100', 'label' => ContactCardLabels::MOBILE]],]); echo count($updated['phones']), ' phone numbers', PHP_EOL;Notes
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->deleteCard
Delete a contact card
deleteCard(string $id, ?string $apiKey = null): arrayRemoves the card from the address book and from every phone and computer that syncs it. On a saved contact it is the same as contacts->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, fromcontacts->listCardsorcontacts->getCard.apiKeystringOverrides the client's API key for this call only.
Returns
An array with object set to contact_card, id and deleted set to true.
Example
$removed = $client->contacts->deleteCard('ccd_0123456789abcdef01234567'); echo $removed['id'], ' deleted', PHP_EOL;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->findDuplicateCards
Find duplicate contact cards
findDuplicateCards(?string $apiKey = null): arrayFinds 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 contacts->mergeCards.
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
apiKeystringOverrides the client's API key for this call only.
Returns
An array with data, each group an array with object set to contact_card_duplicates, reason, as in ContactCardDuplicateReasons, and cards, and hasMore, true when more than 100 groups were found.
Example
$found = $client->contacts->findDuplicateCards(); foreach ($found['data'] as $group) { $keep = $group['cards'][0]; echo $group['reason'], ': keep ', $keep['name'] ?? $keep['id'], ', merge ', count($group['cards']) - 1, PHP_EOL;}Notes
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->mergeCards
Merge contact cards
mergeCards(string $id, array $body, ?string $apiKey = null): arrayFolds 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
contacts->listCards,contacts->getCardorcontacts->findDuplicateCards.cardIdsarrayRequiredThe cards to fold into it, 1 to 10 of them. They are deleted once their details are kept.
apiKeystringOverrides the client's API key for this call only.
Returns
The card that kept everything, as an array.
Example
$card = $client->contacts->mergeCards('ccd_0123456789abcdef01234567', ['cardIds' => ['ccd_89abcdef0123456789abcdef']]); echo $card['name'] ?? $card['id'], ' keeps ', count($card['emails']), ' other addresses', PHP_EOL;Notes
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->listBirthdays
List birthdays
listBirthdays( DateTimeInterface|string $from, DateTimeInterface|string $to, ?string $timezone = null, ?string $apiKey = null,): arrayReturns 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 DateTimeInterface 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
fromstring|DateTimeInterfaceRequiredThe start of the window.
tostring|DateTimeInterfaceRequiredThe end of the window, after
from:and at most 366 days later.timezonestringIANA zone such as
Europe/London, at most 64 characters. Defaults toUTC.apiKeystringOverrides the client's API key for this call only.
Returns
A list of arrays sorted by date and then by name, each with cardId, contactId, email, name, birthday, date, age and photoUrl.
Example
$from = new \DateTimeImmutable();$birthdays = $client->contacts->listBirthdays(from: $from, to: $from->modify('+30 days'), timezone: 'Europe/London'); foreach ($birthdays as $birthday) { echo $birthday['date'], ' ', $birthday['name'] ?? $birthday['cardId'], ' ', $birthday['age'] ?? 'age not known', PHP_EOL;}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->importVcf
Import a contacts file
importVcf(mixed $data, ?string $filename = null, ?string $apiKey = null): arraySends 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 contacts->getImport 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 string of bytes, a stream resource, an SplFileInfo or a PSR-7 stream or uploaded file, and it goes out as text/vcard whatever the file is called.
Parameters
datastring|resource|SplFileInfo|StreamInterfaceRequiredThe .vcf file: a string of bytes, a stream resource, an
SplFileInfoor a PSR-7 stream or uploaded file.filenamestringThe name to show for the file in the list of imports, at most 255 characters. It is not read from the file, so left out the import has
fileNamenull.apiKeystringOverrides the client's API key for this call only.
Returns
An array for the import with object set to contact_import and status set to queued, shaped like the one contacts->getImport returns.
Example
use Nextmail\Constants\ItemImportStatuses; $import = $client->contacts->importVcf(new \SplFileInfo('contacts.vcf'), filename: 'contacts.vcf'); while (in_array($import['status'], [ItemImportStatuses::QUEUED, ItemImportStatuses::RUNNING], true)) { sleep(2); $import = $client->contacts->getImport($import['id']);} echo $import['status'], ': ', $import['counts']['imported'], ' cards added, ', $import['counts']['merged'], ' already here', PHP_EOL;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 PHP string is already bytes.
An upload that outlasts the client's
timeoutfails as aNetworkException, so raise it on the client for a large file on a slow connection.Not retried automatically.
Also available in
contacts->listImports
List contacts imports
listImports(?int $limit = null, ?string $cursor = null, ?string $apiKey = null): 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 contacts->importVcf 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 nextCursor goes back as cursor: while hasMore is true. contacts->listAllImports and contacts->iterateImports do that walk for you.
Parameters
limitintImports per page, a whole number from 1 to 100. The server defaults to 25.
cursorstringThe
nextCursorfrom the previous page. Never build one yourself.apiKeystringOverrides the client's API key for this call only.
Returns
A Page of import arrays, with items, hasMore and nextCursor. Each import is shaped like the one contacts->getImport returns.
Example
$page = $client->contacts->listImports(limit: 50); foreach ($page as $import) { echo $import['fileName'] ?? 'From a mailbox import', ': ', $import['status'], ', ', $import['counts']['imported'], ' added, ', $import['counts']['merged'], ' already here', PHP_EOL;} if ($page->hasMore) { $next = $client->contacts->listImports(limit: 50, cursor: $page->nextCursor); echo count($next), ' more', PHP_EOL;}Notes
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
maxRetries, and on a 429 only when it carries aRetry-Afterof a minute or less.
Also available in
contacts->listAllImports
Collect every contacts import into one array
listAllImports(?int $limit = null, ?string $cursor = null, ?string $apiKey = null): arrayFollows nextCursor from page to page and returns every contacts import, newest first.
Everything is held in memory before the call returns. Prefer contacts->iterateImports when you can stop early. limit: sets the page size of each request, not the total.
Parameters
limitintPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorstringA cursor from an earlier page to start after.
apiKeystringOverrides the client's API key for every page of this walk.
Returns
A list of import arrays holding every import across all pages.
Example
$imports = $client->contacts->listAllImports(); $added = array_sum(array_map(static fn(array $import): int => (int) $import['counts']['imported'], $imports)); echo $added, ' cards came from ', count($imports), ' imports', PHP_EOL;Notes
A failure on any page throws out of the whole call, and the imports already fetched are discarded.
Also available in
contacts->iterateImports
Stream contacts imports one at a time
iterateImports(?int $limit = null, ?string $cursor = null, ?string $apiKey = null): GeneratorReturns a Generator that yields contacts imports one at a time, newest first, and requests the next page only once the current one is used up. Nothing is fetched until the loop starts, and breaking out of the foreach stops the requests.
Parameters
limitintPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorstringA cursor from an earlier page to start after.
apiKeystringOverrides the client's API key for every page of this walk.
Returns
A Generator that yields one import array per step.
Example
use Nextmail\Constants\ItemImportStatuses; foreach ($client->contacts->iterateImports() as $import) { if ($import['status'] === ItemImportStatuses::RUNNING) { echo 'Still running: ', $import['id'], ' with ', $import['counts']['total'], ' cards', PHP_EOL; break; }}Notes
The generator is lazy, so an abandoned loop costs only the pages you consumed.
Also available in
contacts->getImport
Get a contacts import
getImport(string $id, ?string $apiKey = null): arrayReturns 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 contacts->importVcf 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.apiKeystringOverrides the client's API key for this call only.
Returns
An array with object set to contact_import, id, kind, source, status, fileName, fileBytes, parentImportId, counts, report, lastError, undoable, createdAt, startedAt, finishedAt and undoneAt. counts holds total, imported, merged, skipped and failed. report holds collections, a list of arrays with name and items, skipped, a count for each reason, and samples, a list of arrays with name and reason. status is one of Nextmail\Constants\ItemImportStatuses and each reason one of Nextmail\Constants\ItemImportSkipReasons.
Example
$import = $client->contacts->getImport('iimp_7b1e4d8f60a5c7b92d3f9c2a'); echo $import['status'], ': ', $import['counts']['imported'], ' added, ', $import['counts']['merged'], ' already here, ', $import['counts']['skipped'], ' left out', PHP_EOL; foreach ($import['report']['samples'] as $sample) { echo $sample['name'], ' was left out: ', $sample['reason'], PHP_EOL;}Notes
An id that names no contacts import is a 404
item_import_not_found, thrown as aNotFoundException.A GET is retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, up to the client's
maxRetries, and on a 429 only when it carries aRetry-Afterof a minute or less.
Also available in
contacts->undoImport
Remove what a contacts import added
undoImport(string $id, ?string $apiKey = null): arrayDeletes 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.apiKeystringOverrides the client's API key for this call only.
Returns
An array for the import with status set to undone and undoneAt set.
Example
use Nextmail\Exception\ConflictException; try { $undone = $client->contacts->undoImport('iimp_7b1e4d8f60a5c7b92d3f9c2a'); echo $undone['counts']['imported'], ' cards removed at ', $undone['undoneAt'], PHP_EOL;} catch (ConflictException) { echo 'That import is still running or was already removed', PHP_EOL;}Notes
An import that is still running, or was already removed, is a 409
item_import_not_undoable, thrown as aConflictException.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