resend

README

Resend Go SDK

Installation

To install the Go SDK, simply execute the following command on a terminal:

go get github.com/resendlabs/resend-go

Setup

First, you need to get an API key, which is available in the Resend Dashboard.

Example

import "github.com/resendlabs/resend-go"

func main() {
    apiKey = "re_123"

    client := resend.NewClient(apiKey)

    params := &resend.SendEmailRequest{
        To:      []string{"to@example", "you@example.com"},
        From:    "me@exemple.io",
        Text:    "hello world",
        Subject: "Hello from Golang",
        Cc:      []string{"cc@example.com"},
        Bcc:     []string{"cc@example.com"},
        ReplyTo: "replyto@example.com",
    }

    sent, err := client.Emails.Send(params)
    if err != nil {
        panic(err)
    }
    fmt.Println(sent.Id)
}

You can view all the examples in the examples folder

Documentation

Index

• type ApiKey
• type ApiKeysSvc
• type ApiKeysSvcImpl
  • func (s *ApiKeysSvcImpl) Create(params *CreateApiKeyRequest) (CreateApiKeyResponse, error)
  • func (s *ApiKeysSvcImpl) List() (ListApiKeysResponse, error)
  • func (s *ApiKeysSvcImpl) Remove(apiKeyId string) (bool, error)
• type Attachment
• type Client
  • func NewClient(apiKey string) *Client
  • func NewCustomClient(httpClient *http.Client, apiKey string) *Client
  • func (c *Client) NewRequest(method, path string, params interface{}) (*http.Request, error)
  • func (c *Client) Perform(req *http.Request, ret interface{}) (*http.Response, error)
• type CreateApiKeyRequest
• type CreateApiKeyResponse
• type CreateDomainRequest
• type CreateDomainResponse
• type DefaultError
• type Domain
• type DomainsSvc
• type DomainsSvcImpl
  • func (s *DomainsSvcImpl) Create(params *CreateDomainRequest) (CreateDomainResponse, error)
  • func (s *DomainsSvcImpl) Get(domainId string) (Domain, error)
  • func (s *DomainsSvcImpl) List() (ListDomainsResponse, error)
  • func (s *DomainsSvcImpl) Remove(domainId string) (bool, error)
  • func (s *DomainsSvcImpl) Verify(domainId string) (bool, error)
• type Email
• type EmailsSvc
• type EmailsSvcImpl
  • func (s *EmailsSvcImpl) Get(emailId string) (Email, error)
  • func (s *EmailsSvcImpl) Send(params *SendEmailRequest) (SendEmailResponse, error)
• type InvalidRequestError
• type ListApiKeysResponse
• type ListDomainsResponse
• type Record
• type SendEmailRequest
• type SendEmailResponse
• type Tag

Types

type ApiKey

type ApiKey struct {
	Id        string `json:"id"`
	Name      string `json:"name"`
	CreatedAt string `json:"created_at"`
}

type ApiKeysSvc

type ApiKeysSvc interface {
	Create(*CreateApiKeyRequest) (CreateApiKeyResponse, error)
	List() (ListApiKeysResponse, error)
	Remove(apiKeyId string) (bool, error)
}

type ApiKeysSvcImpl

type ApiKeysSvcImpl struct {
	// contains filtered or unexported fields
}

func (*ApiKeysSvcImpl) Create

func (s *ApiKeysSvcImpl) Create(params *CreateApiKeyRequest) (CreateApiKeyResponse, error)

Create creates a new API Key based on the given params https://resend.com/docs/api-reference/api-keys/create-api-key

func (*ApiKeysSvcImpl) List

func (s *ApiKeysSvcImpl) List() (ListApiKeysResponse, error)

List list all API Keys in the project https://resend.com/docs/api-reference/api-keys/list-api-keys

func (*ApiKeysSvcImpl) Remove

func (s *ApiKeysSvcImpl) Remove(apiKeyId string) (bool, error)

Remove deletes a given api key by id https://resend.com/docs/api-reference/api-keys/delete-api-key

type Attachment

type Attachment struct {

	// Content must be a string representation of a byte array
	Content string `json:"content,omitempty"`

	// Filename that will appear in the email.
	// Make sure you pick the correct extension otherwise preview
	// may not work as expected
	Filename string `json:"filename"`

	// Path where the attachment file is hosted
	Path string `json:"path,omitempty"`
}

type Client

type Client struct {

	// Api Key
	ApiKey string

	// Base URL
	BaseURL *url.URL

	// User agent for client
	UserAgent string

	// Services
	Emails  EmailsSvc
	ApiKeys ApiKeysSvc
	Domains DomainsSvc
	// contains filtered or unexported fields
}

Client handles communication with Resend API.

func NewClient

func NewClient(apiKey string) *Client

NewClient is the default client constructor

func NewCustomClient

func NewCustomClient(httpClient *http.Client, apiKey string) *Client

NewCustomClient builds a new Resend API client, using a provided Http client.

func (*Client) NewRequest

func (c *Client) NewRequest(method, path string, params interface{}) (*http.Request, error)

NewRequest builds and returns a new HTTP request object based on the given arguments

func (*Client) Perform

func (c *Client) Perform(req *http.Request, ret interface{}) (*http.Response, error)

Perform sends the request to the Resend API

