Java
Ndihmësit dhe konstantet
Çfarë tjetër përcakton paketa përveç metodave të klientit.
Metodat statike
| Metoda | Çfarë është |
|---|---|
| new OpenEmail(), OpenEmail.builder() | Një klient. Të dyja e lexojnë mjedisin për çdo gjë që e lini jashtë. |
| OpenEmail.createTempMail() | Një klient për kutitë e përkohshme që nuk mbart çelës API. |
| OpenEmail.verifyWebhookSignature() | Kontrollon nënshkrimin e një dorëzimi në kohë konstante, me një dritare pesëminutëshe që e ndryshon një Duration, dhe e kthen ngjarjen. |
| OpenEmail.toBase64() | Tekst base64 për bajtët e një bashkëngjitjeje. |
| OpenEmail.isApiKey() | Nëse një vlerë ka formën oe_live_ ose oe_test_. Një kontroll i formës, jo provë se çelësi funksionon ende. |
| OpenEmail.isAccessToken() | Nëse një vlerë ka formën e një token-i aksesi OAuth: 1 deri në 512 karaktere, pa nisur me oe_. |
| OpenEmail.isSealed() | Nëse trupi i një mesazhi është tekst i shifruar. Është false për dy formatet e nënshkruara, trupat e të cilave mbërritën të hapur. |
| OpenEmail.resolveLanguage(), OpenEmail.languageByCode(), OpenEmail.isRtlLanguage() | Kërkimet që i duhen një përzgjedhësi gjuhe, mbi tabelën e përfshirë Languages.ALL. |
| client.raw().request() | Thërret një shteg që ende nuk e mbështjell asnjë metodë, me kredencialin dhe rregullat e riprovimit të klientit. |
Konstantet
Çdo bashkësi vlerash që eksporton SDK-ja TypeScript është një klasë finale në uk.openemail.constants, me një konstante për çdo anëtar nën të njëjtët emra, kështu që WebhookEvents.EMAIL_DELIVERED është email.delivered. values() kthen gjithë bashkësinë, dhe kjo është edhe mënyra për të kontrolluar një vlerë që erdhi nga jashtë.
List<String> events = WebhookEvents.values();List<String> scopes = List.of(ApiScopes.EMAILS_SEND, ApiScopes.THREADS_READ);boolean known = events.contains("email.delivered"); System.out.println(events.size() + " " + String.join(",", scopes) + " " + PageLimits.MAX_LIMIT + " " + known);| Konstantja | Çfarë mban |
|---|---|
| OpenEmail.VERSION | Versioni i paketës. |
| ApiScopes | Fjalori i scope-ve, për një ekran krijimi çelësash. |
| WebhookEvents, WebhookSignatureHeaders | Ngjarjet te të cilat mund të abonohet një endpoint dhe emrat e header-ave që mbart një dërgesë. |
| ErrorTypes | Fjalori i gabimeve që kthen ApiException.type(). |
| PageLimits | limit më i madh dhe ai i parazgjedhur në shumicën e listave me faqe, MAX_LIMIT dhe DEFAULT_LIMIT: 100 dhe 25. Disa lista pranojnë më shumë, dhe referenca e çdo metode e thotë këtë. |
| RuleFields, RuleOperators, RuleActions | Fjalori nga i cili ndërtohen kushtet dhe veprimet e një rregulli. |
| MessageEncryptionFormats | Pesë zarfet që mund të emërtojë përpunimi i postës hyrëse. Tre prej tyre janë të vulosur. |
| CredentialKinds, StepUpMethods, StepUpErrorCodes | Cilin kredencial përshkruajnë me().get dhe me().ping, si kontrollohet një kod verifikimi dhe kodet me të cilat mund të dështojë një verifikim. |
| ThreadSorts, PeopleSorts, FileSorts dhe *Sorts të tjera | Renditjet sipas të cilave mund të renditet një listë. |
| FormStatuses, BroadcastStatuses, SuppressionReasons dhe bashkësitë e tjera | Vlerat që mund të marrë një fushë e një burimi. Çdo bashkësi emërtohet sipas asaj që mban. |
| Languages.ALL | Çdo gjuhë që pranon një dërgim ose një parapamje e përkthyer, me kodin, emrat dhe drejtimin e saj. |
Objektet
Një përgjigje është JSON-i i dekoduar si Map<String, Object>. Paketa ndërton një tip të vetin vetëm aty ku i jep formë përgjigjes. Secili është një record i pandryshueshëm në uk.openemail.result, dhe një cikël for i përshkon rreshtat e tij.
| Klasa | Çfarë mbart |
|---|---|
| Page | items, hasMore dhe nextCursor, nga çdo list i faqosur. |
| PeoplePage | E njëjta gjë plus seen, nga contacts().listPeople. |
| TempMessagesPage | E njëjta gjë plus expiresAt, nga tempMail().listMessages. |
| AddressBookPage, AddressBook | unrestricted, addresses dhe domains, nga addresses().list (me hasMore dhe nextCursor) dhe addresses().listAll. |
| BatchResult | items, sent dhe failed, nga emails().sendBatch. |
| TemplateSends | items, total, page dhe pageSize, nga templates().listSends. |
| PagedIterable | Një përshkim i çdo faqeje, nga çdo iterate: një cikël for, stream() ose toList(). |
| Body, RequestOptions | Çfarë merr një thirrje: një trup kërkese që e ruan radhën e vet dhe pranon vlera null, dhe opsionet e një thirrjeje. |
Çdo përjashtim që hedh paketa është një OpenEmailException: ApiException dhe nënklasat e saj, NetworkException dhe WebhookSignatureException. Një gabim në vetë thirrjen hedh IllegalArgumentException para se të dërgohet diçka.
Çfarë nuk bën me qëllim
- Nuk validon asnjë trup kërkese. Skema e serverit është kopja e vetme e rregullave, dhe një kopje e dytë këtu do të refuzonte herët a vonë një adresë që një server më i ri e pranon, në një version që dikush e fiksoi dy vjet më parë.
- E riformëson një përgjigje vetëm në një mënyrë: lista
datae një koleksioni nxirret nga mbështjellësi i saj në një nga tipat më sipër. Çdo përgjigje tjetër kthehet ashtu siç e dërgoi API-ja, me çelësat camelCase të API-së. - Nuk ka metoda asinkrone. Një thirrje e bllokon thread-in e vet derisa të vijë përgjigjja, gjë që kushton pak në një thread virtual.