Kontakte

$page = $client->contacts->list(limit: 100);$contact = $client->contacts->get('[email protected]'); $saved = $client->contacts->create([    'email' => '[email protected]',    'name' => 'Grace Hopper',    'notes' => 'Met at the compiler workshop',]); $client->contacts->update('[email protected]', ['notes' => null]);$client->contacts->setAudiences('[email protected]', ['audienceIds' => ['aud_4c1b8e2a7d9f05c36b4e8a71']]);$client->contacts->delete('[email protected]'); echo count($page), ' ', $page->hasMore ? 'more to come' : 'that is all', PHP_EOL;echo $contact['source'], ' ', $contact['lastSeenAt'] ?? 'never mailed', ' ', $saved['source'], PHP_EOL;

list gibt die zuletzt gesehenen Kontakte zuerst zurück und Kontakte, an die nie gesendet wurde, zuletzt. source ist auto, wenn die Zeile geschrieben wurde, weil ein Mitglied dieser Adresse eine Nachricht aus dem Composer der App gesendet hat, was eine inhaltlich andere Aussage ist als das bewusste Speichern durch jemanden. Eingehende Mail von einer Adresse schreibt nichts, ein Versand über diese API ebenso wenig.

Das Adressbuch gehört dem Workspace und nicht einer einzelnen Person, ein von irgendeinem Mitglied gespeicherter Kontakt ist daher der Kontakt, den jedes Mitglied und jeder Schlüssel sieht. create schreibt source als manual und legt den Kontakt beim Schreiben in die Standard-Audience. Nennen Sie eigene Listen in audienceIds, um sie im selben Aufruf zuzuordnen, was zusätzlich audiences:write erfordert, oder fügen Sie den Kontakt später mit audiences->addContact hinzu, das die Seite Audiences behandelt. setAudiences legt in einem Aufruf genau fest, in welchen Listen ein Kontakt ist.

contacts->list gibt eine OpenEmail\Result\Page zurück, die Zeilen liegen daher auf $page->items, und der Durchlauf folgt $page->nextCursor, solange $page->hasMore true ist. listAll gibt alle Zeilen als ein einziges Array zurück, und iterate gibt einen Generator zurück, der sie einzeln liefert. get, create, update, save und setAudiences geben jeweils einen Kontakt als Array mit camelCase-Schlüsseln zurück, dieselbe Zeile plus audiences. Das Adressbuch ist unbegrenzt, deshalb paginiert diese Route, statt ein Array zurückzugeben, das stillschweigend bei 200 endet.

setAudiences($email, ['audienceIds' => [...]]) legt in einer Anfrage genau fest, in welchen Audiences ein Kontakt ist. Der Kontakt tritt jeder genannten Audience bei, in der er noch nicht ist, und verlässt jede andere, und der Aufruf gibt den Kontakt nach der Änderung zurück, mit seinen audiences. Er erfordert audiences:write, weil er Mitgliedschaften schreibt und nicht den Kontakt, und eine Wiederholung ändert nichts. Der Client wiederholt ihn daher nach einem Netzwerkfehler.

listPeople listet die Personen, die die Kontaktseite der App zeigt: die gespeicherten Kontakte und jede in Mails gesehene Adresse, jeweils mit saved, threads und lastAt, und gibt eine OpenEmail\Result\PeoplePage zurück, die zu items, hasMore und nextCursor noch seen ergänzt. list liefert dagegen nur die gespeicherten Kontakte. Die in Mails gesehenen Adressen kommen nur, wenn der Schlüssel auch threads:read hat, und $page->seen sagt, ob sie gekommen sind. sort: ist recent, name oder threads, und OpenEmail\Constants\PeopleSorts nennt sie. q: durchsucht Namen, Adressen und Notizen, und blocked: true behält die Personen, die die Blockliste des Workspace blockiert, Regeln für ganze Domains eingeschlossen. blockedBy nennt die Regel in jeder Zeile.

use OpenEmail\Constants\PeopleSorts; $page = $client->contacts->listPeople(sort: PeopleSorts::THREADS, limit: 50); foreach ($page as $person) {    if (!$person['saved'] && $person['threads'] > 5) {        $client->contacts->save($person['email']);    }} $blocked = $client->contacts->listAllPeople(blocked: true);echo $page->seen ? 'saved and seen' : 'saved only', ', ', count($blocked), ' blocked', PHP_EOL;

save($email) mit einem optionalen Array aus name und notes entspricht Zu Kontakten hinzufügen und In Kontakten behalten: Es speichert eine Adresse, die noch kein Kontakt ist, behält eine aus einem Versand erfasste als von Hand gespeichert und holt eine gelöschte zurück. delete entspricht Löschen: Es entfernt den gespeicherten Kontakt und blendet die Adresse aus, damit der Composer sie nicht wieder erfasst, und nimmt auch eine Adresse, die nur in Mails vorkam. wasSaved im zurückgegebenen Array sagt, was davon es war. deleteMany löscht bis zu 200 in einem Aufruf.

$client->contacts->save('[email protected]', ['name' => 'Grace Hopper']); $contact = $client->contacts->setPhoto('[email protected]', file_get_contents('photo.jpg'), contentType: 'image/jpeg');echo $contact['photoUrl'], PHP_EOL; $client->contacts->setPhoto('[email protected]', new \SplFileInfo('avatar.png')); $client->contacts->removePhoto('[email protected]');$client->contacts->deleteMany(['[email protected]', '[email protected]']);

block($email) setzt die Adresse auf die Blockliste des Workspace, sodass Mails von ihr abgewiesen werden, und lässt ein Plus-Tag weg, und unblock($email) nimmt jede Regel ab, die sie blockiert. Beide brauchen settings:write, weil sie die Blockliste ändern und nicht den Kontakt, und bei keinem muss die Adresse ein Kontakt sein.

listThreads($email) blättert durch die Threads, die die Adresse geschrieben hat oder die an sie gingen, in jedem Ordner, und listAllThreads und iterateThreads durchlaufen sie. activity($email) liefert die Zahlen hinter dem Tab Aktivität eines Kontakts: empfangen und gesendet pro Abschnitt, Threads, die auf Ihre Antwort warten, und die mittlere Antwortzeit in beide Richtungen. Beide brauchen threads:read.

$threads = $client->contacts->listThreads('[email protected]', q: 'invoice'); $activity = $client->contacts->activity(    '[email protected]',    minutes: 30 * 24 * 60,    grain: 'day',    offsetMinutes: intdiv((int) date('Z'), 60),); echo count($threads), ' threads, ', $activity['totals']['waiting'], ' waiting on you', PHP_EOL;