이메일 API

현재 API 래퍼를 아직 출시하지 않았지만, 가까운 시일 내에 출시할 계획입니다. 특정 프로그래밍 언어의 API 래퍼가 출시되면 알림을 받고 싶으시면 api@forwardemail.net으로 이메일을 보내주세요. 그동안에는 애플리케이션에서 아래 권장 HTTP 요청 라이브러리를 사용하거나, 아래 예제처럼 curl을 사용하실 수 있습니다.

현재 HTTP 기본 URI 경로는: https://fe.tiamati.email입니다.

모든 엔드포인트는 기본 인증(Basic Authorization)을 사용한 인증이 필요합니다. 두 가지 인증 방법을 지원합니다:

API 토큰 인증 (대부분의 엔드포인트에 권장)

API 키를 "username" 값으로 설정하고 비밀번호는 비워둡니다:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

API 토큰 뒤의 콜론(:)에 주의하세요 – 이는 기본 인증 형식에서 비밀번호가 비어 있음을 나타냅니다.

별칭 자격 증명 인증 (발신 이메일용)

발신 SMTP 이메일 생성 엔드포인트는 별칭 이메일 주소와 생성된 별칭 비밀번호를 사용한 인증도 지원합니다:

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@yourdomain.com:your_generated_password" \
  -d "to=recipient@example.com" \
  -d "subject=Hello" \
  -d "text=Test email"

이 방법은 이미 SMTP 자격 증명을 사용하는 애플리케이션에서 이메일을 보낼 때 유용하며 SMTP에서 API로의 마이그레이션을 원활하게 합니다.

별칭 전용 엔드포인트

별칭 연락처, 별칭 캘린더, 별칭 메시지, 그리고 별칭 폴더 엔드포인트는 별칭 자격 증명이 필요하며 API 토큰 인증을 지원하지 않습니다.

걱정하지 마세요 – 아래에 예제가 제공되어 있으니 잘 모르실 경우 참고하세요.

오류가 발생하면 API 요청의 응답 본문에 자세한 오류 메시지가 포함됩니다.

저희 서비스는 25개 이상의 언어로 번역되어 있습니다. 모든 API 응답 메시지는 API 요청을 하는 사용자의 마지막 감지된 로케일로 번역됩니다. Accept-Language 헤더를 전달하여 이를 재정의할 수 있습니다. 이 페이지 하단의 언어 드롭다운을 사용해 자유롭게 시도해 보세요.

페이지네이션은 결과 목록을 반환하는 모든 API 엔드포인트에서 지원됩니다.

단순히 쿼리스트링 속성 page (선택적으로 limit)를 제공하세요.

page 속성은 1 이상인 숫자여야 합니다. limit을 제공하는 경우(역시 숫자) 최소값은 10, 최대값은 50입니다(별도 명시가 없는 한).

예시 요청:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

로그 가져오기

저희 API는 계정의 로그를 프로그래밍 방식으로 다운로드할 수 있도록 합니다. 이 엔드포인트에 요청을 제출하면 계정의 모든 로그를 처리하여 완료 시 첨부파일(Gzip 압축된 CSV 스프레드시트 파일)로 이메일로 보내드립니다.

이를 통해 Cron job이나 저희 Node.js 작업 스케줄링 소프트웨어 Bree를 사용하여 원하는 시점에 로그를 받을 수 있는 백그라운드 작업을 생성할 수 있습니다. 이 엔드포인트는 하루에 10회 요청으로 제한됩니다.

첨부파일 이름은 소문자 형태의 email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz이며, 이메일 본문에는 가져온 로그의 간략한 요약이 포함되어 있습니다. 또한 언제든지 내 계정 → 로그에서 로그를 다운로드할 수 있습니다.

GET /v1/logs/download

예시 요청:

curl https://fe.tiamati.email/v1/logs/download \
  -u API_TOKEN:

예시 Cron 작업 (매일 자정):

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download -u API_TOKEN: &>/dev/null

Cron 작업 표현식 구문을 검증하려면 Crontab.guru와 같은 서비스를 사용할 수 있습니다.

예시 Cron 작업 (매일 자정 및 전날 로그 포함):

MacOS용:

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Linux 및 Ubuntu용:

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

계정 생성

POST /v1/account

