Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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.
type Service ¶
type Service struct {
// Client provides HTTP request making functionality.
Client *apiClient.Client
}
Service implements gopherpit.com/gopherpit/services/notification.Service interface.
func NewService ¶ added in v0.3.1
func NewService(c *apiClient.Client) *Service
NewService creates a new Service and injects notification.ErrorRegistry in the API Client.
func (Service) IsEmailOptedOut ¶
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 (Service) OptOutEmail ¶
OptOutEmail marks an e-mail address not to send any e-mail messages to.
func (Service) RemoveOptedOutEmail ¶
RemoveOptedOutEmail removes an opt-out mark previosulu set by OptOutEmail.