C#
헬퍼와 상수
클라이언트의 메서드 외에 패키지가 정의하는 것.
도우미
| 도우미 | 설명 |
|---|---|
| new OpenEmailClient() | 클라이언트입니다. 생략한 것은 모두 환경에서 읽고, 거부하는 구성에 대해서는 ArgumentException을 발생시킵니다. |
| OpenEmailClient.CreateTempMail() | API 키를 가지지 않는, 일회용 받은편지함용 클라이언트입니다. |
| OpenEmailClient.VerifyWebhookSignature() | 전달의 서명을 상수 시간에 확인하고 이벤트를 반환합니다. 5분의 허용 시간은 toleranceSeconds:로 바꿀 수 있습니다. |
| OpenEmailClient.IsApiKey(), OpenEmailClient.IsAccessToken() | 값이 API 키 또는 액세스 토큰의 형식인지 알려 줍니다. |
| OpenEmailClient.IsSealed() | 메시지가 종단 간 암호화되어 API가 본문을 읽을 수 없는지 알려 줍니다. |
| OpenEmailClient.ResolveLanguage(), OpenEmailClient.LanguageByCode(), OpenEmailClient.IsRtlLanguage() | Languages.All에 들어 있는 표에서 코드, 영어 이름 또는 고유 이름으로 언어를 찾습니다. |
| OpenEmailClient.ToBase64(), OpenEmailClient.ToBase64Async() | base64 텍스트를 받는 필드를 위해 byte[] 또는 Stream을 base64로 인코딩합니다. |
| client.Raw.RequestAsync() | 아직 메서드가 없는 경로를 클라이언트의 자격 증명과 재시도 정책으로 호출합니다. |
타입
| 타입 | 설명 |
|---|---|
| Body | 요청 본문입니다. API의 필드 이름을 쓰는 딕셔너리이며, 키를 추가한 순서대로 전송됩니다. |
| JsonObject | System.Text.Json.Nodes의 디코딩된 응답입니다. 필드는 sent["id"]로 읽고 (string?)sent["id"]로 캐스팅합니다. |
| Page | 목록의 한 페이지. Items, HasMore, NextCursor가 있습니다. |
| BatchResult, TemplateSends, PeoplePage, TempMessagesPage, AddressBook, AddressBookPage | 목록보다 더 많은 것을 담는 응답입니다. 예를 들어 일괄 발송의 Sent와 Failed 수가 있습니다. |
| OpenEmailApiException, OpenEmailNetworkException, OpenEmailWebhookException | 클라이언트가 발생시키는 예외입니다. 셋 모두 OpenEmailException에서 파생됩니다. |
상수
OpenEmail.Constants 네임스페이스에는 API가 쓰는 모든 값 집합이 들어 있으며 TypeScript SDK에서 생성됩니다. 웹훅 이벤트, 스코프, 상태 등이 있습니다. 각 집합은 멤버가 상수인 정적 클래스이고, Values가 그 전부를 나열합니다.
using OpenEmail.Constants; var webhook = await client.Webhooks.CreateAsync(new Body{ ["url"] = "https://example.com/webhooks/openemail", ["events"] = new[] { WebhookEvents.EmailReceived, WebhookEvents.EmailBounced },}); Console.WriteLine($"{webhook["id"]} {WebhookEvents.Values.Count}");