Contactos

$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 devuelve primero los contactos vistos más recientemente, y al final los contactos a los que nunca se ha escrito. source es auto cuando la fila se escribió porque un miembro envió un mensaje a esa dirección desde el redactor de la aplicación, lo que es una afirmación sustancialmente distinta de que alguien la haya guardado. El correo que llega desde una dirección no escribe nada, y un envío a través de esta API tampoco.

La libreta pertenece al espacio de trabajo y no a una persona, así que un contacto guardado por cualquier miembro es el contacto que ven todos los miembros y todas las claves. create escribe source como manual y coloca el contacto en la audiencia por defecto en el momento de escribirlo. Nombra tus propias listas en audienceIds para unirlo a ellas en la misma llamada, lo que además requiere audiences:write, o añade el contacto más tarde con audiences->addContact, que se trata en la página Audiencias. setAudiences indica exactamente en qué listas está un contacto, en una sola llamada.

contacts->list devuelve una OpenEmail\Result\Page, así que las filas están en $page->items y el recorrido sigue $page->nextCursor mientras $page->hasMore sea true. listAll devuelve todas las filas como un solo array, e iterate devuelve un Generator que las entrega de una en una. get, create, update, save y setAudiences devuelven cada uno un contacto como un array con claves en camelCase, la misma fila más audiences. La libreta de direcciones no tiene límite, y por eso esta ruta pagina en lugar de devolver un array que se detuvo en silencio en 200.

setAudiences($email, ['audienceIds' => [...]]) indica exactamente en qué audiencias está un contacto, en una sola solicitud. El contacto se une a cada audiencia indicada en la que aún no está y sale de todas las demás, y la llamada devuelve el contacto tras el cambio, con sus audiences. Necesita audiences:write, porque escribe pertenencias y no el contacto, y repetirla no cambia nada, así que el cliente la reintenta tras un fallo de red.

listPeople lista a las personas que muestra la página de Contactos de la app: los contactos guardados y cada dirección vista en el correo, cada una con saved, threads y lastAt, y devuelve una OpenEmail\Result\PeoplePage, que añade seen a items, hasMore y nextCursor. list son solo los contactos guardados. Las direcciones vistas en el correo solo llegan cuando la clave también tiene threads:read, y $page->seen dice si llegaron. sort: es recent, name o threads, y OpenEmail\Constants\PeopleSorts los nombra. q: busca en nombres, direcciones y notas, y blocked: true se queda con las personas que bloquea la lista de bloqueo del espacio de trabajo, incluidas las reglas de dominio entero. blockedBy nombra la regla en cada fila.

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), con un array opcional de name y notes, es Añadir a contactos y Mantener en contactos: guarda una dirección que aún no es un contacto, mantiene como guardada a mano una registrada desde un envío y recupera una eliminada. delete es Eliminar: quita el contacto guardado y oculta la dirección, para que el redactor no la vuelva a registrar, y también acepta una dirección solo vista en el correo. wasSaved, en el array que devuelve, dice cuál de los dos casos era. deleteMany elimina hasta 200 en una sola llamada.

$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) pone la dirección en la lista de bloqueo del espacio de trabajo para que su correo se rechace, quitando cualquier etiqueta con más, y unblock($email) quita cada regla que la bloquea. Los dos necesitan settings:write, porque cambian la lista de bloqueo y no el contacto, y ninguno necesita que la dirección sea un contacto.

listThreads($email) recorre por páginas los hilos que la dirección escribió o en los que se le escribió, en todas las carpetas, y listAllThreads e iterateThreads los recorren enteros. activity($email) devuelve las cifras de la pestaña Actividad de un contacto: recibidos y enviados por intervalo, hilos que esperan tu respuesta y la mediana del tiempo de respuesta en cada sentido. Los dos necesitan 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;