連絡先

from openemail import openemail page = openemail.contacts.list(limit=100)contact = openemail.contacts.get('[email protected]') saved = openemail.contacts.create({    'email': '[email protected]',    'name': 'Grace Hopper',    'notes': 'Met at the compiler workshop',}) openemail.contacts.update(saved['email'], {'notes': None})openemail.contacts.set_audiences(saved['email'], {    'audienceIds': ['aud_4c1b8e2a7d9f05c36b4e8a71'],})openemail.contacts.delete(saved['email']) print(len(page['items']), page['hasMore'], contact['source'], contact['lastSeenAt'])

直近に見かけた順で、一度もメールを送っていない連絡先は末尾になります。source が auto なのは、メンバーがアプリのコンポーザーからそのアドレスにメッセージを送ったために行が書かれた場合で、これは誰かが保存したという主張とは意味が大きく異なります。アドレスからメールが届いても何も書かれませんし、この API 経由の送信でも書かれません。

アドレス帳は個人ではなくワークスペースに属するので、どのメンバーが保存した連絡先も、すべてのメンバーとすべてのキーから見える同じ連絡先です。create は source を manual として書き込み、書き込みと同時に連絡先を既定オーディエンスに入れます。独自のリストは audienceIds に指定すれば同じ呼び出しで参加させられますが、これには audiences:write も必要です。あるいは後から openemail.audiences.add_contact で追加してください。set_audiences を使えば、連絡先がどのリストに入るかを 1 回の呼び出しで正確に指定できます。

contacts.list は Page[ContactResource] を返すので、行は page['items'] にあり、page['hasMore'] が True の間は page['nextCursor'] をたどります。これは list_all と iterate が代わりに行います。get、create、save、update、set_audiences、set_photo、remove_photo はそれぞれ 1 件の ContactDetailResource、つまり同じ行に audiences を加えたものを返します。アドレス帳に上限はなく、だからこの経路は、黙って 200 件で止まるリストではなくページングを行います。

set_audiences(email, {'audienceIds': [...]}) は、1 件の連絡先がどのオーディエンスに入るかを 1 回のリクエストで正確に指定します。連絡先は指定されたオーディエンスのうちまだ入っていないものすべてに参加し、それ以外のすべてから抜け、呼び出しは変更後の ContactDetailResource を返します。連絡先ではなくメンバーシップを書き込むため audiences:write が必要で、繰り返しても何も変わりません。

list_people はアプリの連絡先ページに表示される人を一覧にします。保存済みの連絡先と、メールで見かけたすべてのアドレスで、それぞれに saved、threads、lastAt が付きます。list は保存済みの連絡先だけです。メールで見かけたアドレスが返るのはキーが threads:read も持っている場合だけで、返ったかどうかは page['seen'] でわかります。sort は recent、name、threads のいずれか、q は名前、アドレス、メモを検索し、blocked=True はワークスペースのブロックリストがブロックしている人だけを残します。ドメイン全体のルールも含みます。blockedBy は各行でそのルールを示します。

from openemail import openemail page = openemail.contacts.list_people(sort='threads', limit=50) for person in page['items']:    if not person['saved'] and (person['threads'] or 0) > 5:        openemail.contacts.save(person['email']) blocked = openemail.contacts.list_all_people(blocked=True)

save(email, {'name': ..., 'notes': ...}) は連絡先に追加と連絡先に残すに当たります。まだ連絡先でないアドレスを保存し、送信から記録されたものは手動で保存したものとして残し、削除したものは元に戻します。delete は削除に当たります。保存済みの連絡先を消してアドレスを非表示にするので、作成画面が再び記録することはなく、メールで見かけただけのアドレスも受け付けます。どちらだったかは wasSaved でわかります。delete_many は 1 回の呼び出しで最大 200 件を削除します。

from pathlib import Path from openemail import openemail openemail.contacts.save('[email protected]', {'name': 'Grace Hopper'}) photo = Path('grace.jpg').read_bytes()contact = openemail.contacts.set_photo('[email protected]', photo, content_type='image/jpeg') openemail.contacts.remove_photo('[email protected]')openemail.contacts.delete_many(['[email protected]', '[email protected]'])

block(email) はアドレスをワークスペースのブロックリストに載せてそこからのメールを拒否し、プラスタグは取り除きます。unblock(email) はそのアドレスをブロックしているルールをすべて外します。どちらも連絡先ではなくブロックリストを変更するので settings:write が必要で、どちらもアドレスが連絡先である必要はありません。

list_threads(email) は、そのアドレスが書いた、またはそのアドレス宛に書かれたスレッドを、すべてのフォルダーからページごとにたどり、list_all_threads と iterate_threads はすべてをたどります。activity(email) は連絡先のアクティビティタブの数値を返します。区間ごとの受信数と送信数、返信待ちのスレッド、双方向の返信時間の中央値です。どちらも threads:read が必要です。

import time from openemail import openemail threads = openemail.contacts.list_threads('[email protected]', q='invoice') activity = openemail.contacts.activity(    '[email protected]',    minutes=30 * 24 * 60,    grain='day',    offset_minutes=time.localtime().tm_gmtoff // 60,) print(len(threads['items']), activity['totals']['waiting'])

• contacts.list()完全なリファレンス
• contacts.list_all()完全なリファレンス
• contacts.iterate()完全なリファレンス
• contacts.get()完全なリファレンス
• contacts.create()完全なリファレンス
• contacts.save()完全なリファレンス
• contacts.update()完全なリファレンス
• contacts.set_audiences()完全なリファレンス
• contacts.delete()完全なリファレンス
• contacts.delete_many()完全なリファレンス
• contacts.list_people()完全なリファレンス
• contacts.list_all_people()完全なリファレンス
• contacts.iterate_people()完全なリファレンス
• contacts.set_photo()完全なリファレンス
• contacts.remove_photo()完全なリファレンス
• contacts.block()完全なリファレンス
• contacts.unblock()完全なリファレンス
• contacts.list_threads()完全なリファレンス
• contacts.list_all_threads()完全なリファレンス
• contacts.iterate_threads()完全なリファレンス
• contacts.activity()完全なリファレンス