rpc

Documentation

Overview

Package rpc contains all the methods exposed to the rpc interface

Package rpc contains all the methods exposed to the rpc interface

Index

• type GetLastEmailArgs
• type GetLastEmailResult
• type Postmaster
  • func (Postmaster) Enqueue(r *http.Request, args *sender.Mail, reply *SuccessResult) error
  • func (Postmaster) GetLastEmail(r *http.Request, args *GetLastEmailArgs, reply *GetLastEmailResult) error
  • func (Postmaster) UpdatePrefs(r *http.Request, args *UpdatePrefsArgs, reply *SuccessResult) error
• type SuccessResult
• type UpdatePrefsArgs

Types

type GetLastEmailArgs

type GetLastEmailArgs struct {
	//this should match the validate for sender.Mail
	To       string `json:"to" validate:"email,nonzero,max=256"`
	UniqueID string `json:"uniqueID" validate:"nonzero,max=256"`
}

type GetLastEmailResult

type GetLastEmailResult struct {
	Stat *db.StatDoc `json:"stat"`
}

type Postmaster

type Postmaster struct{}

Postmaster is just a holder for the RPC methods

func (Postmaster) Enqueue

func (Postmaster) Enqueue(r *http.Request, args *sender.Mail, reply *SuccessResult) error

Enqueue queues an email to be sent to sendgrid it accepts an instance of sender.Mail

func (Postmaster) GetLastEmail

func (Postmaster) GetLastEmail(r *http.Request, args *GetLastEmailArgs, reply *GetLastEmailResult) error

GetLastEmail gets stats for the last email sent for a specific unique ID If no records were found, {"stat": null} is returned

func (Postmaster) UpdatePrefs

func (Postmaster) UpdatePrefs(r *http.Request, args *UpdatePrefsArgs, reply *SuccessResult) error

UpdatePrefs updates an email addresses email preferences

type SuccessResult

type SuccessResult struct {
	Success bool `json:"success"`
}

SuccessResult holds just a Success bool and is used for methods that don't need to return anything

type UpdatePrefsArgs

type UpdatePrefsArgs struct {
	Email string `json:"email" validate:"email,nonzero"`
	Flags int64  `json:"flags" validate:"nonzero"`
}