문서로 건너뛰기
Ruby

Ruby gem

OpenEmail API의 공식 Ruby 클라이언트입니다. 런타임 의존성이 없으며, 모든 엔드포인트에 대응하는 메서드가 하나씩 있습니다.

설명

하나의 gem이 API 전체(발송, 템플릿, 추적, 스레드, 임시 보관함, 라벨, 연락처, 오디언스, 가입 양식, 브로드캐스트, 도메인, 규칙, 웹훅, 캘린더, 설정, 역할, 멤버, 차단, 파일, 일회용 받은편지함)를 다루며, TypeScript SDK의 모든 메서드에 대응하는 메서드를 같은 이름의 snake_case로 제공하고, 거부의 종류마다 오류 클래스가 있으며, 발송을 중복시킬 수 없는 재시도와 웹훅 서명 검증기를 갖추었습니다. Ruby 3.2 이상만 있으면 되고, 클라이언트 하나를 스레드 간에 안전하게 공유할 수 있으며 fork 후에도 그대로 동작합니다.

bundle add openemail
send_email.rb
require "openemail" OpenEmail.init(api_key: ENV.fetch("OPENEMAIL_API_KEY")) OpenEmail.emails.send(  from: "Acme Billing <[email protected]>",  to: "[email protected]",  subject: "Your September invoice",  html: "<p>Invoice attached.</p>")

이동할 곳

다른 모든 클라이언트와 같은 API를 감쌉니다

여기 있는 모든 것은 API 레퍼런스가 문서화하고 TypeScript SDK가 감싸는 것과 같은 표면이므로, 엔드포인트가 무엇을 하는지는 API 레퍼런스에서, Ruby에서 어떻게 호출하는지는 이 문서에서 읽으세요. 모든 TypeScript 메서드에는 대응하는 Ruby 메서드가 있으며, gem의 패리티 검사는 둘을 같은 인자로 실행해 바이트 단위로 같은 요청을 보내지 않으면 실패합니다.