Kişiler
`contacts.list`, `get`, `create`, `update` ve `delete`.
Tüm metotlar
const page = await openemail.contacts.list({ limit: 100 }) const contact = await openemail.contacts.get('[email protected]') const saved = await openemail.contacts.create({ email: '[email protected]', name: 'Grace Hopper', notes: 'Met at the compiler workshop', }) await openemail.contacts.update(saved.email, { notes: null }) await openemail.contacts.delete(saved.email) console.log(page.items.length, page.hasMore, contact.source, contact.lastSeenAt)En son görülenler başta, kendisine hiç posta gönderilmemiş kişiler sonda. Satır, bir üye uygulamanın yazma ekranından o adrese mesaj gönderdiği için yazıldığında source değeri auto olur; bu, birinin adresi bilerek kaydetmiş olmasından esasen farklı bir iddiadır. Bir adresten gelen posta hiçbir şey yazmaz, bu API üzerinden yapılan bir gönderim de yazmaz.
Defter tek bir kişiye değil çalışma alanına aittir; bu yüzden herhangi bir üyenin kaydettiği kişi, her üyenin ve her anahtarın gördüğü kişidir. create, source değerini manual olarak yazar ve kişiyi yazıldığı anda varsayılan kitleye koyar. Aynı çağrıda kendi listelerinize de katmak için bunları audienceIds içinde belirtin; bu ayrıca audiences:write gerektirir. Ya da kişiyi sonradan openemail.audiences.addContact ile ekleyin.
Adresler küçük harfe çevrilerek saklanır ve istemci geçirdiğiniz adresi kodlar; böylece [email protected] doğru satıra ulaşır. Adres kimliğin kendisidir, bu yüzden update onu değiştiremez: bir kişiyi taşımak bir delete ve bir create demektir.
Parametreler: contacts.list
limitnumber- Sayfa başına kaç kişi döndürüleceği: 1 ile 200 arasında bir integer, varsayılan 50. Değer dönüştürülür, dolayısıyla bir sorgu dizesinden gelen `'100'` sorun olmaz; aralık dışındaki bir değer ise sınıra çekilmek yerine 422 verir.
cursorstring- Bir önceki sayfadan gelen `nextCursor`. Asla kendiniz oluşturmayın: artık var olmayan bir kişiyi gösteren bir cursor 400 `invalid_cursor` verir; bu da sayfalama durumunuzun eskidiği ve gezinmenin cursor olmadan yeniden başlaması gerektiği anlamına gelir.
sourceContactSource- Birinin bilerek kaydettiği kişiler için `'manual'`, uygulamanın yazma ekranının kaydettikleri için `'auto'`. Defterin tamamı için bu alanı boş bırakın.
Yanıt: ContactResource
contacts.list bir Page<ContactResource> döndürür; satırlar page.items içindedir ve gezinme, page.hasMore true olduğu sürece page.nextCursor değerini izler. get, create ve update her biri tek bir ContactDetailResource döndürür: aynı satır artı audiences. Adres defterinin sınırı yoktur; bu rotanın 200 satırda sessizce duran bir dizi döndürmek yerine sayfalama yapmasının nedeni budur.
object'contact'- Hem liste satırlarında hem de `get` yanıtında her zaman `contact` dizgesi.
emailstring- Adres; yazarken küçük harfe çevrilir, böylece `[email protected]` ile `[email protected]` tek bir kişidir. Hiçbir kişi id'si dışarı verilmediği için her contacts metodunun aldığı anahtar da budur. Satırlar, onları yazan üyeye veya anahtara değil çalışma alanına aittir; dolayısıyla çalışma alanındaki her üye ve her anahtar tek bir adres defterini okur ve yazar.
namestring | null- Görünen ad. Adres için hiç ad kaydedilmemişse null. Otomatik bir yazma, yalnızca başlık adresin kendisinden başka bir şey sağladığında bir ad taşır ve kullanıcının yazdığı bir adın üzerine asla yazamaz.
source'manual' | 'auto' | (string & {})- `auto`, satırın kullanıcı o adrese posta gönderdiği için yazıldığı anlamına gelir; `manual` ise birinin adresi elle girdiği anlamına gelir; bu esasen farklı bir iddiadır ve bir upsert `manual` değerini asla `auto` seviyesine düşürmez. Bir adresten gelen posta bilerek hiç satır yazmaz; dolayısıyla size yalnızca yazmış olan biri burada yer almaz. Sütun, varsayılanı `manual` olan serbest metin olduğu için birleşim tipi açık bırakılmıştır.
notesstring | null- Birinin bu kişi hakkında uygulamada veya `update` üzerinden yazdığı serbest metin; asla üretilmez. Kimse yazmadıysa null olur ve `update` çağrısında açıkça null göndermek bu alanı temizler.
lastSeenAtstring | null- ISO-8601 UTC; bir üye uygulamanın yazma ekranından o adrese her gönderdiğinde güncellenir, o adresten posta geldiğinde değil; gelen posta hiçbir şey yazmaz. `create` ile kaydedilmiş ve kendisine hiç posta gönderilmemiş bir kişide null olur ve bu kişiler, bu rotanın döndürdüğü azalan `lastSeenAt` sıralamasında en sonda yer alır.
audiencesArray<ContactAudienceResource>- Yalnızca `get`, `create` ve `update` yanıtlarında bulunur, liste satırlarında asla. Kişinin içinde bulunduğu her kitle, varsayılan olanı da dahil, `{ id, name, builtin }` biçiminde. Her kişinin ait olduğu kitlede `builtin` değeri `default`, birinin oluşturduğu kitlede null'dır; bu yüzden herkesin değiştirebildiği ada göre değil bu alana göre dallanın.