mailgun

package module

Go to main page

Versions in this module

v1

v1.1.1

Oct 2, 2018

Changes in this version

+ type Accepted struct

+ Incoming int

+ Outgoing int

+ Total int

+ type Batch struct

+ ID string

type Bounce

+ Code interface{}

+ type BufferAttachment struct

+ Buffer []byte

+ Filename string

+ type ClientInfo struct

+ ClientName *string

+ ClientOS *string

+ ClientType *ClientType

+ DeviceType *DeviceType

+ UserAgent *string

+ type ClientType uint

+ const ClientBrowser

+ const ClientEmail

+ const ClientLibrary

+ const ClientMobileBrowser

+ const ClientOther

+ const ClientRobot

+ const ClientUnknown

+ func (ct *ClientType) UnmarshalText(text []byte) error

+ func (ct ClientType) MarshalText() ([]byte, error)

+ func (ct ClientType) String() string

+ type Delivered struct

+ Http int

+ Smtp int

+ Total int

+ type DeliveryStatus struct

+ Code interface{}

+ Description *string

+ Message *string

+ Retry *int

+ type DeviceType uint

+ const DeviceBrowser

+ const DeviceEmail

+ const DeviceMobileBrowser

+ const DeviceOther

+ const DeviceUnknown

+ func (ct *DeviceType) UnmarshalText(text []byte) error

+ func (ct DeviceType) MarshalText() ([]byte, error)

+ func (ct DeviceType) String() string

type EmailVerification

+ IsDisposableAddress bool

+ IsRoleAddress bool

+ MailboxVerification bool

+ Reason string

+ type Envelope struct

+ Sender *string

+ SendingHost *string

+ SendingIP *IP

+ Targets *string

+ Transport *TransportMethod

type Event

+ Batch *Batch

+ Campaigns []Campaign

+ ClientInfo *ClientInfo

+ DeliveryStatus *DeliveryStatus

+ Envelope *Envelope

+ Event EventType

+ Flags *EventFlags

+ Geolocation *Geolocation

+ ID string

+ IP *IP

+ Message *EventMessage

+ Method *Method

+ Reason *EventReason

+ Recipient *Recipient

+ Routes []Route

+ Severity *EventSeverity

+ Storage *Storage

+ Tags []string

+ Timestamp TimestampNano

+ URL *string

+ UserVariables map[string]string

+ type EventFlags struct

+ Authenticated bool

+ Batch bool

+ Big bool

+ Callback bool

+ DelayedBounce bool

+ SystemTest bool

+ TestMode bool

+ type EventMessage struct

+ Attachments []StoredAttachment

+ Headers map[string]string

+ Recipients []string

+ Size *int

+ func (em *EventMessage) ID() (string, error)

+ type EventReason uint8

+ const ReasonBlacklisted

+ const ReasonBounce

+ const ReasonESPBlock

+ const ReasonGeneric

+ const ReasonGreylisted

+ const ReasonHardFail

+ const ReasonOld

+ const ReasonSuppressBounce

+ const ReasonSuppressComplaint

+ const ReasonSuppressUnsubscribe

+ const ReasonUnknown

+ func (er *EventReason) UnmarshalText(text []byte) error

+ func (er EventReason) MarshalText() ([]byte, error)

+ func (er EventReason) String() string

+ type EventSeverity uint8

+ const SeverityInternal

+ const SeverityPermanent

+ const SeverityTemporary

+ const SeverityUnknown

+ func (es *EventSeverity) UnmarshalText(text []byte) error

+ func (es EventSeverity) MarshalText() ([]byte, error)

+ func (es EventSeverity) String() string

+ type EventType uint8

+ const EventAccepted

+ const EventClicked

+ const EventComplained

+ const EventDelivered

+ const EventDropped

+ const EventFailed

+ const EventOpened

+ const EventRejected

+ const EventStored

+ const EventUnknown

+ const EventUnsubscribed

+ func (et *EventType) UnmarshalText(text []byte) error

+ func (et EventType) MarshalText() ([]byte, error)

+ func (et EventType) String() string

+ type Failed struct

