Değişiklik günlüğü

İlk sürüm. Bu sürüm çıkarıldığı andaki hâliyle TypeScript SDK'sının tamamını kapsar: 41 ad alanında 430 metot; her biri kendi TypeScript adını taşır ve her biri TypeScript ikizinin gönderdiği isteğin bayt bayt aynısını gönderir.

• —OpenEmail\OpenEmail, emails, threads ve templates ile başlayıp providerImports, dnsConnections ve account ile biten her ad alanı için bir özelliğe sahiptir ve her birindeki metotlar TypeScript adlarını korur.
• —Bir istek gövdesi, anahtarları API'nin camelCase adlarını koruyan ilişkisel bir dizidir; seçenekler ise idempotencyKey: ve apiKey: gibi adlandırılmış argümanlardır. Yanıt, çözülmüş ilişkisel dizi olarak döner.
• —Sayfalanan her kaynağın bir Page döndüren list, tüm öğeleri bir dizi olarak döndüren listAll ve bir sonraki sayfayı ancak oraya geldiğinde getiren bir Generator döndüren iterate metotları vardır. PeoplePage, TempMessagesPage, AddressBookPage, AddressBook, BatchResult ve TemplateSends, bir listeden fazlasını içeren yanıtları taşır.
• —Bir API reddi, status, type, errorCode, param, docUrl, requestId, retryAfterSeconds, fields ve body alanları ile isValidation() ve isStepUpRequired() gibi metotlara sahip ApiException ya da hata türüne karşılık gelen alt sınıfını fırlatır. Hiç yanıt gelmemesi, süre dolduğunda isTimeout() ile birlikte NetworkException fırlatır. Çağrının kendisindeki bir hata, hiçbir şey gönderilmeden önce InvalidArgumentException fırlatır. Hepsi OpenEmailException arayüzünü uygular.
• —new OpenEmail() ve OpenEmail::createClient(), belirtmediğiniz her şey için OPENEMAIL_API_KEY, OPENEMAIL_ACCESS_TOKEN ve OPENEMAIL_BASE_URL değerlerini okur; OpenEmail::init(), OpenEmail::getClient() ve OpenEmail::resetClient() ise tek bir paylaşılan istemciyi yönetir. OpenEmail::createTempMail() kimlik bilgisi olmadan tek kullanımlık gelen kutuları açar.
• —accessToken: bir OAuth erişim tokenı ya da bir token döndüren ve her istekten önce çağrılan çağrılabilir bir nesne alır. Her metot, tek bir çağrı için başka bir anahtarla işlem yapmak üzere apiKey: alır; tempMail metotları ise inboxToken: alır. Kimlik bilgisi taşıyan her parametre #[\SensitiveParameter] ile işaretlidir.
• —OpenEmail::verifyWebhookSignature() bir teslimatı sabit zamanda denetler, beş dakikadan eski bir teslimatı reddeder ve çözülmüş olayı döndürür. İmzayı, adları herhangi bir büyük/küçük harf biçiminde olan bir başlık dizisinden, $_SERVER içinden, bir Symfony ya da Laravel başlık çantasından (header bag) veya bir PSR-7 isteğinden okur.
• —OpenEmail::toBase64(), isApiKey(), isAccessToken(), isSealed(), resolveLanguage(), languageByCode() ve isRtlLanguage(), TypeScript SDK'sının yardımcılarıdır; paket kökünün dışa aktardığı her değer kümesi de OpenEmail\Constants içinde bir sınıftır.
• —curl ve json eklentileriyle PHP 8.2 ya da üzerini gerektirir, başka hiçbir şeyi değil. İstekler istemci başına tek bir cURL tanıtıcısından geçer; bu tanıtıcı istekler arasında bağlantısını açık tutar ve pcntl_fork sonrasında yeni bir bağlantı açar; timeout: ise bir denemenin tamamını sınırlar. Psr18HttpClient ise onları bunun yerine Guzzle, Symfony HttpClient ya da başka herhangi bir PSR-18 istemcisi üzerinden gönderir.
• —Okumalar, gönderimler ve tekrarlanması güvenli her yazma işlemi 408, 500, 502, 503 ve 504 durumlarında artan beklemeyle, 429 durumunda ise yalnızca Retry-After bir dakika ya da daha azsa yeniden denenir. Her gönderim, yeniden denemelerinin yeniden kullandığı bir idempotency anahtarı taşır.
• —İstemci, düz http: üzerinden bu makine dışındaki herhangi bir yere kimlik bilgisi göndermeyi reddeder, 0.0.0.0 üzerindeki bir temel URL'yi reddeder, bir isteği bölecek bir başlığı reddeder ve raw->request() çağrısının temel URL'nin kaynağından dışarı çıkmasına asla izin vermez.