이메일 API

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

현재 HTTP 기본 URI 경로는 https://api.forwardemail.net입니다.

모든 엔드포인트에서는 API 키을 요청의 기본 권한 부여 헤더의 "사용자 이름" 값으로 설정해야 합니다(별칭 연락처, 별칭 달력 및 별칭 사서함는 예외이며, 이들은 생성된 별칭 사용자 이름 및 비밀번호를 사용합니다).

걱정하지 마세요. 이것이 무엇인지 확실하지 않다면 아래에 예를 제공했습니다.

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

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

페이지 매김은 결과를 나열하는 모든 API 엔드포인트에서 지원됩니다.

간단히 쿼리 문자열 속성 page(및 선택적으로 limit)을 제공하세요.

page 속성은 1보다 크거나 같은 숫자여야 합니다. limit(숫자)를 제공하는 경우, 최소값은 10이고 최대값은 50입니다(별도로 명시되지 않는 한).

추가 결과가 있는지 확인하기 위해 다음과 같은 HTTP 응답 헤더를 제공합니다(프로그래밍 방식으로 페이지를 나누기 위해 구문 분석 가능):

요청 예시:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

로그 검색

저희 API를 통해 프로그래밍 방식으로 계정 로그를 다운로드할 수 있습니다. 이 엔드포인트에 요청을 제출하면 계정의 모든 로그가 처리되어 완료되면 첨부 파일(지압 압축 CSV 스프레드시트 파일)로 이메일로 전송됩니다.

이를 통해 크론 작업을 사용하여 백그라운드 작업을 생성하거나 Node.js 작업 스케줄링 소프트웨어 Bree을 사용하여 원할 때마다 로그를 수신할 수 있습니다. 이 엔드포인트는 하루에 10개의 요청으로 제한됩니다.

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

GET /v1/logs/download

요청 예시:

curl https://api.forwardemail.net/v1/logs/download \
  -u API_TOKEN:

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

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

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

Cron 작업 예시(매일 자정에 그리고 전날의 로그와 함께):

MacOS의 경우:

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

Linux 및 Ubuntu의 경우:

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

계정 생성

POST /v1/account

요청 예시:

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

계정 검색

GET /v1/account

요청 예시:

curl https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

계정 업데이트

PUT /v1/account

요청 예시:

curl -X PUT https://api.forwardemail.net/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

곧 출시

캘린더 업데이트 {#update-calendar}}

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

곧 출시

폴더 {#retrieve-folder}}을 검색합니다.

GET /v1/folders/:id

곧 출시

폴더 업데이트 {#update-folder}}

PUT /v1/folders/:id

곧 출시

폴더 삭제

DELETE /v1/folders/:id

곧 출시

폴더 복사

POST /v1/folders/:id/copy

곧 출시

귀하의 도메인에 대한 설정 지침을 따랐는지 확인하세요.

이 지침은 내 계정 → 도메인 → 설정 → 아웃바운드 SMTP 구성에서 확인할 수 있습니다. 도메인을 사용하여 아웃바운드 SMTP를 전송하려면 DKIM, 반환 경로 및 DMARC를 설정해야 합니다.

아웃바운드 SMTP 이메일 제한 가져오기

이는 계정별로 매일 발송되는 SMTP 메시지 수를 나타내는 count과 limit을 포함하는 JSON 객체를 반환하는 간단한 엔드포인트입니다.

GET /v1/emails/limit

요청 예시:

curl https://api.forwardemail.net/v1/emails/limit \
  -u API_TOKEN:

아웃바운드 SMTP 이메일 나열

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

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

GET /v1/emails

요청 예시:

curl https://api.forwardemail.net/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를 만드는 것이었습니다.

POST /v1/emails

요청 예시:

curl -X POST https://api.forwardemail.net/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://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

아웃바운드 SMTP 이메일 검색

GET /v1/emails/:id

요청 예시:

curl https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

아웃바운드 SMTP 이메일 삭제

이메일을 삭제하면 현재 상태가 "pending", "queued" 또는 "deferred" 중 하나인 경우에만 상태가 "rejected"으로 설정되고 이후 대기열에서 처리되지 않습니다. 이메일은 생성 및/또는 발송 후 30일이 지나면 자동으로 삭제될 수 있으므로 클라이언트, 데이터베이스 또는 애플리케이션에 아웃바운드 SMTP 이메일 사본을 보관해야 합니다. 필요한 경우 데이터베이스에서 이메일 ID 값을 참조할 수 있습니다. 이 값은 이메일 만들기 및 이메일 검색 엔드포인트 모두에서 반환됩니다.

DELETE /v1/emails/:id

요청 예시:

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

도메인 목록

GET /v1/domains

요청 예시:

curl https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

도메인 {#create-domain}}을 만듭니다.

POST /v1/domains

요청 예시:

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

도메인 {#retrieve-domain}}을 검색합니다.

GET /v1/domains/example.com

요청 예시:

curl https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

도메인 레코드 확인

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

요청 예시:

curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

도메인 SMTP 레코드 확인

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

요청 예시:

curl https://api.forwardemail.net/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

도메인 전체의 포괄적인 비밀번호 나열

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

요청 예시:

curl https://api.forwardemail.net/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://api.forwardemail.net/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

도메인 업데이트

PUT /v1/domains/example.com

요청 예시:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

도메인 삭제

DELETE /v1/domains/:domain_name

요청 예시:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

##이 {#invites}}을 초대합니다.

도메인 초대 수락

GET /v1/domains/:domain_name/invites

요청 예시:

curl https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

도메인 초대 만들기

POST /v1/domains/example.com/invites

요청 예시:

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

도메인 초대 삭제

DELETE /v1/domains/:domain_name/invites

요청 예시:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

도메인 멤버 업데이트

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

요청 예시:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

도메인 구성원 {#remove-domain-member}}을 제거합니다.

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

요청 예시:

curl -X DELETE https://api.forwardemail.net/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

요청 예시:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

도메인 별칭 목록

GET /v1/domains/example.com/aliases

요청 예시:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

새 도메인 별칭 만들기

POST /v1/domains/example.com/aliases

요청 예시:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

도메인 별칭 검색

id 또는 name 값을 통해 도메인 별칭을 검색할 수 있습니다.

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

요청 예시:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

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

요청 예시:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

도메인 별칭 업데이트

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

요청 예시:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

도메인 별칭 삭제

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

요청 예시:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

무료 플랜에서도 기록 암호화를 무료로 제공합니다. 개인정보 보호는 단순한 기능이 아니라 제품의 모든 측면에 기본적으로 내장되어야 합니다. 개인정보 보호 가이드 토론 및 우리의 GitHub 이슈에서 많은 요청이 있었으므로 이 기능을 추가했습니다.

TXT 레코드 암호화

POST /v1/encrypt

요청 예시:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"