예시 요청:

curl -X POST https://fe.tiamati.email/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

계정 조회

GET /v1/account

예시 요청:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

계정 업데이트

PUT /v1/account

예시 요청:

curl -X PUT https://fe.tiamati.email/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

연락처 목록

GET /v1/contacts

곧 출시 예정

연락처 생성

POST /v1/contacts

곧 출시 예정

연락처 조회

GET /v1/contacts/:id

곧 출시 예정

연락처 업데이트

PUT /v1/contacts/:id

곧 출시 예정

연락처 삭제

DELETE /v1/contacts/:id

곧 출시 예정

캘린더 목록

GET /v1/calendars

곧 출시 예정

캘린더 생성

POST /v1/calendars

곧 출시 예정

캘린더 조회

GET /v1/calendars/:id

곧 출시 예정

캘린더 업데이트

PUT /v1/calendars/:id

곧 출시 예정

캘린더 삭제

DELETE /v1/calendars/:id

곧 출시 예정

도메인 설정 지침을 반드시 따르셨는지 확인해 주세요.

이 지침은 FAQ 섹션 IMAP으로 이메일 수신을 지원하나요?에서 확인할 수 있습니다.

메시지 목록 및 검색

GET /v1/messages

곧 출시 예정

메시지 생성

POST /v1/messages

곧 출시 예정

메시지 조회

GET /v1/messages/:id

곧 출시 예정

메시지 업데이트

PUT /v1/messages/:id

곧 출시 예정

메시지 삭제

DELETE /v1/messages:id

곧 출시 예정

폴더 목록

GET /v1/folders

곧 출시 예정

폴더 생성

POST /v1/folders

곧 출시 예정

폴더 조회

GET /v1/folders/:id

곧 출시 예정

폴더 업데이트

PUT /v1/folders/:id

곧 출시 예정

폴더 삭제

DELETE /v1/folders/:id

곧 출시 예정

폴더 복사

POST /v1/folders/:id/copy

곧 출시 예정

도메인 설정 지침을 반드시 따르셨는지 확인해 주세요.

이 지침은 내 계정 → 도메인 → 설정 → 아웃바운드 SMTP 구성에서 확인할 수 있습니다. 도메인으로 아웃바운드 SMTP를 보내려면 DKIM, Return-Path, DMARC 설정이 필요합니다.

발신 SMTP 이메일 한도 조회

이 엔드포인트는 계정별 일일 SMTP 발신 메시지 수에 대한 count와 limit을 포함하는 JSON 객체를 반환하는 간단한 엔드포인트입니다.

GET /v1/emails/limit

요청 예시:

curl https://fe.tiamati.email/v1/emails/limit \
  -u API_TOKEN:

발신 SMTP 이메일 목록

이 엔드포인트는 이메일의 message, headers, 또는 rejectedErrors 속성 값을 반환하지 않습니다.

해당 속성과 값을 반환하려면 이메일 ID와 함께 이메일 조회 엔드포인트를 사용하세요.

GET /v1/emails

요청 예시:

curl https://fe.tiamati.email/v1/emails?limit=1 \
  -u API_TOKEN:

발신 SMTP 이메일 생성

이메일 생성 API는 Nodemailer의 메시지 옵션 구성을 참고하고 활용합니다. 아래 본문 파라미터에 대해서는 Nodemailer 메시지 구성을 참고하세요.

envelope와 dkim을 제외하고(이 두 옵션은 자동 설정됨) 모든 Nodemailer 옵션을 지원합니다. 보안상 disableFileAccess와 disableUrlAccess 옵션은 자동으로 true로 설정됩니다.

헤더를 포함한 전체 원시 이메일을 raw 단일 옵션으로 전달하거나, 아래 개별 본문 파라미터 옵션을 전달해야 합니다.

이 API 엔드포인트는 헤더에 이모지가 포함된 경우 자동으로 인코딩합니다(예: Subject: 🤓 Hello는 자동으로 Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello로 변환). 개발자 친화적이고 실수 방지에 중점을 둔 이메일 API를 목표로 합니다.

인증: 이 엔드포인트는 API 토큰 인증과 별칭 자격 증명 인증을 모두 지원합니다. 자세한 내용은 위의 인증 섹션을 참고하세요.

POST /v1/emails

