addressbooks

package
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 22, 2021 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	EmailStatusNew = iota
	EmailStatusActive
	EmailStatusActivationRequested
	EmailStatusActivationPending
	EmailStatusUnsubscribed
	EmailStatusRejected
	EmailStatusUnsubscribedFromAll
	EmailStatusActivationSent
	EmailStatusBlockedByUser
	EmailStatusDeliveryErrors
	EmailStatusBlockedByHosts
	EmailStatusBlockedBySendersName
	EmailStatusBlockedByAddress
	EmailStatusDeletedByUser
	EmailStatusTemporarilyUnavailable
)
View Source
const (
	StatusActive = iota
	StatusDeleted

	StatusWaiting
	StatusBlockedByService
	StatusBlockedByDaemon
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AddEmailsOptions

type AddEmailsOptions struct {
	Confirmation bool
	SenderEmail  string
	TemplateId   string
	MessageLang  string
}

type Collection

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

func New

func New(client go_sendpulse.Client) Collection

func (*Collection) AddEmails

func (c *Collection) AddEmails(ctx context.Context, id int, emails []string, options *AddEmailsOptions) error

AddEmails Add single-opt-in

func (*Collection) AddEmailsWithVariables

func (c *Collection) AddEmailsWithVariables(ctx context.Context, id int, emails []EmailWithVariables, options *AddEmailsOptions) error

AddEmailsWithVariables Add single-opt-in

func (*Collection) CostOfCampaign

func (c *Collection) CostOfCampaign(ctx context.Context, id int) (cost Cost, err error)

CostOfCampaign Calculating the Cost of a Campaign Sent to a Mailing List

func (*Collection) Delete

func (c *Collection) Delete(ctx context.Context, id int) (err error)

Delete Deleting a Mailing List

func (*Collection) DeleteEmails

func (c *Collection) DeleteEmails(ctx context.Context, id int, emails []string) error

DeleteEmails Deleting Email Addresses from a Mailing List

func (*Collection) FindByVariable

func (c *Collection) FindByVariable(ctx context.Context, id int, variableName, searchValue string) (list []Email, err error)

FindByVariable Find All Contacts in Mailing List by Value of Variable

func (*Collection) GetEmail

func (c *Collection) GetEmail(ctx context.Context, id int, email string) (list []EmailInformation, err error)

GetEmail Retrieving Information for a Specific Email Address from a Mailing List

func (*Collection) GetEmails

func (c *Collection) GetEmails(ctx context.Context, id int, options *go_sendpulse.ListOptions) (list []EmailWithExtra, err error)

GetEmails Retrieving a List of Emails from a Mailing List

func (*Collection) GetEmailsTotal

func (c *Collection) GetEmailsTotal(ctx context.Context, id int) (total int, err error)

func (*Collection) GetList

func (c *Collection) GetList(ctx context.Context, options *go_sendpulse.ListOptions) (list []Item, err error)

GetList Retrieving a List of Mailing Lists

func (*Collection) GetOne

func (c *Collection) GetOne(ctx context.Context, id int) (item *Item, err error)

GetOne Retrieving Mailing List Information

func (*Collection) GetVariables

func (c *Collection) GetVariables(ctx context.Context, id int) (list map[string]string, err error)

GetVariables Get a List of Variables for a Mailing List

type Cost

type Cost struct {
	Currency                  string `json:"cur"`
	SentEmailsQty             int    `json:"sent_emails_qty"`
	OverdraftAllEmailsPrice   int    `json:"overdraftAllEmailsPrice"`
	AddressesDeltaFromBalance int    `json:"addressesDeltaFromBalance"`
	AddressesDeltaFromTariff  int    `json:"addressesDeltaFromTariff"`
	MaxEmailsPerTask          int    `json:"max_emails_per_task"`
	Result                    bool   `json:"result"`
}

type Email

type Email struct {
	Email         string `json:"email"`
	Status        int    `json:"status"`
	StatusExplain string `json:"status_explain"`
}

type EmailInformation

type EmailInformation struct {
	Email
	AddressBookId int             `json:"abook_id"`
	Variables     []EmailVariable `json:"variables"`
}

type EmailVariable

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

type EmailWithExtra

type EmailWithExtra struct {
	Email
	Phone     string            `json:"phone"`
	Variables map[string]string `json:"variables"`
}

type EmailWithVariables

type EmailWithVariables struct {
	Email     string            `json:"email"`
	Variables map[string]string `json:"variables,omitempty"`
}

type Item

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

func (*Item) ActiveEmailQty

func (i *Item) ActiveEmailQty() int

ActiveEmailQty Number of active emails

func (*Item) AllEmailQty

func (i *Item) AllEmailQty() int

AllEmailQty Total number of emails

func (*Item) CreationDate

func (i *Item) CreationDate() time.Time

CreationDate Date of creation

func (*Item) ID

func (i *Item) ID() int

ID List ID

func (*Item) InactiveEmailQty

func (i *Item) InactiveEmailQty() int

InactiveEmailQty Number of inactive emails

func (*Item) Name

func (i *Item) Name() string

Name List name

func (*Item) Save

func (i *Item) Save(ctx context.Context, client go_sendpulse.Client) (err error)

Save Creating/Editing the Name of a Mailing List

func (*Item) SetName

func (i *Item) SetName(name string)

SetName Set List name

func (*Item) Status

func (i *Item) Status() int

Status Status code

func (*Item) StatusExplain

func (i *Item) StatusExplain() string

StatusExplain Status explanation

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL