SDK

Domenet

`domains.list`, `get` dhe `update`.

Të gjitha metodat

usage.ts

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 })

Marrja dhe dërgimi janë dy fakte të pavarura dhe kthehen si dy objekte. receiving.verified do të thotë se MX-i i domenit e sjell mail-in e tij këtu dhe se sfida e pronësisë është publikuar. sending raporton kontrollin e nënshkrimit dalës: status është verified, pending, failed, no_identity ose unknown, kurse canSend thotë nëse një dërgim nga domeni do të pranohej tani. Një verdikt negativ më i vjetër se një ditë trajtohet si i panjohur dhe jo si refuzim, prandaj degëzoni mbi canSend dhe jo mbi status.

update cakton, rikontrollon ose heq domenin e personalizuar të gjurmimit të domenit, një nëndomen si links.acme.com, dhe jep të njëjtin DomainDetailResource si get. tracking e raporton atë në çdo lexim. Derisa një kontroll të kalojë, tracking.status është pending dhe lidhjet e gjurmuara e pikseli i hapjes vazhdojnë të përdorin host-in e parazgjedhur të OpenEmail. Sapo një kontroll kalon, ai bëhet active dhe mail-i i ri nga domeni e përdor domenin e gjurmimit për të dyja.

get i liston edhe adresat e domenit. addresses.list() është thirrja e afërt: çdo adresë që KY ÇELËS mund të vendosë në një header From, që është më e ngushtë.

Parametrat: domains.get

domainIdstringe detyrueshme: Id-ja nga `domains.list`, një UUID i krijuar kur u shtua domeni, jo hostname-i, pra `get('example.com')` nuk gjen asgjë. Kërkimi kufizohet te lidhja e vetë çelësit po aq sa te id-ja, kështu që domeni i një hapësire tjetër pune është një 404 dhe jo një 403.

Parametrat: domains.update

idstringe detyrueshme: E njëjta id domeni që merr `get`. `domains:write` është scope-i që i duhet.
patch.trackingHoststring | nulle detyrueshme: Një nëndomen i domenit, me më së shumti 512 karaktere, si `links.acme.com`. Pastrohet nga hapësirat dhe kthehet në shkronja të vogla, kurse një `https://` ose `http://` në fillim, një shteg dhe një pikë në fund hiqen. Një vlerë e re validohet, ruhet dhe kontrollohet në të njëjtën thirrje. Vlera që domeni e ka tashmë e rikryen kontrollin, veç nëse i fundit ishte më pak se 30 sekonda më parë. `null` ose një string bosh e heq domenin e gjurmimit.

Një host i refuzuar hedh një OpenEmailApiError që emërton trackingHost te param: 422 invalid_tracking_host për një emër që nuk mund të përdoret, si një jashtë domenit, 409 domain_not_verified për një host të ri ndërsa receiving.verified është false dhe regjistri TXT _openemail-challenge i domenit nuk është publikuar ende, dhe 409 tracking_host_in_use për një emër që e përdor tashmë një domen tjetër, ose kur domeni i gjurmimit menaxhohet nga një server tjetër OpenEmail. Një çelës i kufizuar te adresa të caktuara merr 422 capability_unsupported, sepse një domen gjurmimi zbatohet për çdo adresë të domenit.

Përgjigjja: DomainDetailResource

