クイックスタート

このガイドでは、何もない状態から、ご自身のドメインで実際にメールを送信するまでを説明します。

1. API キーを作成

   ダッシュボードを開き、API キー に移動して API キーを作成 をクリックします。試している間は full_access を選んでください。キーはすぐにコピーしてください。sp_live_ で始まり、表示されるのは 1 回だけです。

   export SPACEPOST_API_KEY="sp_live_YOUR_API_KEY"

   注意

   キーはサーバー側で管理してください。ブラウザやモバイルのコードには絶対に含めないでください。サービスごとに sending_access キーを作成すれば、他に影響を与えず 1 つだけ無効化できます。

2. テストメールを送信

   共有のテスト用送信元 onboarding@test.spacepost.dev を使えば、ドメインがなくてもすぐに送信できます。宛先にできるのは、ご自身のチームメンバーのメールアドレスと、delivered@test.spacepost.dev などのテスト用アドレスのみです。

   Node.js

   npm install @spacepost/node

   send.ts

   import { SpacePost } from "@spacepost/node";
   
   const spacepost = new SpacePost(process.env.SPACEPOST_API_KEY);
   
   const { data, error } = await spacepost.emails.send({
     from: "Acme <onboarding@test.spacepost.dev>",
     to: ["delivered@test.spacepost.dev"],
     subject: "Hello from SpacePost",
     html: "<strong>It works!</strong>",
   });
   
   if (error) {
     console.error(error); // { statusCode, name, message }
   } else {
     console.log("Sent", data.id);
   }

   cURL

   curl -X POST https://api.spacepost.dev/emails \
     -H "Authorization: Bearer $SPACEPOST_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "from": "Acme <onboarding@test.spacepost.dev>",
       "to": ["delivered@test.spacepost.dev"],
       "subject": "Hello from SpacePost",
       "html": "<strong>It works!</strong>"
     }'

   Python

   import os
   import requests
   
   r = requests.post(
       "https://api.spacepost.dev/emails",
       headers={"Authorization": f"Bearer {os.environ['SPACEPOST_API_KEY']}"},
       json={
           "from": "Acme <onboarding@test.spacepost.dev>",
           "to": ["delivered@test.spacepost.dev"],
           "subject": "Hello from SpacePost",
           "html": "<strong>It works!</strong>",
       },
   )
   print(r.status_code, r.json())

   Go

   package main
   
   import (
     "fmt"
     "io"
     "net/http"
     "os"
     "strings"
   )
   
   func main() {
     body := `{"from":"Acme <onboarding@test.spacepost.dev>","to":["delivered@test.spacepost.dev"],"subject":"Hello from SpacePost","html":"<strong>It works!</strong>"}`
     req, _ := http.NewRequest("POST", "https://api.spacepost.dev/emails", strings.NewReader(body))
     req.Header.Set("Authorization", "Bearer "+os.Getenv("SPACEPOST_API_KEY"))
     req.Header.Set("Content-Type", "application/json")
     res, err := http.DefaultClient.Do(req)
     if err != nil {
       panic(err)
     }
     defer res.Body.Close()
     out, _ := io.ReadAll(res.Body)
     fmt.Println(res.StatusCode, string(out))
   }

   レスポンスは { "id": "0192e1c4-7a3b-7c1e-9d2f-3b5a8e6f4c10" } です。ダッシュボードでメールを開くと、sent、続いて delivered というタイムラインを確認できます。

3. ドメインを追加して検証する

   任意の宛先に送信するには、ご自身が所有するドメインから送信します。

   curl -X POST https://api.spacepost.dev/domains \
     -H "Authorization: Bearer $SPACEPOST_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{ "name": "acme.com" }'

   レスポンスには、作成すべき DNS の records が一覧で含まれます。DKIM 用の CNAME が 3 つと、send サブドメイン（カスタム Return-Path）用の MX レコードおよび TXT レコードです。これらを DNS プロバイダーに追加してから(Cloudflare や Route 53 などのガイド)、SpacePost に確認を依頼します。

   curl -X POST https://api.spacepost.dev/domains/$DOMAIN_ID/verify \
     -H "Authorization: Bearer $SPACEPOST_API_KEY"

   CLI に任せて、DNS の状態をリアルタイムで確認することもできます。

   npx spacepost domains doctor acme.com

   検証は通常、数分で完了します。DKIM が確認されると、ドメインの status が verified になります。

4. ご自身のドメインから送信する

   await spacepost.emails.send({
     from: "Acme <hello@acme.com>",
     to: ["you@example.com"],
     subject: "First real email",
     html: "<p>Sent from my own domain.</p>",
   });

新規アカウントの制限

新しいアカウントは、最初の 7 日間は 1 日あたり 100 通まで送信できます。詳しくはアカウントのサンドボックスをご覧ください。

次のステップ

言語別クイックスタートNext.js、Express、Hono、Python、Go、PHP、Ruby、Rust などに対応しています。

Webhook を設定するメールの配信、バウンス、開封をリアルタイムに把握します。

到達率のベストプラクティス迷惑メールフォルダではなく、受信トレイに届けましょう。