예제 요청 (API 토큰):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

예제 요청 (별칭 자격 증명):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@example.com:GENERATED_PASSWORD" \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

예제 요청 (원시 이메일):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

발신 SMTP 이메일 조회

GET /v1/emails/:id

예제 요청:

curl https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

발신 SMTP 이메일 삭제

이메일 삭제는 현재 상태가 "pending", "queued", 또는 "deferred" 중 하나일 경우에만 상태를 "rejected"로 설정하며(그 후 큐에서 처리하지 않음) 수행됩니다. 이메일은 생성 및/또는 발송 후 30일이 지나면 자동으로 삭제될 수 있으므로, 클라이언트, 데이터베이스 또는 애플리케이션에 발신 SMTP 이메일 사본을 보관해야 합니다. 원하시면 데이터베이스에서 이메일 ID 값을 참조할 수 있으며, 이 값은 이메일 생성 및 이메일 조회 엔드포인트 모두에서 반환됩니다.

DELETE /v1/emails/:id

예제 요청:

curl -X DELETE https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

도메인 목록

GET /v1/domains

예제 요청:

curl https://fe.tiamati.email/v1/domains \
  -u API_TOKEN:

도메인 생성

POST /v1/domains

예제 요청:

curl -X POST https://fe.tiamati.email/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

도메인 조회

GET /v1/domains/example.com

예제 요청:

curl https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

도메인 레코드 검증

GET /v1/domains/example.com/verify-records

예제 요청:

curl https://fe.tiamati.email/v1/domains/example.com/verify-records \
  -u API_TOKEN:

도메인 SMTP 레코드 검증

GET /v1/domains/example.com/verify-smtp

예제 요청:

curl https://fe.tiamati.email/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

도메인 전체 수신 비밀번호 목록

GET /v1/domains/example.com/catch-all-passwords

예제 요청:

curl https://fe.tiamati.email/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

도메인 전체 수신 비밀번호 생성

POST /v1/domains/example.com/catch-all-passwords

예제 요청:

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

도메인 전체 수신 비밀번호 삭제

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

예제 요청:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

도메인 업데이트

PUT /v1/domains/example.com

Example Request:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

도메인 삭제

DELETE /v1/domains/:domain_name

Example Request:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name \
  -u API_TOKEN:

도메인 초대 수락

GET /v1/domains/:domain_name/invites

Example Request:

curl https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

도메인 초대 생성

POST /v1/domains/example.com/invites

Example Request:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

도메인 초대 제거

DELETE /v1/domains/:domain_name/invites

Example Request:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

도메인 멤버 업데이트

PUT /v1/domains/example.com/members/:member_id

Example Request:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

도메인 멤버 제거

DELETE /v1/domains/:domain_name/members/:member_id

Example Request:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

별칭 비밀번호 생성

이메일로 안내를 보내지 않으면, 성공적인 요청의 JSON 응답 본문에 { username: 'alias@yourdomain.com', password: 'some-generated-password' } 형식으로 사용자 이름과 비밀번호가 포함됩니다.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

Example Request:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

도메인 별칭 목록

GET /v1/domains/example.com/aliases

Example Request:

curl https://fe.tiamati.email/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

새 도메인 별칭 생성

POST /v1/domains/example.com/aliases

Example Request:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases \
  -u API_TOKEN:

도메인 별칭 조회

도메인 별칭은 id 또는 name 값으로 조회할 수 있습니다.

GET /v1/domains/:domain_name/aliases/:alias_id

Example Request:

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

Example Request:

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

도메인 별칭 업데이트

PUT /v1/domains/example.com/aliases/:alias_id

Example Request:

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

도메인 별칭 삭제

DELETE /v1/domains/:domain_name/aliases/:alias_id

Example Request:

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

무료 플랜에서도 비용 없이 레코드를 암호화할 수 있습니다. 개인정보 보호는 기능이 아니라 제품의 모든 측면에 본질적으로 내장되어야 합니다. Privacy Guides 토론과 저희 GitHub 이슈에서 많은 요청을 받아 이를 추가했습니다.

TXT 레코드 암호화

POST /v1/encrypt

Example Request:

curl -X POST https://fe.tiamati.email/v1/encrypt \
  -d "input=user@gmail.com"