package
0.0.0-20200109191904-8d1786a9f689
Repository: https://github.com/joincivil/go-common.git
Documentation: pkg.go.dev

# Functions

NewEmailer is a convenience function that returns a new Emailer struct with the given apiKey.
NewEmailerWithSandbox is a convenience function that returns a new Emailer struct with the given apiKey for use with the Sendgrid sandbox.
NewMailchimpAPI is a convenience function to instantiate a new MailChimpAPI struct.

# Constants

ErrTitleMemberExists is the error response from Mailchimp.
ErrTitleResourceNotFound is the error response from Mailchimp.
ServiceNameMailchimp is the service name for Mailchimp.
StatusInvalid means a member's status is invalid.
StatusPending means a member is pending or waiting of opt in.
StatusSubscribed means a member is subscribed.
StatusUnsubscribed means a member is unsubscribed.

# Structs

Emailer is a struct that wraps around an Email provider and makes it a little easier to use.
ListMember represents some basic data about a member of a list.
MailchimpAPI is a wrapper around the MailChimp API.
Member defines a single member within a list that adds a field for tags.
MemberTag represents a tag on a Member struct.
NewMemberParams is a version of NewParams that adds a tags field.
SendEmailRequest provides all the parameters to SendEmail to deliver an email.
SendTemplateEmailRequest provides all the parameters to SendTemplateEmail to deliver an templated email.
SubscriptionParams is any data can be passed along for a subscription.

# Interfaces

ListMemberManager is an interface that represents a service that manages email lists consisting of members.

# Type aliases

MailchimpTag is a Mailchimp tag.
Status represents a status of a member in the mailing list service.
Tag is a tag on a mailing list member.
TemplateData represents the key-value data for the template.