+ Permanent Permanent

+ Temporary Temporary

+ type Geolocation struct

+ City *string

+ Country *string

+ Region *string

+ type IP net.IP

+ func (i *IP) UnmarshalText(text []byte) error

+ func (i IP) MarshalText() ([]byte, error)

type Mailgun

+ GetStatsTotal func(start *time.Time, end *time.Time, resolution string, duration string, ...) (*StatsTotalResponse, error)

+ GetStoredMessageForURL func(url string) (StoredMessage, error)

+ GetStoredMessageRawForURL func(url string) (StoredMessageRaw, error)

type MailgunImpl

+ func NewMailgunImpl(domain, apiKey, publicApiKey string) *MailgunImpl

+ func (m *MailgunImpl) GetStatsTotal(start *time.Time, end *time.Time, resolution string, duration string, ...) (*StatsTotalResponse, error)

+ func (mg *MailgunImpl) GetStoredMessageForURL(url string) (StoredMessage, error)

+ func (mg *MailgunImpl) GetStoredMessageRawForURL(url string) (StoredMessageRaw, error)

type Message

+ func (m *Message) AddBufferAttachment(filename string, buffer []byte)

+ func (m *Message) AddDomain(domain string)

+ func (m *Message) EnableNativeSend()

+ type Method uint8

+ const MethodHTTP

+ const MethodSMTP

+ const MethodUnknown

+ func (m *Method) UnmarshalText(text []byte) error

+ func (m Method) MarshalText() ([]byte, error)

+ func (m Method) String() string

+ type Permanent struct

+ Bounce int

+ DelayedBounce int

+ SuppressBounce int

+ SuppressComplaint int

+ SuppressUnsubscribe int

+ Total int

+ type Recipient struct

+ Email string

+ Name string

+ func (r *Recipient) UnmarshalText(text []byte) error

+ func (r Recipient) MarshalText() ([]byte, error)

+ func (r Recipient) String() string

+ type StatsTotal struct

+ Accepted Accepted

+ Clicked Total

+ Complained Total

+ Delivered Delivered

+ Failed Failed

+ Opened Total

+ Stored Total

+ Time string

+ Unsubscribed Total

+ type StatsTotalResponse struct

+ End string

+ Resolution string

+ Start string

+ Stats []StatsTotal

+ type Storage struct

+ Key string

+ URL string

+ type Temporary struct

+ Espblock int

+ type TimestampNano time.Time

+ func (tn *TimestampNano) UnmarshalJSON(data []byte) error

+ func (tn TimestampNano) MarshalJSON() ([]byte, error)

+ type Total struct

+ Total int

+ type TransportMethod uint

+ const TransportHTTP

+ const TransportSMTP

+ const TransportUnknown

+ func (tm *TransportMethod) UnmarshalText(text []byte) error

+ func (tm TransportMethod) MarshalText() ([]byte, error)

+ func (tm TransportMethod) String() string

v1.1.0

Feb 13, 2017

Changes in this version

+ const ApiBase

+ var Debug = false

+ func GetStatusFromErr(err error) int

type Event

+ func (e Event) ParseMessageId() (string, error)

+ func (e Event) ParseTimeStamp() (time.Time, error)

type EventIterator

+ FirstURL string

+ LastURL string

+ NextURL string

+ PrevURL string

+ func (ei *EventIterator) Err() error

+ func (ei *EventIterator) First(events *[]Event) bool

+ func (ei *EventIterator) Last(events *[]Event) bool

+ func (ei *EventIterator) Next(events *[]Event) bool

+ func (ei *EventIterator) Previous(events *[]Event) bool

+ type EventPoller struct

+ func (ep *EventPoller) Err() error

+ func (ep *EventPoller) Poll(events *[]Event) bool

+ type EventsOptions struct

+ Begin time.Time

+ Compact bool

+ End time.Time

+ Filter map[string]string

+ ForceAscending bool

+ ForceDescending bool

+ Limit int

+ PollInterval time.Duration

+ ThresholdAge time.Duration

type Mailgun

+ func NewMailgunFromEnv() (Mailgun, error)

