httpNotification

Documentation

Index

• Variables
• type Client
  • func NewClient(c *apiClient.Client) *Client
  • func (c Client) IsEmailOptedOut(email string) (yes bool, err error)
  • func (c Client) OptOutEmail(email string) error
  • func (c Client) RemoveOptedOutEmail(email string) error
  • func (c Client) SendEmail(email notification.Email) (id string, err error)
• type IsEmailOptedOutResponse
• type SendEmailResponse

Variables

var (
	ErrEmailAlreadySent = errorRegistry.MustAddMessageError(1000, "Email Already Sent")
)

Errors that are returned from the HTTP server.

Types

type Client

type Client struct {
	*apiClient.Client
}

Client implements gopherpit.com/gopherpit/services/notification.Service interface.

func NewClient

func NewClient(c *apiClient.Client) *Client

NewClient creates a new Client.

func (Client) IsEmailOptedOut

func (c Client) IsEmailOptedOut(email string) (yes bool, err error)

IsEmailOptedOut returns true or false if e-mail address is marked not to send any e-mail messages to. Expected response body is a JSON-encoded instance of IsEmailOptedOutResponse.

func (Client) OptOutEmail

func (c Client) OptOutEmail(email string) error

OptOutEmail marks an e-mail address not to send any e-mail messages to.

func (Client) RemoveOptedOutEmail

func (c Client) RemoveOptedOutEmail(email string) error

RemoveOptedOutEmail removes an opt-out mark previosulu set by OptOutEmail.

func (Client) SendEmail

func (c Client) SendEmail(email notification.Email) (id string, err error)

SendEmail sends an e-mail message and returns it's ID. Expected response body is a JSON-encoded instance of SendEmailResponse.

type IsEmailOptedOutResponse

type IsEmailOptedOutResponse struct {
	Yes bool `json:"yes"`
}

IsEmailOptedOutResponse is expected structure of JSON-encoded response body for IsEmailOptedOut HTTP request.

type SendEmailResponse

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

SendEmailResponse is expected structure of JSON-encoded response body for SendEmail HTTP request.