SDK
Domēni
`domains.list`, `get` un `update`.
Visas metodes
const domains = await openemail.domains.list()const domain = await openemail.domains.get('b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f') console.log(domain.receiving.verified, domain.sending.status)for (const address of domain.addresses) console.log(address.address, address.enabled) const updated = await openemail.domains.update(domain.id, { trackingHost: 'links.acme.com' })console.log(updated.tracking.status, updated.tracking.record?.name, updated.tracking.record?.value) await openemail.domains.update(domain.id, { trackingHost: null })Saņemšana un sūtīšana ir divi neatkarīgi fakti un tiek atgriezti kā divi objekti. receiving.verified nozīmē, ka domēna MX atved tā pastu šurp un ir publicēts īpašumtiesību izaicinājums. sending ziņo par izejošās parakstīšanas pārbaudi: status ir verified, pending, failed, no_identity vai unknown, un canSend pasaka, vai sūtījums no šī domēna šobrīd tiktu pieņemts. Negatīvs spriedums, kas vecāks par dienu, tiek uzskatīts par nezināmu, nevis par atteikumu, tāpēc zarojiet pēc canSend, nevis pēc status.
update iestata, pārbauda no jauna vai noņem domēna paša izsekošanas domēnu — apakšdomēnu, piemēram, links.acme.com — un atrisinās par to pašu DomainDetailResource, ko get. tracking par to ziņo katrā lasījumā. Kamēr pārbaude nav izturēta, tracking.status ir pending, un izsekotās saites un atvēršanas pikselis turpina izmantot noklusējuma OpenEmail resursdatoru. Tiklīdz kāda pārbaude ir izturēta, tas ir active, un jaunais pasts no domēna abiem izmanto izsekošanas domēnu.
get uzskaita arī adreses uz domēna. addresses.list() ir radniecīgs izsaukums: katra adrese, ko ŠĪ ATSLĒGA drīkst likt From galvenē, un tas ir šaurāks saraksts.
Parametri: domains.get
domainIdstringobligāts- Id no `domains.list` — UUID, kas izveidots, domēnu pievienojot, nevis resursdatora nosaukums, tāpēc `get('example.com')` neko neatradīs. Meklēšana ir ierobežota gan ar atslēgas paša savienojumu, gan ar id, tāpēc citas darbvietas domēns ir 404, nevis 403.
Parametri: domains.update
idstringobligāts- Tas pats domēna id, ko pieņem `get`. Nepieciešamais tvērums ir `domains:write`.
patch.trackingHoststring | nullobligāts- Domēna apakšdomēns, ne vairāk kā 512 rakstzīmes, piemēram, `links.acme.com`. Tas tiek apgriezts un pārveidots mazajiem burtiem, un vadošais `https://` vai `http://`, ceļš un beigu punkts tiek noņemti. Jauna vērtība tajā pašā izsaukumā tiek validēta, saglabāta un pārbaudīta. Vērtība, kas domēnam jau ir, palaiž pārbaudi vēlreiz, ja vien iepriekšējā nebija pirms mazāk nekā 30 sekundēm. `null` vai tukša virkne izsekošanas domēnu noņem.
Atteikts resursdators izmet OpenEmailApiError, kas laukā param nosauc trackingHost: 422 invalid_tracking_host nosaukumam, ko nevar lietot, piemēram, tādam, kas ir ārpus domēna, 409 domain_not_verified jaunam resursdatoram, kamēr receiving.verified ir false un domēna _openemail-challenge TXT ieraksts vēl nav publicēts, un 409 tracking_host_in_use nosaukumam, ko jau lieto cits domēns, vai kad izsekošanas domēnu pārvalda cits OpenEmail serveris. Atslēga, kas ierobežota ar konkrētām adresēm, saņem 422 capability_unsupported, jo izsekošanas domēns attiecas uz katru adresi uz domēna.
Atbilde: DomainDetailResource
object'domain'- Vienmēr virkne `domain`, gan `list` rindās, gan šajā.
idstring- Domēna UUID. Stabils visu rindas mūžu un vienīgais identifikators, ko pieņem pārējie domēnu izsaukumi.
domainstring- Kails resursdatora nosaukums mazajiem burtiem: `example.com`. Unikāls visā produktā, viens īpašnieks vienam domēnam, tāpēc divas darbvietas nevar to abas pieprasīt.
receiving.verifiedboolean- True, tiklīdz DNS parādīja, ka domēna MX nosauc resursdatoru, kas atved tā pastu šurp, un, ja rinda nes izaicinājuma marķieri, arī atbilstošo `_openemail-challenge` TXT ierakstu. MX pats par sevi neko nepierāda, jo katrs domēns, kuram mēs saņemam pastu, publicē tos pašus resursdatoru nosaukumus, un tieši tāpēc pastāv marķieris un tāpēc šis karodziņš ir vārti, ko ienākošā piegāde pārbauda pirms pasta pieņemšanas.
receiving.verifiedAtstring | null- Kad verifikācija tika izturēta, ISO-8601. Null, kamēr tā nav, un `verified` tiek atvasināts tieši no šīs kolonnas, tāpēc abi nekad nevar nesakrist.
receiving.catchAllboolean- Vai tiek pieņemta jebkura lokālā daļa. Ieslēgts pēc noklusējuma domēniem, kas pievienoti kopš šī noteikuma stāšanās spēkā; ar to izslēgtu tiek pieņemtas tikai domēnā nosauktās adreses, bet pārējās tiek noraidītas SMTP līmenī, tāpēc sūtītājs saņem atteikuma vēstuli, nevis klusumu.
receiving.lastCheckedAtstring | null- Kad par šo domēnu pēdējoreiz tika vaicāts DNS. Null nozīmē, ka nekad nav skatīts, un cilvēkam, kurš domēnu pievienoja pirms minūtes, tas nozīmē pavisam ko citu nekā kļūme. Šis galapunkts ziņo saglabāto rezultātu un nekad neveic savu pārbaudi.
receiving.errorstring | null- Kāpēc pēdējā pārbaude netika izturēta, vārdos, uz kuriem īpašnieks var reaģēt: `No MX records yet. DNS changes can take a few minutes to spread.` ir tipisks piemērs. Null, tiklīdz tā ir izturēta, un saglabāts, nevis atvasināts, lai pārlāde un plānotā atkārtotā pārbaude teiktu vienu un to pašu.
sending.status'verified' | 'pending' | 'failed' | 'no_identity' | 'unknown'- Izejošās parakstīšanas stāvoklis, kādu to redzēja pēdējā pārbaude. Nolasīts no saglabātās pārbaudes, nevis zondēts šajā pieprasījumā, tāpēc `sending.checkedAt` pasaka, cik tas ir vecs.
sending.canSendboolean- Vai sūtījums no šī domēna šobrīd tiktu pieņemts. Negatīvs spriedums, kas vecāks par dienu, tiek uzskatīts par nezināmu, nevis par atteikumu, tāpēc šis var būt true, kamēr `status` ir `pending`. Zarojiet pēc šī pirms sūtīšanas: false nozīmē, ka `emails.send` no šī domēna tiek atteikts ar 409 `domain_not_sendable`.
sending.checkedAtstring | null- Kad pēdējoreiz pārbaudīts parakstīšanas stāvoklis, ISO-8601. Null nozīmē nekad, un tas nozīmē pavisam ko citu nekā kļūme.
sending.errorstring | null- Pēdējā parakstīšanas kļūme vārdos vai null, tiklīdz pārbaude ir izturēta.
sending.notestring- Viens no pieciem teikumiem, izvēlēts pēc `sending.status`, kas vārdos, uz kuriem domēna īpašnieks var reaģēt, pasaka, ko šis stāvoklis nozīmē. Teksts cilvēkam lasīšanai. Zarojiet pēc `sending.canSend`, nevis pēc šī.
trackingDomainTracking- Domēna paša izsekošanas domēns, gan `list` rindās, gan šajā, un tas, ko maina `update`.
tracking.hoststring | null- Izsekošanas domēns, piemēram, `links.acme.com`, vai null, kad neviens nav iestatīts.
tracking.status'none' | 'pending' | 'active' | 'failed'- `none` nozīmē, ka izsekošanas domēns nav iestatīts, `pending` — ka tas nekad nav izturējis pārbaudi, `active` — ka jaunais pasts to izmanto, un `failed` — ka tas agrāk bija izturējis, bet kopš tā laika ir izkritis no lietošanas. Aktīvs resursdators izkrīt pēc trim neizdevušām pārbaudēm pēc kārtas vai kad tā pēdējā izturētā pārbaude ir vecāka par 2 stundām.
tracking.activeboolean- True tieši tad, kad `status` ir `active`, proti, kad izsekotās saites un atvēršanas pikselis jaunajā pastā no domēna izmanto šo resursdatoru.
tracking.targetstring- Adrese, uz kuru norāda CNAME ieraksts, sagatavota tieši šim izsekošanas domēnam. Tukša virkne, kamēr `host` ir null un kamēr jaunā resursdatora adrese vēl tiek sagatavota.
tracking.record{ type: 'CNAME'; name: string; value: string } | null- Publicējamais ieraksts, nosaukts pēc `host` ar `target` kā vērtību. Null, kad izsekošanas domēna nav, un kamēr jaunā resursdatora adrese vēl tiek sagatavota.
tracking.checkedAtstring | null- Kad resursdators pēdējoreiz pārbaudīts, ISO-8601. Null līdz pirmajai pārbaudei.
tracking.verifiedAtstring | null- Kad pārbaude pēdējoreiz tika izturēta, ISO-8601. Null resursdatoram, kas nekad nav izturējis nevienu.
tracking.errorstring | null- Ko atklāja pēdējā pārbaude, vārdos, uz kuriem domēna īpašnieks var reaģēt. Null, kad pēdējā pārbaude izturēta vai neviena vēl nav notikusi. Resursdators, kas nav izturējis vienu vai divas pārbaudes, joprojām ir `active` un nes iemeslu šeit.
addressesArray<{ address: string; enabled: boolean }>- Katra adreses rinda uz domēna, un tieši to `get` pievieno `list` rindai. Tajā ir arī rindas, ko piegāde ierakstīja pati zem catch-all, un tās pārstāj tikt pieņemtas brīdī, kad catch-all tiek izslēgts, tāpēc masīvs nav saraksts ar to, kas saņems.
addresses[].addressstring- Pilna adrese, atjaunota no saglabātās lokālās daļas un resursdatora nosaukuma un pārveidota mazajiem burtiem, tāpēc tā vienmēr atbilst augstāk esošajam `domain`, nevis no tā attālinās.
addresses[].enabledboolean- False adresi atspējo, un atspējota adrese tiek noraidīta arī tad, kad catch-all ir ieslēgts. Katra rinda tiek uzskaitīta jebkurā gadījumā, tāpēc filtrējiet pēc šī, nevis lasiet masīvu kā strādājošo adrešu kopu.
createdAtstring- Kad domēna rinda tika pievienota, ISO-8601. Nevis kad tas verificējās: tas ir `receiving.verifiedAt`, kas var būt null, kamēr šis ir iestatīts.