+ ApiBase func() string

+ GetTag func(tag string) (TagItem, error)

+ ListEvents func(*EventsOptions) *EventIterator

+ ListTags func(*TagOptions) *TagIterator

+ PollEvents func(*EventsOptions) *EventPoller

+ SetAPIBase func(url string)

+ VerifyWebhookRequest func(req *http.Request) (verified bool, err error)

type MailgunImpl

+ func (m *MailgunImpl) ApiBase() string

+ func (m *MailgunImpl) GetTag(tag string) (TagItem, error)

+ func (m *MailgunImpl) ListTags(opts *TagOptions) *TagIterator

+ func (m *MailgunImpl) SetAPIBase(address string)

+ func (mg *MailgunImpl) ListEvents(opts *EventsOptions) *EventIterator

+ func (mg *MailgunImpl) PollEvents(opts *EventsOptions) *EventPoller

+ type TagItem struct

+ Description string

+ FirstSeen *time.Time

+ LastSeen *time.Time

+ Value string

+ type TagIterator struct

+ func NewTagCursor(tagPage TagsPage, mailgun Mailgun) *TagIterator

+ func (t *TagIterator) Err() error

+ func (t *TagIterator) First(tagPage *TagsPage) bool

+ func (t *TagIterator) Last(tagPage *TagsPage) bool

+ func (t *TagIterator) Next(tagPage *TagsPage) bool

+ func (t *TagIterator) Previous(tagPage *TagsPage) bool

+ type TagOptions struct

+ Limit int

+ Page string

+ Prefix string

+ Tag string

+ type TagsPage struct

+ Items []TagItem

+ Paging Paging

type Unsubscription

+ Tags []string

v1.0.2

Aug 25, 2016

v1.0.1

Aug 25, 2016

v1.0.0

Aug 16, 2016

Changes in this version

+ const DefaultLimit

+ const DefaultSkip

+ const Delete

+ const Disabled

+ const Everyone

+ const MailgunGoUserAgent

+ const MaxNumberOfRecipients

+ const Members

+ const ReadOnly

+ const Tag

+ var All *bool = nil

+ var ErrEmptyParam = fmt.Errorf("empty or illegal parameter")

+ var Subscribed *bool = &yes

+ var Unsubscribed *bool = &no

+ type Bounce struct

+ Address string

+ CreatedAt string

+ Error string

+ func (b Bounce) GetCode() (int, error)

+ func (i Bounce) GetCreatedAt() (t time.Time, err error)

+ type Campaign struct

+ BouncedCount int

+ ClickedCount int

+ ComplainedCount int

+ CreatedAt string

+ DeliveredCount int

+ DroppedCount int

+ Id string

+ Name string

+ OpenedCount int

+ SubmittedCount int

+ UnsubscribedCount int

+ type Complaint struct

+ Address string

+ Count int

+ CreatedAt string

+ type Credential struct

+ CreatedAt string

+ Login string

+ Password string

+ type DNSRecord struct

+ Name string

+ Priority string

+ RecordType string

+ Valid string

+ Value string

+ type Domain struct

+ CreatedAt string

+ Name string

+ SMTPLogin string

+ SMTPPassword string

+ SpamAction string

+ Wildcard bool

+ func (d Domain) GetCreatedAt() (t time.Time, err error)

+ type EmailVerification struct

+ Address string

+ DidYouMean string

+ IsValid bool

+ Parts EmailVerificationParts

+ type EmailVerificationParts struct

+ DisplayName string

+ Domain string

+ LocalPart string

+ type Event map[string]interface

+ type EventIterator struct

+ func (ei *EventIterator) Events() []Event

+ func (ei *EventIterator) GetFirstPage(opts GetEventsOptions) error

+ func (ei *EventIterator) GetNext() error

+ func (ei *EventIterator) GetPrevious() error

+ type GetEventsOptions struct

+ Begin time.Time

+ Compact bool

+ End time.Time

+ Filter map[string]string

+ ForceAscending bool

+ ForceDescending bool

+ Limit int

+ type List struct

+ AccessLevel string

+ Address string

+ CreatedAt string

