Contacts

from inkbox.contacts.types import ContactEmail, ContactPhone

contact = inkbox.contacts.create(
    given_name="Jane",
    family_name="Doe",
    company_name="Acme Inc.",
    emails=[ContactEmail(value="jane@acme.example", label="work", is_primary=True)],
    phones=[ContactPhone(value="+15551234567", label="mobile")],
)
print(contact.id, contact.preferred_name)

const contact = await inkbox.contacts.create({
  givenName: "Jane",
  familyName: "Doe",
  companyName: "Acme Inc.",
  emails: [{ value: "jane@acme.example", label: "work", isPrimary: true }],
  phones: [{ value: "+15551234567", label: "mobile" }],
});
console.log(contact.id, contact.preferredName);

inkbox contacts create --json '{"givenName":"Jane","familyName":"Doe","companyName":"Acme Inc.","emails":[{"value":"jane@acme.example","label":"work","isPrimary":true}],"phones":[{"value":"+15551234567","label":"mobile"}]}'

# Exact email
matches = inkbox.contacts.lookup(email="jane@acme.example")

# Substring on the email's local part
matches = inkbox.contacts.lookup(email_contains="jane")

# Everyone from this company domain
matches = inkbox.contacts.lookup(email_domain="acme.example")

# Exact phone (E.164)
matches = inkbox.contacts.lookup(phone="+15551234567")

// Exact email
let matches = await inkbox.contacts.lookup({ email: "jane@acme.example" });

// Substring on the email's local part
matches = await inkbox.contacts.lookup({ emailContains: "jane" });

// Everyone from this company domain
matches = await inkbox.contacts.lookup({ emailDomain: "acme.example" });

// Exact phone (E.164)
matches = await inkbox.contacts.lookup({ phone: "+15551234567" });

inkbox contacts lookup --email jane@acme.example
inkbox contacts lookup --email-contains jane
inkbox contacts lookup --email-domain acme.example
inkbox contacts lookup --phone +15551234567

# Export a single contact as vCard text
vcf = inkbox.contacts.vcards.export_vcard(contact.id)
print(vcf)

# Bulk-import from a .vcf file
with open("contacts.vcf", "rb") as fh:
    result = inkbox.contacts.vcards.import_vcards(fh.read())
print(f"Created {result.created_count}, errors {result.error_count}")
for item in result.results:
    if item.status != "created":
        print(f"  card {item.index}: {item.error}")

import { readFile } from "node:fs/promises";

// Export a single contact as vCard text
const vcf = await inkbox.contacts.vcards.export(contact.id);
console.log(vcf);

// Bulk-import from a .vcf file
const body = await readFile("contacts.vcf", "utf-8");
const result = await inkbox.contacts.vcards.import(body);
console.log(`Created ${result.createdCount}, errors ${result.errorCount}`);
for (const item of result.results) {
  if (item.status !== "created") {
      console.log(`  card ${item.index}: ${item.error}`);
  }
}

# Export a single contact
inkbox contacts export <contact-id> > jane-doe.vcf

# Bulk-import from a .vcf file
inkbox contacts import contacts.vcf