object'domain': Gjithmonë stringu `domain`, si te rreshtat e `list` ashtu edhe te ky.
idstring: UUID-ja e domenit. E qëndrueshme për gjithë jetën e rreshtit dhe i vetmi identifikues që pranojnë thirrjet e tjera për domenet.
domainstring: Hostname-i i thjeshtë, me shkronja të vogla: `example.com`. Unik në gjithë produktin, një pronar për domen, pra dy hapësira pune nuk mund ta pretendojnë të dyja.
receiving.verifiedboolean: True sapo DNS-ja tregoi se MX-i i domenit emërton një host që e sjell mail-in e tij këtu dhe, aty ku rreshti mban një token sfide, edhe regjistrin përkatës TXT `_openemail-challenge`. MX-i vetëm nuk provon asgjë, meqë çdo domen për të cilin marrim mail publikon të njëjtët hostname, prandaj ekziston token-i, dhe prandaj ky flamur është porta që kontrollon dërgesa hyrëse para se të pranojë mail.
receiving.verifiedAtstring | null: Kur kaloi verifikimi, ISO-8601. Null ndërsa nuk ka kaluar, dhe `verified` rrjedh pikërisht nga kjo kolonë, pra të dyja nuk mund të kundërshtojnë kurrë njëra-tjetrën.
receiving.catchAllboolean: Nëse pranohet çdo local-part. I ndezur si parazgjedhje për domenet e shtuara qëkur kjo u bë rregull; me të fikur pranohen vetëm adresat e emërtuara në domen dhe pjesa tjetër refuzohet në kohën e SMTP-së, pra dërguesi merr një bounce dhe jo heshtje.
receiving.lastCheckedAtstring | null: Kur u pyet DNS-ja për këtë domen për herë të fundit. Null do të thotë asnjëherë e pyetur, gjë që për dikë që sapo shtoi një domen lexohet krejt ndryshe nga një kontroll i dështuar. Ky endpoint raporton rezultatin e ruajtur dhe nuk kryen kurrë një kontroll të vetin.
receiving.errorstring | null: Pse nuk kaloi kontrolli i fundit, me fjalë mbi të cilat pronari mund të veprojë: `No MX records yet. DNS changes can take a few minutes to spread.` është një prej tipikeve. Null sapo kalon, dhe e ruajtur në vend që të rrjedhë, kështu që një rifreskim dhe rikontrolli i planifikuar thonë të njëjtën gjë.
sending.status'verified' | 'pending' | 'failed' | 'no_identity' | 'unknown': Gjendja e nënshkrimit dalës siç e pa kontrolli i fundit. Lexohet nga kontrolli i ruajtur dhe nuk sondohet gjatë kësaj kërkese, pra `sending.checkedAt` thotë sa i vjetër është.
sending.canSendboolean: Nëse një dërgim nga ky domen do të pranohej tani. Një verdikt negativ më i vjetër se një ditë trajtohet si i panjohur dhe jo si refuzim, prandaj kjo mund të jetë true ndërsa `status` është `pending`. Degëzoni mbi këtë para një dërgimi: një false do të thotë se `emails.send` nga ky domen refuzohet me një 409 `domain_not_sendable`.
sending.checkedAtstring | null: Kur u kontrollua për herë të fundit gjendja e nënshkrimit, ISO-8601. Null do të thotë asnjëherë, gjë që lexohet krejt ndryshe nga një dështim.
sending.errorstring | null: Dështimi i fundit i nënshkrimit me fjalë, ose null sapo kalon.
sending.notestring: Një nga pesë fjalitë, e zgjedhur nga `sending.status`, që thotë se çfarë do të thotë ajo gjendje me fjalë mbi të cilat pronari i domenit mund të veprojë. Tekst që ta lexojë një njeri. Degëzoni mbi `sending.canSend` dhe jo mbi këtë.
trackingDomainTracking: Domeni i personalizuar i gjurmimit i domenit, si te rreshtat e `list` ashtu edhe te ky, dhe ajo që ndryshon `update`.
tracking.hoststring | null: Domeni i gjurmimit, si `links.acme.com`, ose null kur nuk është caktuar asnjë.
tracking.status'none' | 'pending' | 'active' | 'failed': `none` do të thotë se nuk është caktuar asnjë domen gjurmimi, `pending` se nuk ka kaluar kurrë një kontroll, `active` se mail-i i ri e përdor, dhe `failed` se kishte kaluar më parë dhe që atëherë ka dalë nga përdorimi. Një host aktiv del nga përdorimi pas tre kontrollesh të dështuara me radhë, ose kur kontrolli i tij i fundit i kaluar është më i vjetër se 2 orë.
tracking.activeboolean: True pikërisht kur `status` është `active`, që është çasti kur lidhjet e gjurmuara dhe pikseli i hapjes te mail-i i ri nga domeni e përdorin host-in.
tracking.targetstring: Adresa te e cila tregon regjistri CNAME, e përgatitur vetëm për këtë domen gjurmimi. Një string bosh ndërsa `host` është null, dhe ndërsa adresa për një host të ri është ende duke u përgatitur.
tracking.record{ type: 'CNAME'; name: string; value: string } | null: Regjistri që duhet publikuar, i emërtuar sipas `host` me `target` si vlerë të tij. Null kur nuk ka domen gjurmimi, dhe ndërsa adresa për një host të ri është ende duke u përgatitur.
tracking.checkedAtstring | null: Kur u kontrollua host-i për herë të fundit, ISO-8601. Null deri te kontrolli i parë.
tracking.verifiedAtstring | null: Kur kaloi një kontroll për herë të fundit, ISO-8601. Null për një host që nuk ka kaluar kurrë ndonjë.
tracking.errorstring | null: Çfarë gjeti kontrolli i fundit, me fjalë mbi të cilat pronari i domenit mund të veprojë. Null kur kontrolli i fundit kaloi ose kur nuk është kryer asnjë. Një host që ka dështuar një ose dy kontrolle është ende `active` dhe e mban arsyen këtu.
addressesArray<{ address: string; enabled: boolean }>: Çdo rresht adrese në domen, që është ajo që `get` shton mbi një rresht të `list`. Përfshin edhe rreshtat që i shkroi vetë dërgesa nën catch-all, dhe ata pushojnë së pranuari në çastin që catch-all fiket, pra array-i nuk është një listë e asaj që do të marrë mail.
addresses[].addressstring: Adresa e plotë, e rindërtuar nga local-part-i i ruajtur dhe hostname-i dhe e kthyer në shkronja të vogla, kështu që përputhet gjithmonë me `domain` më sipër në vend që të largohet prej tij.
addresses[].enabledboolean: False e çaktivizon adresën, dhe një e çaktivizuar refuzohet edhe kur catch-all është i ndezur. Çdo rresht listohet sido që të jetë, prandaj filtroni mbi këtë në vend që ta lexoni array-in si bashkësinë e adresave që punojnë.
createdAtstring: Kur u shtua rreshti i domenit, ISO-8601. Jo kur u verifikua: ajo është `receiving.verifiedAt`, e cila mund të jetë null ndërsa kjo është e caktuar.