+ Description string

+ MembersCount int

+ Name string

+ type Mailgun interface

+ AddBounce func(address, code, error string) error

+ ApiKey func() string

+ ChangeCredentialPassword func(id, password string) error

+ Client func() *http.Client

+ CreateCampaign func(name, id string) error

+ CreateComplaint func(string) error

+ CreateCredential func(login, password string) error

+ CreateDomain func(name string, smtpPassword string, spamAction string, wildcard bool) error

+ CreateList func(List) (List, error)

+ CreateMember func(merge bool, addr string, prototype Member) error

+ CreateMemberList func(subscribed *bool, addr string, newMembers []interface{}) error

+ CreateRoute func(Route) (Route, error)

+ CreateWebhook func(kind, url string) error

+ DeleteBounce func(address string) error

+ DeleteCampaign func(id string) error

+ DeleteComplaint func(string) error

+ DeleteCredential func(id string) error

+ DeleteDomain func(name string) error

+ DeleteList func(string) error

+ DeleteMember func(Member, list string) error

+ DeleteRoute func(string) error

+ DeleteStoredMessage func(id string) error

+ DeleteTag func(tag string) error

+ DeleteWebhook func(kind string) error

+ Domain func() string

+ GetBounces func(limit, skip int) (int, []Bounce, error)

+ GetCampaigns func() (int, []Campaign, error)

+ GetComplaints func(limit, skip int) (int, []Complaint, error)

+ GetCredentials func(limit, skip int) (int, []Credential, error)

+ GetDomains func(limit, skip int) (int, []Domain, error)

+ GetListByAddress func(string) (List, error)

+ GetLists func(limit, skip int, filter string) (int, []List, error)

+ GetMemberByAddress func(MemberAddr, listAddr string) (Member, error)

+ GetMembers func(limit, skip int, subfilter *bool, address string) (int, []Member, error)

+ GetRouteByID func(string) (Route, error)

+ GetRoutes func(limit, skip int) (int, []Route, error)

+ GetSingleBounce func(address string) (Bounce, error)

+ GetSingleComplaint func(address string) (Complaint, error)

+ GetSingleDomain func(domain string) (Domain, []DNSRecord, []DNSRecord, error)

+ GetStats func(limit int, skip int, startDate *time.Time, event ...string) (int, []Stat, error)

+ GetStoredMessage func(id string) (StoredMessage, error)

+ GetStoredMessageRaw func(id string) (StoredMessageRaw, error)

+ GetUnsubscribes func(limit, skip int) (int, []Unsubscription, error)

+ GetUnsubscribesByAddress func(string) (int, []Unsubscription, error)

+ GetWebhookByType func(kind string) (string, error)

+ GetWebhooks func() (map[string]string, error)

+ NewEventIterator func() *EventIterator

+ NewMIMEMessage func(body io.ReadCloser, to ...string) *Message

+ NewMessage func(from, subject, text string, to ...string) *Message

+ ParseAddresses func(addresses ...string) ([]string, []string, error)

+ PublicApiKey func() string

+ RemoveUnsubscribe func(string) error

+ RemoveUnsubscribeWithTag func(a, t string) error

+ Send func(m *Message) (string, string, error)

+ SetClient func(client *http.Client)

+ Unsubscribe func(address, tag string) error

+ UpdateCampaign func(oldId, name, newId string) error

+ UpdateList func(string, List) (List, error)

+ UpdateMember func(Member, list string, prototype Member) (Member, error)

+ UpdateRoute func(string, Route) (Route, error)

+ UpdateWebhook func(kind, url string) error

+ ValidateEmail func(email string) (EmailVerification, error)

+ func NewMailgun(domain, apiKey, publicApiKey string) Mailgun

+ type MailgunImpl struct

+ func (m *MailgunImpl) AddBounce(address, code, error string) error

+ func (m *MailgunImpl) ApiKey() string

+ func (m *MailgunImpl) Client() *http.Client

+ func (m *MailgunImpl) CreateCampaign(name, id string) error

+ func (m *MailgunImpl) CreateComplaint(address string) error