type CreateApiKeyRequest

type CreateApiKeyRequest struct {
	Name       string `json:"name"`
	Permission string `json:"permission,omitempty"` // TODO: update permission to type
	DomainId   string `json:"domain_id,omitempty"`
}

type CreateApiKeyResponse

type CreateApiKeyResponse struct {
	Id    string `json:"id"`
	Token string `json:"token"`
}

type CreateDomainRequest

type CreateDomainRequest struct {
	Name   string `json:"name"`
	Region string `json:"region,omitempty"`
}

type CreateDomainResponse

type CreateDomainResponse struct {
	Id          string   `json:"id"`
	Name        string   `json:"name"`
	CreatedAt   string   `json:"createdAt"`
	Status      string   `json:"status"`
	Records     []Record `json:"records"`
	Region      string   `json:"region"`
	DnsProvider string   `json:"dnsProvider"`
}

type DefaultError

type DefaultError struct {
	Message string `json:"message"`
}

type Domain

type Domain struct {
	Id        string `json:"id"`
	Object    string `json:"object"`
	Name      string `json:"name"`
	CreatedAt string `json:"created_at"`
	Status    string `json:"status"`
	Region    string `json:"region"`
}

type DomainsSvc

type DomainsSvc interface {
	Create(*CreateDomainRequest) (CreateDomainResponse, error)
	Verify(domainId string) (bool, error)
	List() (ListDomainsResponse, error)
	Get(domainId string) (Domain, error)
	Remove(domainId string) (bool, error)
}

type DomainsSvcImpl

type DomainsSvcImpl struct {
	// contains filtered or unexported fields
}

func (*DomainsSvcImpl) Create

func (s *DomainsSvcImpl) Create(params *CreateDomainRequest) (CreateDomainResponse, error)

Create creates a new Domain entry based on the given params https://resend.com/docs/api-reference/domains/create-domain

func (*DomainsSvcImpl) Get

func (s *DomainsSvcImpl) Get(domainId string) (Domain, error)

Get retrieves a domain object https://resend.com/docs/api-reference/domains/get-domain

func (*DomainsSvcImpl) List

func (s *DomainsSvcImpl) List() (ListDomainsResponse, error)

List returns the list of all doamins https://resend.com/docs/api-reference/domains/list-domains

func (*DomainsSvcImpl) Remove

func (s *DomainsSvcImpl) Remove(domainId string) (bool, error)

Remove removes a given domain entry by id https://resend.com/docs/api-reference/domains/delete-domain

func (*DomainsSvcImpl) Verify

func (s *DomainsSvcImpl) Verify(domainId string) (bool, error)

Verify verifies a given domain Id https://resend.com/docs/api-reference/domains/verify-domain

type Email

type Email struct {
	Id        string   `json:"id"`
	Object    string   `json:"obejct"`
	To        []string `json:"to"`
	From      string   `json:"from"`
	CreatedAt string   `json:"created_at"`
	Subject   string   `json:"subject"`
	Html      string   `json:"html"`
	Text      string   `json:"text"`
	Bcc       []string `json:"bcc"`
	Cc        []string `json:"cc"`
	ReplyTo   []string `json:"reply_to"`
	LastEvent string   `json:"last_event"`
}

type EmailsSvc

type EmailsSvc interface {
	Send(*SendEmailRequest) (SendEmailResponse, error)
	Get(emailId string) (Email, error)
}

type EmailsSvcImpl

type EmailsSvcImpl struct {
	// contains filtered or unexported fields
}

func (*EmailsSvcImpl) Get

func (s *EmailsSvcImpl) Get(emailId string) (Email, error)

Get retrives an email with the given emailId https://resend.com/docs/api-reference/emails/retrieve-email

func (*EmailsSvcImpl) Send

func (s *EmailsSvcImpl) Send(params *SendEmailRequest) (SendEmailResponse, error)

Send sends an email with the given params

type InvalidRequestError

type InvalidRequestError struct {
	StatusCode int    `json:"statusCode"`
	Name       string `json:"name"`
	Message    string `json:"message"`
}

type ListApiKeysResponse

type ListApiKeysResponse struct {
	Data []ApiKey `json:"data"`
}

type ListDomainsResponse

type ListDomainsResponse struct {
	Data []Domain `json:"data"`
}

type Record

type Record struct {
	Record   string      `json:"record"`
	Name     string      `json:"name"`
	Type     string      `json:"type"`
	Ttl      string      `json:"ttl"`
	Status   string      `json:"status"`
	Value    string      `json:"value"`
	Priority json.Number `json:"priority,omitempty"`
}

type SendEmailRequest

type SendEmailRequest struct {
	From        string       `json:"from"`
	To          []string     `json:"to"`
	Subject     string       `json:"subject"`
	Bcc         []string     `json:"bcc"`
	Cc          []string     `json:"cc"`
	ReplyTo     string       `json:"reply_to"`
	Html        string       `json:"html"`
	Text        string       `json:"text"`
	Tags        []Tag        `json:"tags"`
	Attachments []Attachment `json:"attachments"`
}

https://resend.com/docs/api-reference/emails/send-email

type SendEmailResponse

type SendEmailResponse struct {
	Id string `json:"id"`
}

type Tag

type Tag struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}