+ func (m *MailgunImpl) CreateDomain(name string, smtpPassword string, spamAction string, wildcard bool) error

+ func (m *MailgunImpl) DeleteBounce(address string) error

+ func (m *MailgunImpl) DeleteCampaign(id string) error

+ func (m *MailgunImpl) DeleteComplaint(address string) error

+ func (m *MailgunImpl) DeleteDomain(name string) error

+ func (m *MailgunImpl) DeleteTag(tag string) error

+ func (m *MailgunImpl) Domain() string

+ func (m *MailgunImpl) GetBounces(limit, skip int) (int, []Bounce, error)

+ func (m *MailgunImpl) GetCampaigns() (int, []Campaign, error)

+ func (m *MailgunImpl) GetComplaints(limit, skip int) (int, []Complaint, error)

+ func (m *MailgunImpl) GetDomains(limit, skip int) (int, []Domain, error)

+ func (m *MailgunImpl) GetSingleBounce(address string) (Bounce, error)

+ func (m *MailgunImpl) GetSingleComplaint(address string) (Complaint, error)

+ func (m *MailgunImpl) GetSingleDomain(domain string) (Domain, []DNSRecord, []DNSRecord, error)

+ func (m *MailgunImpl) GetStats(limit int, skip int, startDate *time.Time, event ...string) (int, []Stat, error)

+ func (m *MailgunImpl) ParseAddresses(addresses ...string) ([]string, []string, error)

+ func (m *MailgunImpl) PublicApiKey() string

+ func (m *MailgunImpl) Send(message *Message) (mes string, id string, err error)

+ func (m *MailgunImpl) SetClient(c *http.Client)

+ func (m *MailgunImpl) UpdateCampaign(oldId, name, newId string) error

+ func (m *MailgunImpl) ValidateEmail(email string) (EmailVerification, error)

+ func (mg *MailgunImpl) ChangeCredentialPassword(id, password string) error

+ func (mg *MailgunImpl) CreateCredential(login, password string) error

+ func (mg *MailgunImpl) CreateList(prototype List) (List, error)

+ func (mg *MailgunImpl) CreateMember(merge bool, addr string, prototype Member) error

+ func (mg *MailgunImpl) CreateMemberList(u *bool, addr string, newMembers []interface{}) error

+ func (mg *MailgunImpl) CreateRoute(prototype Route) (Route, error)

+ func (mg *MailgunImpl) CreateWebhook(t, u string) error

+ func (mg *MailgunImpl) DeleteCredential(id string) error

+ func (mg *MailgunImpl) DeleteList(addr string) error

+ func (mg *MailgunImpl) DeleteMember(member, addr string) error

+ func (mg *MailgunImpl) DeleteRoute(id string) error

+ func (mg *MailgunImpl) DeleteStoredMessage(id string) error

+ func (mg *MailgunImpl) DeleteWebhook(t string) error

+ func (mg *MailgunImpl) GetCredentials(limit, skip int) (int, []Credential, error)

+ func (mg *MailgunImpl) GetListByAddress(addr string) (List, error)

+ func (mg *MailgunImpl) GetLists(limit, skip int, filter string) (int, []List, error)

+ func (mg *MailgunImpl) GetMemberByAddress(s, l string) (Member, error)

+ func (mg *MailgunImpl) GetMembers(limit, skip int, s *bool, addr string) (int, []Member, error)

+ func (mg *MailgunImpl) GetRouteByID(id string) (Route, error)

+ func (mg *MailgunImpl) GetRoutes(limit, skip int) (int, []Route, error)

+ func (mg *MailgunImpl) GetStoredMessage(id string) (StoredMessage, error)

+ func (mg *MailgunImpl) GetStoredMessageRaw(id string) (StoredMessageRaw, error)

+ func (mg *MailgunImpl) GetUnsubscribes(limit, skip int) (int, []Unsubscription, error)

+ func (mg *MailgunImpl) GetUnsubscribesByAddress(a string) (int, []Unsubscription, error)

+ func (mg *MailgunImpl) GetWebhookByType(t string) (string, error)

+ func (mg *MailgunImpl) GetWebhooks() (map[string]string, error)

+ func (mg *MailgunImpl) NewEventIterator() *EventIterator

+ func (mg *MailgunImpl) NewMIMEMessage(body io.ReadCloser, to ...string) *Message

+ func (mg *MailgunImpl) NewMessage(from, subject, text string, to ...string) *Message

+ func (mg *MailgunImpl) RemoveUnsubscribe(a string) error

+ func (mg *MailgunImpl) RemoveUnsubscribeWithTag(a, t string) error

+ func (mg *MailgunImpl) Unsubscribe(a, t string) error

+ func (mg *MailgunImpl) UpdateList(addr string, prototype List) (List, error)

+ func (mg *MailgunImpl) UpdateMember(s, l string, prototype Member) (Member, error)

+ func (mg *MailgunImpl) UpdateRoute(id string, route Route) (Route, error)

+ func (mg *MailgunImpl) UpdateWebhook(t, u string) error

+ func (mg *MailgunImpl) VerifyWebhookRequest(req *http.Request) (verified bool, err error)

+ type Member struct

+ Address string

+ Name string

+ Subscribed *bool

+ Vars map[string]interface{}

+ type Message struct

+ func NewMIMEMessage(body io.ReadCloser, to ...string) *Message

+ func NewMessage(from string, subject string, text string, to ...string) *Message

+ func (m *Message) AddAttachment(attachment string)

+ func (m *Message) AddBCC(recipient string)

+ func (m *Message) AddCC(recipient string)

+ func (m *Message) AddCampaign(campaign string)

+ func (m *Message) AddHeader(header, value string)

+ func (m *Message) AddInline(inline string)

+ func (m *Message) AddReaderAttachment(filename string, readCloser io.ReadCloser)

+ func (m *Message) AddReaderInline(filename string, readCloser io.ReadCloser)

+ func (m *Message) AddRecipient(recipient string) error

+ func (m *Message) AddRecipientAndVariables(r string, vars map[string]interface{}) error

+ func (m *Message) AddTag(tag string)

+ func (m *Message) AddVariable(variable string, value interface{}) error

+ func (m *Message) EnableTestMode()

+ func (m *Message) RecipientCount() int

+ func (m *Message) SetDKIM(dkim bool)

+ func (m *Message) SetDeliveryTime(dt time.Time)

+ func (m *Message) SetHtml(html string)

+ func (m *Message) SetReplyTo(recipient string)

+ func (m *Message) SetTracking(tracking bool)

+ func (m *Message) SetTrackingClicks(trackingClicks bool)

+ func (m *Message) SetTrackingOpens(trackingOpens bool)

+ type Paging struct

+ First string

+ Last string

+ Next string

+ Previous string

+ type ReaderAttachment struct

+ Filename string

+ ReadCloser io.ReadCloser

+ type Route struct

+ Actions []string

+ CreatedAt string

+ Description string

+ Expression string

+ ID string

+ Priority int

+ type Stat struct

+ CreatedAt string

+ Event string

+ Id string

+ Tags map[string]int

+ TotalCount int

+ type StoredAttachment struct

+ ContentType string

+ Name string

+ Size int

+ Url string

+ type StoredMessage struct

+ Attachments []StoredAttachment

+ BodyHtml string

+ BodyPlain string

+ ContentIDMap map[string]struct{ ... }

+ From string

+ MessageHeaders [][]string

+ MessageUrl string

+ Recipients string

+ Sender string

+ StrippedHtml string

+ StrippedSignature string

+ StrippedText string

+ Subject string

+ type StoredMessageRaw struct

+ BodyMime string

+ From string

+ Recipients string

+ Sender string

+ Subject string

+ type UnexpectedResponseError struct

+ Actual int

+ Data []byte

+ Expected []int

+ URL string

+ func (e *UnexpectedResponseError) Error() string

+ func (e *UnexpectedResponseError) String() string

+ type Unsubscription struct

+ Address string

+ CreatedAt string

+ ID string

+ Tag string

Incompatible versions in this module

v2.0.0+incompatible

Oct 4, 2018

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