sendgrid

package module
v1.10.0 Latest Latest
Warning

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

 Go to latest Published: Mar 5, 2026 License: MIT Imports: 16 Imported by: 0

README

SendGrid API in Go

GoDoc test lint codecov

This library supports most if not all of the SendGrid REST calls.

Installing

go get
$ go get -u github.com/kenzo0107/sendgrid

Example

Get Teammate
package main

import (
	"context"
	"log"
	"os"

	"github.com/kenzo0107/sendgrid"
)

func main() {
	apiKey := os.Getenv("SENDGRID_API_KEY")

	c := sendgrid.New(apiKey)
	u, err := c.GetTeammate(context.TODO(), "username")
	if err != nil {
		fmt.Printf("%s\n", err)
		return
	}
	log.Printf("user: %#v\n", u)
}

License

MIT License

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool 

func Bool(v bool) *bool

Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.

func OptionBaseURL 

func OptionBaseURL(endpoint string) func(*Client)

OptionBaseURL - provide a custom base url to the sendgrid client.

func OptionDebug 

func OptionDebug(b bool) func(*Client)

OptionDebug enable debugging for the client

func OptionHTTPClient 

func OptionHTTPClient(client httpClient) func(*Client)

OptionHTTPClient - provide a custom http client to the sendgrid client.

func OptionLog 

func OptionLog(l logger) func(*Client)

OptionLog set logging for client.

func OptionSubuser 

func OptionSubuser(subuser string) func(*Client)

OptionBaseURL - provide a custom base url to the sendgrid client.

func String 

func String(v string) *string

String is a helper routine that allocates a new string value to store v and returns a pointer to it.

Types

type APIKey added in v0.0.2 

type APIKey struct {
	ApiKeyId string `json:"api_key_id,omitempty"`
	Name     string `json:"name,omitempty"`
}

type ARecord added in v0.0.17 

type ARecord struct {
	Valid bool   `json:"valid,omitempty"`
	Type  string `json:"type,omitempty"`
	Host  string `json:"host,omitempty"`
	Data  string `json:"data,omitempty"`
}

type ARecordValidationResults added in v0.0.17 

type ARecordValidationResults struct {
	Valid  bool   `json:"valid,omitempty"`
	Reason string `json:"reason,omitempty"`
}

type ASM added in v1.6.0 

type ASM struct {
	GroupID         int   `json:"group_id"`
	GroupsToDisplay []int `json:"groups_to_display,omitempty"`
}

ASM represents Advanced Suppression Manager settings

type ASMSuppressionGroup added in v1.10.0 

type ASMSuppressionGroup struct {
	Description string `json:"description,omitempty"`
	ID          int64  `json:"id,omitempty"`
	IsDefault   bool   `json:"is_default,omitempty"`
	Name        string `json:"name,omitempty"`
	Suppressed  bool   `json:"suppressed,omitempty"`
}

type AccessActivity added in v1.10.0 

type AccessActivity struct {
	Allowed    bool   `json:"allowed,omitempty"`
	AuthMethod string `json:"auth_method,omitempty"`
	FirstAt    int64  `json:"first_at,omitempty"`
	IP         string `json:"ip,omitempty"`
	LastAt     int64  `json:"last_at,omitempty"`
	Location   string `json:"location,omitempty"`
}

type Alert added in v1.4.0 

type Alert struct {
	ID         int64  `json:"id,omitempty"`
	EmailTo    string `json:"email_to,omitempty"`
	Frequency  string `json:"frequency,omitempty"`
	Type       string `json:"type,omitempty"`
	Percentage int64  `json:"percentage,omitempty"`
	CreatedAt  int64  `json:"created_at,omitempty"`
	UpdatedAt  int64  `json:"updated_at,omitempty"`
}

type AllowListIP added in v1.10.0 

type AllowListIP struct {
	IP string `json:"ip,omitempty"`
}

type AllowedIP added in v1.10.0 

type AllowedIP struct {
	ID        int64  `json:"id,omitempty"`
	IP        string `json:"ip,omitempty"`
	CreatedAt int64  `json:"created_at,omitempty"`
	UpdatedAt int64  `json:"updated_at,omitempty"`
}

type Attachment added in v1.6.0 

type Attachment struct {
	Content     string `json:"content"`
	Type        string `json:"type,omitempty"`
	Filename    string `json:"filename"`
	Disposition string `json:"disposition,omitempty"`
	ContentID   string `json:"content_id,omitempty"`
}

Attachment represents an email attachment

type Block added in v1.6.0 

type Block struct {
	Created int64  `json:"created"`
	Email   string `json:"email"`
	Reason  string `json:"reason"`
}

Block represents a blocked email

type Bounce added in v1.6.0 

type Bounce struct {
	Created int64  `json:"created"`
	Email   string `json:"email"`
	Reason  string `json:"reason"`
	Status  string `json:"status"`
}

Bounce represents a bounced email 

type BrandedLink struct {
	ID        int64          `json:"id,omitempty"`
	Domain    string         `json:"domain,omitempty"`
	Subdomain string         `json:"subdomain,omitempty"`
	Username  string         `json:"username,omitempty"`
	UserID    int64          `json:"user_id,omitempty"`
	Default   bool           `json:"default,omitempty"`
	Valid     bool           `json:"valid,omitempty"`
	Legacy    bool           `json:"legacy,omitempty"`
	DNS       DNSBrandedLink `json:"dns,omitempty"`
}

type CategoryStat added in v1.6.0 

type CategoryStat struct {
	Date  string     `json:"date,omitempty"`
	Stats []StatItem `json:"stats,omitempty"`
}

CategoryStat represents category statistics

type ClickTrackingSetting added in v1.6.0 

type ClickTrackingSetting struct {
	Enable     *bool `json:"enable,omitempty"`
	EnableText *bool `json:"enable_text,omitempty"`
}

ClickTrackingSetting represents click tracking settings

type Client 

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

Client : sendgrid client

func New 

func New(apiKey string, options ...Option) *Client

New builds a sendgrid client from the provided token, baseURL and options

func (*Client) ActivateTemplateVersion added in v0.0.14 

func (c *Client) ActivateTemplateVersion(ctx context.Context, templateID, versionID string) (*OutputActivateTemplateVersion, error)

see: https://docs.sendgrid.com/api-reference/transactional-templates-versions/activate-a-transactional-template-version

func (*Client) AddIPToAuthenticatedDomain added in v0.0.6 

func (c *Client) AddIPToAuthenticatedDomain(ctx context.Context, domainId int64, input *InputAddIPToAuthenticatedDomain) (*OutputAddIPToAuthenticatedDomain, error)

NOTE: The 'dns' key in the API response for adding an IP to the authenticated domain is different from what is documented. see: https://docs.sendgrid.com/api-reference/domain-authentication/add-an-ip-to-an-authenticated-domain#responses

func (*Client) AddIPToPool added in v1.6.0 

func (c *Client) AddIPToPool(ctx context.Context, poolName, ip string) error

AddIPToPool adds an IP address to a pool see: https://www.twilio.com/docs/sendgrid/api-reference/ip-pools/add-an-ip-address-to-a-pool

func (*Client) AddIPsToAllowList added in v1.10.0 

func (c *Client) AddIPsToAllowList(ctx context.Context, input *InputAddIPsToAllowList) (*OutputAddIPsToAllowList, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/ip-access-management/add-one-or-more-ips-to-the-allow-list

func (*Client) AddOptions 

func (c *Client) AddOptions(s string, opts interface{}) (string, error)

AddOptions adds the parameters in opt as URL query parameters to s. opt must be a struct whose fields may contain "url" tags.

func (*Client) AddOrUpdateContacts added in v1.10.0 

func (c *Client) AddOrUpdateContacts(ctx context.Context, input *InputAddOrUpdateContacts) (*OutputAddOrUpdateContacts, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/add-or-update-a-contact

func (*Client) AddRecipientAddressesToGlobalSuppressions added in v1.10.0 

func (c *Client) AddRecipientAddressesToGlobalSuppressions(ctx context.Context, input *InputAddRecipientAddressesToGlobalSuppressions) (*OutputAddRecipientAddressesToGlobalSuppressions, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/suppressions-global-suppressions/add-recipient-addresses-to-the-global-suppression-group

func (*Client) AddSuppressionsToGroup added in v1.10.0 

func (c *Client) AddSuppressionsToGroup(ctx context.Context, groupID int64, input *InputAddSuppressionsToGroup) (*OutputAddSuppressionsToGroup, error)

see: https://docs.sendgrid.com/api-reference/suppressions-suppressions/add-suppressions-to-a-suppression-group

func (*Client) AssociateAuthenticatedDomainWithSubuser added in v0.0.6 

func (c *Client) AssociateAuthenticatedDomainWithSubuser(ctx context.Context, domainId int64, input *InputAssociateAuthenticatedDomainWithSubuser) (*OutputAssociateAuthenticatedDomainWithSubuser, error)

func (*Client) AssociateBrandedLinkWithSubuser added in v0.0.7 

func (c *Client) AssociateBrandedLinkWithSubuser(ctx context.Context, id int64, input *InputAssociateBrandedLinkWithSubuser) (*OutputAssociateBrandedLinkWithSubuser, error)

func (*Client) AuthenticateDomain added in v0.0.6 

func (c *Client) AuthenticateDomain(ctx context.Context, input *InputAuthenticateDomain) (*OutputAuthenticateDomain, error)

func (*Client) CancelOrPauseScheduledSend added in v1.10.0 

func (c *Client) CancelOrPauseScheduledSend(ctx context.Context, batchID string) (*OutputCancelOrPauseScheduledSend, error)

see: https://docs.sendgrid.com/api-reference/cancel-scheduled-sends/delete-a-cancellation-or-pause-of-a-scheduled-send

func (*Client) CompletedStepsVerifiedSender added in v0.0.10 

func (c *Client) CompletedStepsVerifiedSender(ctx context.Context) (*CompletedStepsVerifiedSender, error)

func (*Client) CreateAPIKey added in v0.0.2 

func (c *Client) CreateAPIKey(ctx context.Context, input *InputCreateAPIKey) (*OutputCreateAPIKey, error)

func (*Client) CreateAlert added in v1.4.0 

func (c *Client) CreateAlert(ctx context.Context, input *InputCreateAlert) (*OutputCreateAlert, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/alerts/create-a-new-alert

func (*Client) CreateBatchID added in v1.10.0 

func (c *Client) CreateBatchID(ctx context.Context) (*OutputCreateBatchID, error)

see: https://docs.sendgrid.com/api-reference/cancel-scheduled-sends/create-a-batch-id 

func (c *Client) CreateBrandedLink(ctx context.Context, input *InputCreateBrandedLink) (*OutputCreateBrandedLink, error)

func (*Client) CreateDesign added in v1.0.3 

func (c *Client) CreateDesign(ctx context.Context, input *InputCreateDesign) (*OutputCreateDesign, error)

see: https://docs.sendgrid.com/api-reference/designs-api/create-design

func (*Client) CreateEventWebhook added in v1.0.2 

func (c *Client) CreateEventWebhook(ctx context.Context, input *InputCreateEventWebhook) (*OutputCreateEventWebhook, error)

see: https://docs.sendgrid.com/api-reference/webhooks/create-an-event-webhook

func (*Client) CreateIPPool added in v1.6.0 

func (c *Client) CreateIPPool(ctx context.Context, name string) (*IPPool, error)

CreateIPPool creates an IP pool see: https://www.twilio.com/docs/sendgrid/api-reference/ip-pools/create-an-ip-pool

func (*Client) CreateInboundParseWebhook added in v1.1.1 

func (c *Client) CreateInboundParseWebhook(ctx context.Context, input *InputCreateInboundParseWebhook) (*OutputCreateInboundParseWebhook, error)

see: https://docs.sendgrid.com/api-reference/settings-inbound-parse/create-a-parse-setting

func (*Client) CreateReverseDNS added in v0.0.17 

func (c *Client) CreateReverseDNS(ctx context.Context, input *InputCreateReverseDNS) (*OutputCreateReverseDNS, error)

see: https://docs.sendgrid.com/api-reference/reverse-dns/set-up-reverse-dns

func (*Client) CreateSSOCertificate added in v0.0.20 

func (c *Client) CreateSSOCertificate(ctx context.Context, input *InputCreateSSOCertificate) (*OutputCreateSSOCertificate, error)

func (*Client) CreateSSOIntegration added in v0.0.19 

func (c *Client) CreateSSOIntegration(ctx context.Context, input *InputCreateSSOIntegration) (*OutputCreateSSOIntegration, error)

see: https://docs.sendgrid.com/api-reference/single-sign-on-settings/create-an-sso-integration

func (*Client) CreateSSOTeammate added in v1.2.0 

func (c *Client) CreateSSOTeammate(ctx context.Context, input *InputCreateSSOTeammate) (*OutputCreateSSOTeammate, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/single-sign-on-teammates/create-sso-teammate

func (*Client) CreateSubuser added in v0.0.3 

func (c *Client) CreateSubuser(ctx context.Context, input *InputCreateSubuser) (*OutputCreateSubuser, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/subusers-api/create-subuser

func (*Client) CreateSuppressionGroup added in v0.0.13 

func (c *Client) CreateSuppressionGroup(ctx context.Context, input *InputCreateSuppressionGroup) (*OutputCreateSuppressionGroup, error)

see: https://docs.sendgrid.com/api-reference/suppressions-unsubscribe-groups/create-a-new-suppression-group

func (*Client) CreateTemplate added in v0.0.14 

func (c *Client) CreateTemplate(ctx context.Context, input *InputCreateTemplate) (*OutputCreateTemplate, error)

see: https://docs.sendgrid.com/api-reference/transactional-templates/create-a-transactional-template

func (*Client) CreateTemplateVersion added in v0.0.14 

func (c *Client) CreateTemplateVersion(ctx context.Context, templateID string, input *InputCreateTemplateVersion) (*OutputCreateTemplateVersion, error)

see: https://docs.sendgrid.com/api-reference/transactional-templates-versions/create-a-new-transactional-template-version

func (*Client) CreateVerifiedSenderRequest added in v0.0.10 

func (c *Client) CreateVerifiedSenderRequest(ctx context.Context, input *InputCreateVerifiedSenderRequest) (*OutputCreateVerifiedSenderRequest, error)

func (*Client) Debug 

func (c *Client) Debug() bool

Debug returns if debug is enabled.

func (*Client) Debugf 

func (c *Client) Debugf(format string, v ...interface{})

Debugf print a formatted debug line.

func (*Client) Debugln 

func (c *Client) Debugln(v ...interface{})

Debugln print a debug line.

func (*Client) DeleteAPIKey added in v0.0.2 

func (c *Client) DeleteAPIKey(ctx context.Context, apiKeyId string) error

func (*Client) DeleteAlert added in v1.4.0 

func (c *Client) DeleteAlert(ctx context.Context, id int64) error

see: https://www.twilio.com/docs/sendgrid/api-reference/alerts/delete-an-alert

func (*Client) DeleteAuthenticatedDomain added in v0.0.6 

func (c *Client) DeleteAuthenticatedDomain(ctx context.Context, domainId int64) error

func (*Client) DeleteBlock added in v1.6.0 

func (c *Client) DeleteBlock(ctx context.Context, email string) error

DeleteBlock deletes a specific block see: https://www.twilio.com/docs/sendgrid/api-reference/blocks/delete-a-specific-block

func (*Client) DeleteBlocks added in v1.6.0 

func (c *Client) DeleteBlocks(ctx context.Context, input *InputDeleteSuppressions) error

DeleteBlocks deletes blocks see: https://www.twilio.com/docs/sendgrid/api-reference/blocks/delete-blocks

func (*Client) DeleteBounce added in v1.6.0 

func (c *Client) DeleteBounce(ctx context.Context, email string) error

DeleteBounce deletes a specific bounce see: https://www.twilio.com/docs/sendgrid/api-reference/bounces/delete-a-bounce

func (*Client) DeleteBounces added in v1.6.0 

func (c *Client) DeleteBounces(ctx context.Context, input *InputDeleteSuppressions) error

DeleteBounces deletes bounces see: https://www.twilio.com/docs/sendgrid/api-reference/bounces/delete-bounces 

func (c *Client) DeleteBrandedLink(ctx context.Context, id int64) error

func (*Client) DeleteContactIdentifier added in v1.10.0 

func (c *Client) DeleteContactIdentifier(ctx context.Context, contactID string, input *InputDeleteContactIdentifier) (*OutputDeleteContactIdentifier, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/delete-a-contact-identifier

func (*Client) DeleteContacts added in v1.10.0 

func (c *Client) DeleteContacts(ctx context.Context, input *InputDeleteContacts) (*OutputDeleteContacts, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/delete-contacts

func (*Client) DeleteDesign added in v1.0.3 

func (c *Client) DeleteDesign(ctx context.Context, id string) error

see: https://docs.sendgrid.com/api-reference/designs-api/delete-design

func (*Client) DeleteEventWebhook added in v1.0.2 

func (c *Client) DeleteEventWebhook(ctx context.Context, id string) error

see: https://docs.sendgrid.com/api-reference/webhooks/delete-an-event-webhook

func (*Client) DeleteGlobalSuppression added in v1.10.0 

func (c *Client) DeleteGlobalSuppression(ctx context.Context, email string) error

see: https://www.twilio.com/docs/sendgrid/api-reference/suppressions-global-suppressions/delete-a-global-suppression

func (*Client) DeleteIPPool added in v1.6.0 

func (c *Client) DeleteIPPool(ctx context.Context, name string) error

DeleteIPPool deletes an IP pool see: https://www.twilio.com/docs/sendgrid/api-reference/ip-pools/delete-an-ip-pool

func (*Client) DeleteInboundParseWebhook added in v1.1.1 

func (c *Client) DeleteInboundParseWebhook(ctx context.Context, hostname string) error

see: https://docs.sendgrid.com/api-reference/settings-inbound-parse/delete-a-parse-setting

func (*Client) DeleteInvalidEmail added in v1.6.0 

func (c *Client) DeleteInvalidEmail(ctx context.Context, email string) error

DeleteInvalidEmail deletes a specific invalid email see: https://www.twilio.com/docs/sendgrid/api-reference/invalid-emails/delete-a-specific-invalid-email

func (*Client) DeleteInvalidEmails added in v1.6.0 

func (c *Client) DeleteInvalidEmails(ctx context.Context, input *InputDeleteSuppressions) error

DeleteInvalidEmails deletes invalid emails see: https://www.twilio.com/docs/sendgrid/api-reference/invalid-emails/delete-invalid-emails

func (*Client) DeletePendingTeammate 

func (c *Client) DeletePendingTeammate(ctx context.Context, token string) error

func (*Client) DeleteReverseDNS added in v0.0.17 

func (c *Client) DeleteReverseDNS(ctx context.Context, id int64) error

see: https://docs.sendgrid.com/api-reference/reverse-dns/delete-a-reverse-dns-record

func (*Client) DeleteSSOCertificate added in v0.0.19 

func (c *Client) DeleteSSOCertificate(ctx context.Context, id int64) error

see: https://docs.sendgrid.com/api-reference/certificates/delete-an-sso-certificate

func (*Client) DeleteSSOIntegration added in v0.0.19 

func (c *Client) DeleteSSOIntegration(ctx context.Context, id string) error

see: https://docs.sendgrid.com/api-reference/single-sign-on-settings/delete-an-sso-integration

func (*Client) DeleteScheduledSend added in v1.10.0 

func (c *Client) DeleteScheduledSend(ctx context.Context, batchID string) error

see: https://www.twilio.com/docs/sendgrid/api-reference/cancel-scheduled-sends/cancel-or-pause-a-scheduled-send

func (*Client) DeleteSpamReport added in v1.6.0 

func (c *Client) DeleteSpamReport(ctx context.Context, email string) error

DeleteSpamReport deletes a specific spam report see: https://www.twilio.com/docs/sendgrid/api-reference/spam-reports/delete-a-specific-spam-report

func (*Client) DeleteSpamReports added in v1.6.0 

func (c *Client) DeleteSpamReports(ctx context.Context, input *InputDeleteSuppressions) error

DeleteSpamReports deletes spam reports see: https://www.twilio.com/docs/sendgrid/api-reference/spam-reports/delete-spam-reports

func (*Client) DeleteSubuser added in v0.0.3 

func (c *Client) DeleteSubuser(ctx context.Context, username string) error

see: https://www.twilio.com/docs/sendgrid/api-reference/subusers-api/delete-a-subuser

func (*Client) DeleteSuppressionFromGroup added in v1.10.0 

func (c *Client) DeleteSuppressionFromGroup(ctx context.Context, groupID, email string) error

func (*Client) DeleteSuppressionGroup added in v0.0.13 

func (c *Client) DeleteSuppressionGroup(ctx context.Context, id int64) error

see: https://docs.sendgrid.com/api-reference/suppressions-unsubscribe-groups/delete-a-suppression-group

func (*Client) DeleteTeammate 

func (c *Client) DeleteTeammate(ctx context.Context, username string) error

func (*Client) DeleteTemplate added in v0.0.14 

func (c *Client) DeleteTemplate(ctx context.Context, id string) error

see: https://docs.sendgrid.com/api-reference/transactional-templates/delete-a-template

func (*Client) DeleteTemplateVersion added in v0.0.14 

func (c *Client) DeleteTemplateVersion(ctx context.Context, templateID, versionID string) error

see: https://docs.sendgrid.com/api-reference/transactional-templates-versions/delete-a-transactional-template-version

func (*Client) DeleteVerifiedSender added in v0.0.10 

func (c *Client) DeleteVerifiedSender(ctx context.Context, id int64) error

func (*Client) DisassociateAuthenticatedDomainFromSubuser added in v0.0.6 

func (c *Client) DisassociateAuthenticatedDomainFromSubuser(ctx context.Context, subuserName string) error

func (*Client) DisassociateBrandedLinkWithSubuser added in v0.0.7 

func (c *Client) DisassociateBrandedLinkWithSubuser(ctx context.Context, username string) error

func (*Client) Do 

func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) error

Do sends an API request and returns the API response. The API response is JSON decoded and stored in the value pointed to by v, or returned as an error if an API error has occurred. If v implements the io.Writer interface, the raw response body will be written to v, without attempting to first decode it. If rate limit is exceeded and reset time is in the future, Do returns *RateLimitError immediately without making a network API call.

The provided ctx must be non-nil, if it is nil an error is returned. If it is canceled or times out, ctx.Err() will be returned.

func (*Client) DuplicateDesign added in v1.10.0 

func (c *Client) DuplicateDesign(ctx context.Context, id string, input *InputDuplicateDesign) (*OutputDuplicateDesign, error)

see: https://docs.sendgrid.com/api-reference/designs-api/duplicate-design

func (*Client) DuplicateTemplate added in v0.0.14 

func (c *Client) DuplicateTemplate(ctx context.Context, id string, input *InputDuplicateTemplate) (*OutputDuplicateTemplate, error)

see: https://docs.sendgrid.com/api-reference/transactional-templates/duplicate-a-transactional-template

func (*Client) ExportContacts added in v1.10.0 

func (c *Client) ExportContacts(ctx context.Context, input *InputExportContacts) (*OutputExportContacts, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/export-contacts

func (*Client) GetAPIKey added in v0.0.2 

func (c *Client) GetAPIKey(ctx context.Context, apiKeyId string) (*OutputGetAPIKey, error)

func (*Client) GetAPIKeys added in v0.0.2 

func (c *Client) GetAPIKeys(ctx context.Context) (*OutputGetAPIKeys, error)

func (*Client) GetAccessActivities added in v1.10.0 

func (c *Client) GetAccessActivities(ctx context.Context, input *InputGetAccessActivities) (*OutputGetAccessActivities, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/ip-access-management/retrieve-all-recent-access-attempts

func (*Client) GetAlert added in v1.4.0 

func (c *Client) GetAlert(ctx context.Context, id int64) (*OutputGetAlert, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/alerts/retrieve-a-specific-alert

func (*Client) GetAlerts added in v1.4.0 

func (c *Client) GetAlerts(ctx context.Context) ([]*Alert, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/alerts/retrieve-all-alerts

func (*Client) GetAllExistingExports added in v1.10.0 

func (c *Client) GetAllExistingExports(ctx context.Context) (*OutputGetAllExistingExports, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/get-all-existing-exports

func (*Client) GetAllIPWarmupStatus added in v1.6.0 

func (c *Client) GetAllIPWarmupStatus(ctx context.Context) ([]IPWarmupStatus, error)

GetAllIPWarmupStatus retrieves all IP warmup statuses see: https://www.twilio.com/docs/sendgrid/api-reference/ip-warmup/retrieve-all-ip-warmup-statuses

func (*Client) GetAllowedIP added in v1.10.0 

func (c *Client) GetAllowedIP(ctx context.Context, ruleID int64) (*OutputGetAllowedIP, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/ip-access-management/retrieve-a-specific-allowed-ip

func (*Client) GetAllowedIPs added in v1.10.0 

func (c *Client) GetAllowedIPs(ctx context.Context) (*OutputGetAllowedIPs, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/ip-access-management/retrieve-a-list-of-currently-allowed-ips

func (*Client) GetAssignedIPAddresses added in v1.6.0 

func (c *Client) GetAssignedIPAddresses(ctx context.Context) ([]IPAddress, error)

GetAssignedIPAddresses retrieves all assigned IP addresses see: https://www.twilio.com/docs/sendgrid/api-reference/ip-addresses/retrieve-all-assigned-ips

func (*Client) GetAuthenticatedDomain added in v0.0.6 

func (c *Client) GetAuthenticatedDomain(ctx context.Context, domainId int64) (*OutputGetAuthenticatedDomain, error)

func (*Client) GetAuthenticatedDomainAssociatedWithSubuser added in v0.0.6 

func (c *Client) GetAuthenticatedDomainAssociatedWithSubuser(ctx context.Context, subuserName string) (*OutputGetAuthenticatedDomainAssociatedWithSubuser, error)

func (*Client) GetAuthenticatedDomains added in v0.0.6 

func (c *Client) GetAuthenticatedDomains(ctx context.Context, input *InputGetAuthenticatedDomains) ([]*DomainAuthentication, error)

func (*Client) GetBatchedContactsByIDs added in v1.10.0 

func (c *Client) GetBatchedContactsByIDs(ctx context.Context, input *InputGetBatchedContactsByIDs) (*OutputGetBatchedContactsByIDs, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/get-batched-contacts-by-ids

func (*Client) GetBlock added in v1.6.0 

func (c *Client) GetBlock(ctx context.Context, email string) (*Block, error)

GetBlock retrieves a specific block see: https://www.twilio.com/docs/sendgrid/api-reference/blocks/retrieve-a-specific-block

func (*Client) GetBlocks added in v1.6.0 

func (c *Client) GetBlocks(ctx context.Context, opts *SuppressionListOptions) ([]Block, error)

GetBlocks retrieves all blocks see: https://www.twilio.com/docs/sendgrid/api-reference/blocks/retrieve-all-blocks

func (*Client) GetBounce added in v1.6.0 

func (c *Client) GetBounce(ctx context.Context, email string) (*Bounce, error)

GetBounce retrieves a specific bounce see: https://www.twilio.com/docs/sendgrid/api-reference/bounces/retrieve-a-bounce

func (*Client) GetBounceSettings added in v1.8.0 

func (c *Client) GetBounceSettings(ctx context.Context) (*OutputGetBounceSettings, error)

see: https://docs.sendgrid.com/api-reference/bounces/remove-bounces

func (*Client) GetBounces added in v1.6.0 

func (c *Client) GetBounces(ctx context.Context, opts *SuppressionListOptions) ([]Bounce, error)

GetBounces retrieves all bounces see: https://www.twilio.com/docs/sendgrid/api-reference/bounces/retrieve-all-bounces 

func (c *Client) GetBrandedLink(ctx context.Context, id int64) (*OutputGetBrandedLink, error)
func (c *Client) GetBrandedLinks(ctx context.Context, input *InputGetBrandedLinks) ([]*BrandedLink, error)

func (*Client) GetCategoryStats added in v1.6.0 

func (c *Client) GetCategoryStats(ctx context.Context, categories []string, opts *StatsOptions) ([]CategoryStat, error)

GetCategoryStats retrieves category email statistics see: https://www.twilio.com/docs/sendgrid/api-reference/categories-statistics/retrieve-email-statistics-for-categories

func (*Client) GetCategorySums added in v1.6.0 

func (c *Client) GetCategorySums(ctx context.Context, opts *StatsOptions) ([]CategoryStat, error)

GetCategorySums retrieves category sums see: https://www.twilio.com/docs/sendgrid/api-reference/categories-statistics/retrieve-sums-of-email-stats-for-each-category

func (*Client) GetClickTrackingSettings added in v0.0.18 

func (c *Client) GetClickTrackingSettings(ctx context.Context) (*OutputGetClickTrackingSettings, error)

see: https://docs.sendgrid.com/api-reference/settings-tracking/retrieve-click-track-settings

func (*Client) GetContact added in v1.10.0 

func (c *Client) GetContact(ctx context.Context, id string) (*OutputGetContact, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/get-a-contact-by-id

func (*Client) GetContactsByEmails added in v1.10.0 

func (c *Client) GetContactsByEmails(ctx context.Context, input *InputGetContactsByEmails) (*OutputGetContactsByEmails, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/get-contacts-by-emails

func (*Client) GetContactsByIdentifiers added in v1.10.0 

func (c *Client) GetContactsByIdentifiers(ctx context.Context, identifierType string, input *InputGetContactsByIdentifiers) (*OutputGetContactsByIdentifiers, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/get-contacts-by-identifiers

func (*Client) GetDefaultAuthentication added in v0.0.6 

func (c *Client) GetDefaultAuthentication(ctx context.Context, input *InputGetDefaultAuthentication) (*OutputGetDefaultAuthentication, error)
func (c *Client) GetDefaultBrandedLink(ctx context.Context) (*OutputGetDefaultBrandedLink, error)

func (*Client) GetDesign added in v1.0.3 

func (c *Client) GetDesign(ctx context.Context, id string) (*OutputGetDesign, error)

see: https://docs.sendgrid.com/api-reference/designs-api/get-design

func (*Client) GetDesigns added in v1.0.3 

func (c *Client) GetDesigns(ctx context.Context, input *InputGetDesigns) (*OutputGetDesigns, error)

see: https://docs.sendgrid.com/api-reference/designs-api/list-designs

func (*Client) GetEnforceTLS added in v0.0.15 

func (c *Client) GetEnforceTLS(ctx context.Context) (*OutputGetEnforceTLS, error)

see: https://docs.sendgrid.com/api-reference/settings-enforced-tls/retrieve-current-enforced-tls-settings

func (*Client) GetEventWebhook added in v1.0.2 

func (c *Client) GetEventWebhook(ctx context.Context, id string) (*OutputGetEventWebhook, error)

see: https://docs.sendgrid.com/api-reference/webhooks/get-an-event-webhook

func (*Client) GetEventWebhooks added in v1.0.2 

func (c *Client) GetEventWebhooks(ctx context.Context) (*OutputGetEventWebhooks, error)

https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks

func (*Client) GetExportContactsStatus added in v1.10.0 

func (c *Client) GetExportContactsStatus(ctx context.Context, id string) (*OutputGetExportContactsStatus, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/export-contacts-status

func (*Client) GetGlobalStats added in v1.6.0 

func (c *Client) GetGlobalStats(ctx context.Context, opts *StatsOptions) ([]GlobalStat, error)

GetGlobalStats retrieves global email statistics see: https://www.twilio.com/docs/sendgrid/api-reference/stats/retrieve-global-email-statistics

func (*Client) GetGlobalSuppression added in v1.10.0 

func (c *Client) GetGlobalSuppression(ctx context.Context, email string) (*OutputGetGlobalSuppression, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/suppressions-global-suppressions/retrieve-a-global-suppression

func (*Client) GetGlobalSuppressions added in v1.10.0 

func (c *Client) GetGlobalSuppressions(ctx context.Context, input *InputGetGlobalSuppressions) ([]*GlobalUnsubscribe, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/suppressions-global-suppressions/retrieve-all-global-suppressions

func (*Client) GetGoogleAnalyticsSettings added in v0.0.18 

func (c *Client) GetGoogleAnalyticsSettings(ctx context.Context) (*OutputGetGoogleAnalyticsSettings, error)

see: https://docs.sendgrid.com/api-reference/settings-tracking/retrieve-google-analytics-settings

func (*Client) GetIPAddress added in v1.6.0 

func (c *Client) GetIPAddress(ctx context.Context, ip string) (*IPAddress, error)

GetIPAddress retrieves a specific IP address see: https://www.twilio.com/docs/sendgrid/api-reference/ip-addresses/retrieve-an-ip-address

func (*Client) GetIPAddresses added in v1.6.0 

func (c *Client) GetIPAddresses(ctx context.Context) ([]IPAddress, error)

GetIPAddresses retrieves all IP addresses see: https://www.twilio.com/docs/sendgrid/api-reference/ip-addresses/retrieve-all-ip-addresses

func (*Client) GetIPPool added in v1.6.0 

func (c *Client) GetIPPool(ctx context.Context, name string) (*IPPool, error)

GetIPPool retrieves a specific IP pool see: https://www.twilio.com/docs/sendgrid/api-reference/ip-pools/retrieve-an-ip-pool

func (*Client) GetIPPools added in v1.6.0 

func (c *Client) GetIPPools(ctx context.Context) ([]IPPool, error)

GetIPPools retrieves all IP pools see: https://www.twilio.com/docs/sendgrid/api-reference/ip-pools/retrieve-all-ip-pools

func (*Client) GetIPWarmupStatus added in v1.6.0 

func (c *Client) GetIPWarmupStatus(ctx context.Context, ip string) (*IPWarmupStatus, error)

GetIPWarmupStatus retrieves IP warmup status see: https://www.twilio.com/docs/sendgrid/api-reference/ip-warmup/retrieve-ip-warmup-status

func (*Client) GetImportContactsStatus added in v1.10.0 

func (c *Client) GetImportContactsStatus(ctx context.Context, id string) (*OutputGetImportContactsStatus, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/import-contacts-status

func (*Client) GetInboundParseWebhook added in v1.1.1 

func (c *Client) GetInboundParseWebhook(ctx context.Context, hostname string) (*OutputGetInboundParseWebhook, error)

see: https://docs.sendgrid.com/api-reference/settings-inbound-parse/retrieve-a-specific-parse-setting

func (*Client) GetInboundParseWebhooks added in v1.1.1 

func (c *Client) GetInboundParseWebhooks(ctx context.Context) ([]*InboundParseWebhook, error)

see: https://docs.sendgrid.com/api-reference/settings-inbound-parse/retrieve-all-parse-settings

func (*Client) GetInvalidEmail added in v1.6.0 

func (c *Client) GetInvalidEmail(ctx context.Context, email string) (*InvalidEmail, error)

GetInvalidEmail retrieves a specific invalid email see: https://www.twilio.com/docs/sendgrid/api-reference/invalid-emails/retrieve-an-invalid-email

func (*Client) GetInvalidEmails added in v1.6.0 

func (c *Client) GetInvalidEmails(ctx context.Context, opts *SuppressionListOptions) ([]InvalidEmail, error)

GetInvalidEmails retrieves all invalid emails see: https://www.twilio.com/docs/sendgrid/api-reference/invalid-emails/retrieve-all-invalid-emails

func (*Client) GetOpenTrackingSettings added in v0.0.18 

func (c *Client) GetOpenTrackingSettings(ctx context.Context) (*OutputGetOpenTrackingSettings, error)

see: https://docs.sendgrid.com/api-reference/settings-tracking/get-open-tracking-settings

func (*Client) GetPendingTeammates 

func (c *Client) GetPendingTeammates(ctx context.Context) (*OutputGetPendingTeammates, error)

func (*Client) GetPreBuiltDesigns added in v1.10.0 

func (c *Client) GetPreBuiltDesigns(ctx context.Context, input *InputGetPreBuiltDesigns) (*OutputGetPreBuiltDesigns, error)

see: https://docs.sendgrid.com/api-reference/designs-api/list-sendgrid-pre-built-designs

func (*Client) GetRemainingIPCount added in v1.6.0 

func (c *Client) GetRemainingIPCount(ctx context.Context) (map[string]interface{}, error)

GetRemainingIPCount retrieves remaining IP count see: https://www.twilio.com/docs/sendgrid/api-reference/ip-addresses/retrieve-remaining-ip-count

func (*Client) GetReverseDNS added in v0.0.17 

func (c *Client) GetReverseDNS(ctx context.Context, id int64) (*OutputGetReverseDNS, error)

see: https://docs.sendgrid.com/api-reference/reverse-dns/retrieve-a-reverse-dns-record

func (*Client) GetReverseDNSs added in v0.0.17 

func (c *Client) GetReverseDNSs(ctx context.Context, input *InputGetReverseDNSs) ([]*OutputGetReverseDNS, error)

see: https://docs.sendgrid.com/api-reference/reverse-dns/retrieve-all-reverse-dns-records

func (*Client) GetSSOCertificate added in v0.0.19 

func (c *Client) GetSSOCertificate(ctx context.Context, id int64) (*OutputGetSSOCertificate, error)

see: https://docs.sendgrid.com/api-reference/certificates/get-an-sso-certificate

func (*Client) GetSSOCertificates added in v0.0.19 

func (c *Client) GetSSOCertificates(ctx context.Context, integrationID string) ([]*SSOCertificate, error)

see: https://docs.sendgrid.com/api-reference/certificates/get-all-sso-certificates-by-integration

func (*Client) GetSSOIntegration added in v0.0.19 

func (c *Client) GetSSOIntegration(ctx context.Context, id string) (*OutputGetSSOIntegration, error)

see: https://docs.sendgrid.com/api-reference/single-sign-on-settings/get-an-sso-integration

func (*Client) GetSSOIntegrations added in v0.0.19 

func (c *Client) GetSSOIntegrations(ctx context.Context, input *InputGetSSOIntegrations) ([]*SSOIntegration, error)

see: https://docs.sendgrid.com/api-reference/single-sign-on-settings/get-all-sso-integrations

func (*Client) GetSampleContacts added in v1.10.0 

func (c *Client) GetSampleContacts(ctx context.Context) (*OutputGetSampleContacts, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/get-sample-contacts

func (*Client) GetScheduledSend added in v1.10.0 

func (c *Client) GetScheduledSend(ctx context.Context, batchID string) (*OutputGetScheduledSend, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/cancel-scheduled-sends/retrieve-scheduled-send

func (*Client) GetScheduledSends added in v1.10.0 

func (c *Client) GetScheduledSends(ctx context.Context) ([]*ScheduledSend, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/cancel-scheduled-sends/retrieve-all-scheduled-sends

func (*Client) GetSenderVerificationDomainWarnList added in v0.0.10 

func (c *Client) GetSenderVerificationDomainWarnList(ctx context.Context) (*CompletedStepsVerifiedSender, error)

see: https://docs.sendgrid.com/api-reference/sender-verification/domain-warn-list This endpoint returns a list of domains known to implement DMARC and categorizes them by failure type — hard failure or soft failure. Domains listed as hard failures will not deliver mail when used as a Sender Identity due to the domain's DMARC policy settings.

func (*Client) GetSignedEventWebhooksPublicKey added in v1.7.0 

func (c *Client) GetSignedEventWebhooksPublicKey(ctx context.Context, id string) (*OutputGetSignedEventWebhooksPublicKey, error)

see: https://docs.sendgrid.com/api-reference/webhooks/get-signed-event-webhooks-public-key

func (*Client) GetSpamReport added in v1.6.0 

func (c *Client) GetSpamReport(ctx context.Context, email string) (*SpamReport, error)

GetSpamReport retrieves a specific spam report see: https://www.twilio.com/docs/sendgrid/api-reference/spam-reports/retrieve-a-specific-spam-report

func (*Client) GetSpamReports added in v1.6.0 

func (c *Client) GetSpamReports(ctx context.Context, opts *SuppressionListOptions) ([]SpamReport, error)

GetSpamReports retrieves all spam reports see: https://www.twilio.com/docs/sendgrid/api-reference/spam-reports/retrieve-all-spam-reports

func (*Client) GetSubscriptionTrackingSettings added in v0.0.18 

func (c *Client) GetSubscriptionTrackingSettings(ctx context.Context) (*OutputGetSubscriptionTrackingSettings, error)

see: https://docs.sendgrid.com/api-reference/settings-tracking/retrieve-subscription-tracking-settings

func (*Client) GetSubuser added in v1.9.0 

func (c *Client) GetSubuser(ctx context.Context, username string) (*Subuser, error)

document link not found 

func (c *Client) GetSubuserBrandedLink(ctx context.Context, subuser string) (*OutputGetSubuserBrandedLink, error)

func (*Client) GetSubuserMonthlyStats added in v1.6.0 

func (c *Client) GetSubuserMonthlyStats(ctx context.Context, opts *StatsOptions) ([]SubuserStat, error)

GetSubuserMonthlyStats retrieves monthly subuser statistics see: https://www.twilio.com/docs/sendgrid/api-reference/subuser-statistics/retrieve-monthly-stats-for-all-subusers

func (*Client) GetSubuserReputations added in v0.0.3 

func (c *Client) GetSubuserReputations(ctx context.Context, usernames string) ([]*Reputation, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/subusers-api/retrieve-subuser-reputations

func (*Client) GetSubuserStats added in v1.6.0 

func (c *Client) GetSubuserStats(ctx context.Context, subusers []string, opts *StatsOptions) ([]SubuserStat, error)

GetSubuserStats retrieves subuser email statistics see: https://www.twilio.com/docs/sendgrid/api-reference/subuser-statistics/retrieve-email-statistics-for-your-subusers

func (*Client) GetSubuserSums added in v1.6.0 

func (c *Client) GetSubuserSums(ctx context.Context, opts *StatsOptions) ([]SubuserStat, error)

GetSubuserSums retrieves subuser sums see: https://www.twilio.com/docs/sendgrid/api-reference/subuser-statistics/retrieve-sums-of-email-stats-for-each-subuser

func (*Client) GetSubusers added in v0.0.3 

func (c *Client) GetSubusers(ctx context.Context, input *InputGetSubusers) ([]*Subuser, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/subusers-api/list-all-subusers

func (*Client) GetSuppressionGroup added in v0.0.13 

func (c *Client) GetSuppressionGroup(ctx context.Context, id int64) (*SuppressionGroup, error)

see: https://docs.sendgrid.com/api-reference/suppressions-unsubscribe-groups/get-information-on-a-single-suppression-group

func (*Client) GetSuppressionGroups added in v0.0.13 

func (c *Client) GetSuppressionGroups(ctx context.Context) ([]*SuppressionGroup, error)

see: https://docs.sendgrid.com/api-reference/suppressions-unsubscribe-groups/retrieve-all-suppression-groups-associated-with-the-user

func (*Client) GetSuppressionGroupsByEmail added in v1.10.0 

func (c *Client) GetSuppressionGroupsByEmail(ctx context.Context, email string) (*OutputGetSuppressionGroupsByEmail, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/suppressions-suppressions/retrieve-all-suppression-groups-for-an-email-address

func (*Client) GetSuppressions added in v1.10.0 

func (c *Client) GetSuppressions(ctx context.Context) ([]*Suppression, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/suppressions-suppressions/retrieve-all-suppressions

func (*Client) GetSuppressionsForSuppressionGroup added in v1.10.0 

func (c *Client) GetSuppressionsForSuppressionGroup(ctx context.Context, groupID string) ([]string, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/suppressions-suppressions/retrieve-all-suppressions-for-a-suppression-group

func (*Client) GetTeammate 

func (c *Client) GetTeammate(ctx context.Context, username string) (*OutputGetTeammate, error)

func (*Client) GetTeammateSubuserAccess added in v1.3.0 

func (c *Client) GetTeammateSubuserAccess(ctx context.Context, teammateName string, input *InputGetTeammateSubuserAccess) (*OutputGetTeammateSubuserAccess, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/teammates/get-teammate-subuser-access

func (*Client) GetTeammates 

func (c *Client) GetTeammates(ctx context.Context, input *InputGetTeammates) (*OutputGetTeammates, error)

func (*Client) GetTemplate added in v0.0.14 

func (c *Client) GetTemplate(ctx context.Context, id string) (*OutputGetTemplate, error)

see: https://docs.sendgrid.com/api-reference/transactional-templates/retrieve-a-single-transactional-template

func (*Client) GetTemplateVersion added in v0.0.14 

func (c *Client) GetTemplateVersion(ctx context.Context, templateID, versionID string) (*OutputGetTemplateVersion, error)

see: https://docs.sendgrid.com/api-reference/transactional-templates-versions/retrieve-a-specific-transactional-template-version

func (*Client) GetTemplates added in v0.0.14 

func (c *Client) GetTemplates(ctx context.Context, input *InputGetTemplates) (*OutputGetTemplates, error)

see: https://docs.sendgrid.com/api-reference/transactional-templates/retrieve-paged-transactional-templates

func (*Client) GetTotalContactCount added in v1.10.0 

func (c *Client) GetTotalContactCount(ctx context.Context) (*OutputGetTotalContactCount, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/get-total-contact-count

func (*Client) GetTrackingSettings added in v0.0.18 

func (c *Client) GetTrackingSettings(ctx context.Context) (*OutputGetTrackingSettings, error)

see: https://docs.sendgrid.com/api-reference/settings-tracking/retrieve-tracking-settings

func (*Client) GetVerifiedSenders added in v0.0.10 

func (c *Client) GetVerifiedSenders(ctx context.Context, input *InputGetVerifiedSenders) ([]*VerifiedSender, error)

func (*Client) ImportContacts added in v1.10.0 

func (c *Client) ImportContacts(ctx context.Context, input *InputImportContacts) (*OutputImportContacts, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/import-contacts

func (*Client) InviteTeammate 

func (c *Client) InviteTeammate(ctx context.Context, input *InputInviteTeammate) (*OutputInviteTeammate, error)

func (*Client) NewRequest 

func (c *Client) NewRequest(method, urlStr string, body interface{}) (*http.Request, error)

NewRequest creates an API request. A relative URL can be provided in urlStr, in which case it is resolved relative to the BaseURL of the Client. Relative URLs should always be specified without a preceding slash. If specified, the value pointed to by body is JSON encoded and included as the request body.

func (*Client) RemoveIPFromAllowList added in v1.10.0 

func (c *Client) RemoveIPFromAllowList(ctx context.Context, ruleID int64) error

see: https://www.twilio.com/docs/sendgrid/api-reference/ip-access-management/remove-a-specific-ip-from-the-allowed-list

func (*Client) RemoveIPFromAuthenticatedDomain added in v0.0.6 

func (c *Client) RemoveIPFromAuthenticatedDomain(ctx context.Context, domainId int64, ip string) error

NOTE: The 'dns' key in the API response for removing an IP to the authenticated domain is different from what is documented. see: https://docs.sendgrid.com/api-reference/domain-authentication/remove-an-ip-from-an-authenticated-domain#responses

func (*Client) RemoveIPFromPool added in v1.6.0 

func (c *Client) RemoveIPFromPool(ctx context.Context, poolName, ip string) error

RemoveIPFromPool removes an IP address from a pool see: https://www.twilio.com/docs/sendgrid/api-reference/ip-pools/remove-an-ip-address-from-a-pool

func (*Client) RemoveIPsFromAllowList added in v1.10.0 

func (c *Client) RemoveIPsFromAllowList(ctx context.Context, input *InputRemoveIPsFromAllowList) error

see: https://www.twilio.com/docs/sendgrid/api-reference/ip-access-management/remove-one-or-more-ips-from-the-allow-list

func (*Client) ResendVerifiedSenderRequest added in v0.0.10 

func (c *Client) ResendVerifiedSenderRequest(ctx context.Context, id int64) error

func (*Client) SearchContacts added in v1.10.0 

func (c *Client) SearchContacts(ctx context.Context, input *InputSearchContacts) (*OutputSearchContacts, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/contacts/search-contacts

func (*Client) SearchForSuppressionsWithinGroup added in v1.10.0 

func (c *Client) SearchForSuppressionsWithinGroup(ctx context.Context, groupID string, input *InputSearchGroupSuppressions) ([]string, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/suppressions-suppressions/search-for-suppressions-within-a-group

func (*Client) SendMail added in v1.6.0 

func (c *Client) SendMail(ctx context.Context, input *InputSendMail) (*OutputSendMail, error)

SendMail sends an email using SendGrid's mail/send API see: https://www.twilio.com/docs/sendgrid/api-reference/mail-send/mail-send

func (*Client) StartIPWarmup added in v1.6.0 

func (c *Client) StartIPWarmup(ctx context.Context, ip string) (*IPWarmupStatus, error)

StartIPWarmup starts IP warmup process see: https://www.twilio.com/docs/sendgrid/api-reference/ip-warmup/start-ip-warmup

func (*Client) StopIPWarmup added in v1.6.0 

func (c *Client) StopIPWarmup(ctx context.Context, ip string) (*IPWarmupStatus, error)

StopIPWarmup stops IP warmup process see: https://www.twilio.com/docs/sendgrid/api-reference/ip-warmup/stop-ip-warmup

func (*Client) ToggleSignatureVerification added in v1.7.0 

func (c *Client) ToggleSignatureVerification(ctx context.Context, id string, input *InputToggleSignatureVerification) (*OutputToggleSignatureVerification, error)

see: https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook

func (*Client) UpdateAPIKeyName added in v0.0.2 

func (c *Client) UpdateAPIKeyName(ctx context.Context, apiKeyId string, input *InputUpdateAPIKeyName) (*OutputUpdateAPIKeyName, error)

func (*Client) UpdateAPIKeyNameAndScopes added in v0.0.2 

func (c *Client) UpdateAPIKeyNameAndScopes(ctx context.Context, apiKeyId string, input *InputUpdateAPIKeyNameAndScopes) (*OutputUpdateAPIKeyNameAndScopes, error)

func (*Client) UpdateAlert added in v1.4.0 

func (c *Client) UpdateAlert(ctx context.Context, id int64, input *InputUpdateAlert) (*OutputUpdateAlert, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/alerts/update-an-alert

func (*Client) UpdateBounceSettings added in v1.8.0 

func (c *Client) UpdateBounceSettings(ctx context.Context, input *InputUpdateBounceSettings) (*OutputUpdateBounceSettings, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/settings-mail/update-bounce-purge-mail-settings 

func (c *Client) UpdateBrandedLink(ctx context.Context, id int64, input *InputUpdateBrandedLink) (*OutputUpdateBrandedLink, error)

func (*Client) UpdateClickTrackingSettings added in v0.0.18 

func (c *Client) UpdateClickTrackingSettings(ctx context.Context, input *InputUpdateClickTrackingSettings) (*OutputUpdateClickTrackingSettings, error)

see: https://docs.sendgrid.com/api-reference/settings-tracking/update-click-tracking-settings

func (*Client) UpdateDesign added in v1.0.3 

func (c *Client) UpdateDesign(ctx context.Context, id string, input *InputUpdateDesign) (*OutputUpdateDesign, error)

see: https://docs.sendgrid.com/api-reference/designs-api/update-design

func (*Client) UpdateDomainAuthentication added in v0.0.6 

func (c *Client) UpdateDomainAuthentication(ctx context.Context, domainId int64, input *InputUpdateDomainAuthentication) (*OutputUpdateDomainAuthentication, error)

func (*Client) UpdateEnforceTLS added in v0.0.15 

func (c *Client) UpdateEnforceTLS(ctx context.Context, input *InputUpdateEnforceTLS) (*OutputUpdateEnforceTLS, error)

see: https://docs.sendgrid.com/api-reference/settings-enforced-tls/update-enforced-tls-settings

func (*Client) UpdateEventWebhook added in v1.0.2 

func (c *Client) UpdateEventWebhook(ctx context.Context, id string, input *InputUpdateEventWebhook) (*OutputUpdateEventWebhook, error)

see: https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook

func (*Client) UpdateGoogleAnalyticsSettings added in v0.0.18 

func (c *Client) UpdateGoogleAnalyticsSettings(ctx context.Context, input *InputUpdateGoogleAnalyticsSettings) (*OutputUpdateGoogleAnalyticsSettings, error)

see: https://docs.sendgrid.com/api-reference/settings-tracking/update-google-analytics-settings

func (*Client) UpdateIPPool added in v1.6.0 

func (c *Client) UpdateIPPool(ctx context.Context, oldName, newName string) (*IPPool, error)

UpdateIPPool updates an IP pool name see: https://www.twilio.com/docs/sendgrid/api-reference/ip-pools/update-an-ip-pool

func (*Client) UpdateInboundParseWebhook added in v1.1.1 

func (c *Client) UpdateInboundParseWebhook(ctx context.Context, hostname string, input *InputUpdateInboundParseWebhook) (*OutputUpdateInboundParseWebhook, error)

see: https://docs.sendgrid.com/api-reference/settings-inbound-parse/update-a-parse-setting

func (*Client) UpdateOpenTrackingSettings added in v0.0.18 

func (c *Client) UpdateOpenTrackingSettings(ctx context.Context, input *InputUpdateOpenTrackingSettings) (*OutputUpdateOpenTrackingSettings, error)

see: https://docs.sendgrid.com/api-reference/settings-tracking/update-open-tracking-settings

func (*Client) UpdateSSOCertificate added in v0.0.19 

func (c *Client) UpdateSSOCertificate(ctx context.Context, id int64, input *InputUpdateSSOCertificate) (*OutputUpdateSSOCertificate, error)

see: https://docs.sendgrid.com/api-reference/certificates/update-sso-certificate

func (*Client) UpdateSSOIntegration added in v0.0.19 

func (c *Client) UpdateSSOIntegration(ctx context.Context, id string, input *InputUpdateSSOIntegration) (*OutputUpdateSSOIntegration, error)

see: https://docs.sendgrid.com/api-reference/single-sign-on-settings/update-an-sso-integration

func (*Client) UpdateSSOTeammate added in v1.2.0 

func (c *Client) UpdateSSOTeammate(ctx context.Context, username string, input *InputUpdateSSOTeammate) (*OutputUpdateSSOTeammate, error)

see: https://www.twilio.com/docs/sendgrid/api-reference/single-sign-on-teammates/edit-an-sso-teammate

func (*Client) UpdateScheduledSend added in v1.10.0 

func (c *Client) UpdateScheduledSend(ctx context.Context, batchID string, input *InputUpdateScheduledSend) error

see: https://docs.sendgrid.com/api-reference/cancel-scheduled-sends/update-a-scheduled-send

func (*Client) UpdateSubscriptionTrackingSettings added in v0.0.18 

func (c *Client) UpdateSubscriptionTrackingSettings(ctx context.Context, input *InputUpdateSubscriptionTrackingSettings) (*OutputUpdateSubscriptionTrackingSettings, error)

see: https://docs.sendgrid.com/api-reference/settings-tracking/update-subscription-tracking-settings

func (*Client) UpdateSubuserIps added in v0.0.3 

func (c *Client) UpdateSubuserIps(ctx context.Context, username string, ips []string) error

see: https://www.twilio.com/docs/sendgrid/api-reference/subusers-api/update-ips-assigned-to-a-subuser

func (*Client) UpdateSubuserStatus added in v0.0.3 

func (c *Client) UpdateSubuserStatus(ctx context.Context, username string, input *InputUpdateSubuserStatus) error

see: https://www.twilio.com/docs/sendgrid/api-reference/subusers-api/enabledisable-a-subuser

func (*Client) UpdateSuppressionGroup added in v0.0.13 

func (c *Client) UpdateSuppressionGroup(ctx context.Context, id int64, input *InputUpdateSuppressionGroup) (*OutputUpdateSuppressionGroup, error)

see: https://docs.sendgrid.com/api-reference/suppressions-unsubscribe-groups/update-a-suppression-group

func (*Client) UpdateTeammatePermissions 

func (c *Client) UpdateTeammatePermissions(ctx context.Context, username string, input *InputUpdateTeammatePermissions) (*OutputUpdateTeammatePermissions, error)

func (*Client) UpdateTemplate added in v0.0.14 

func (c *Client) UpdateTemplate(ctx context.Context, id string, input *InputUpdateTemplate) (*OutputUpdateTemplate, error)

see: https://docs.sendgrid.com/api-reference/transactional-templates/edit-a-transactional-template

func (*Client) UpdateTemplateVersion added in v0.0.14 

func (c *Client) UpdateTemplateVersion(ctx context.Context, templateID, versionID string, input *InputUpdateTemplateVersion) (*OutputUpdateTemplateVersion, error)

see: https://docs.sendgrid.com/api-reference/transactional-templates-versions/edit-a-transactional-template-version

func (*Client) UpdateVerifiedSender added in v0.0.10 

func (c *Client) UpdateVerifiedSender(ctx context.Context, id int64, input *InputUpdateVerifiedSender) (*OutputUpdateVerifiedSender, error)

func (*Client) ValidateBatchID added in v1.10.0 

func (c *Client) ValidateBatchID(ctx context.Context, batchID string) (*OutputValidateBatchID, error)
func (c *Client) ValidateBrandedLink(ctx context.Context, id int64) (*OutputValidateBrandedLink, error)

func (*Client) ValidateDomainAuthentication added in v0.0.6 

func (c *Client) ValidateDomainAuthentication(ctx context.Context, domainId int64) (*OutputValidateDomainAuthentication, error)

func (*Client) ValidateReverseDNS added in v0.0.17 

func (c *Client) ValidateReverseDNS(ctx context.Context, id int64) (*OutputValidateReverseDNS, error)

see: https://docs.sendgrid.com/api-reference/reverse-dns/set-up-reverse-dns

func (*Client) VerifySenderRequest added in v0.0.10 

func (c *Client) VerifySenderRequest(ctx context.Context, token string) error

type CompletedStepsVerifiedSender added in v0.0.10 

type CompletedStepsVerifiedSender struct {
	SenderVerified bool `json:"sender_verified,omitempty"`
	DomainVerified bool `json:"domain_verified,omitempty"`
}

type Contact added in v1.10.0 

type Contact struct {
	ID                  string                 `json:"id,omitempty"`
	FirstName           string                 `json:"first_name,omitempty"`
	LastName            string                 `json:"last_name,omitempty"`
	UniqueName          string                 `json:"unique_name,omitempty"`
	Email               string                 `json:"email,omitempty"`
	PhoneNumberID       string                 `json:"phone_number_id,omitempty"`
	ExternalID          string                 `json:"external_id,omitempty"`
	AnonymousID         string                 `json:"anonymous_id,omitempty"`
	AlternateEmails     []string               `json:"alternate_emails,omitempty"`
	AddressLine1        string                 `json:"address_line_1,omitempty"`
	AddressLine2        string                 `json:"address_line_2,omitempty"`
	City                string                 `json:"city,omitempty"`
	StateProvinceRegion string                 `json:"state_province_region,omitempty"`
	Country             string                 `json:"country,omitempty"`
	PostalCode          string                 `json:"postal_code,omitempty"`
	PhoneNumber         string                 `json:"phone_number,omitempty"`
	Whatsapp            string                 `json:"whatsapp,omitempty"`
	Line                string                 `json:"line,omitempty"`
	Facebook            string                 `json:"facebook,omitempty"`
	ListIDs             []string               `json:"list_ids,omitempty"`
	SegmentIDs          []string               `json:"segment_ids,omitempty"`
	CustomFields        map[string]interface{} `json:"custom_fields,omitempty"`
	CreatedAt           string                 `json:"created_at,omitempty"`
	UpdatedAt           string                 `json:"updated_at,omitempty"`
	Metadata            *_Metadata             `json:"_metadata,omitempty"`
}

type ContactBillableBreakdown added in v1.10.0 

type ContactBillableBreakdown struct {
	Total     int64            `json:"total,omitempty"`
	Breakdown map[string]int64 `json:"breakdown,omitempty"`
}

type ContactByEmailResult added in v1.10.0 

type ContactByEmailResult struct {
	Contact *Contact `json:"contact,omitempty"`
	Error   string   `json:"error,omitempty"`
}

type ContactByIdentifierResult added in v1.10.0 

type ContactByIdentifierResult struct {
	Contact *Contact `json:"contact,omitempty"`
	Error   string   `json:"error,omitempty"`
}

type ContactExportJob added in v1.10.0 

type ContactExportJob struct {
	ID          string              `json:"id,omitempty"`
	Status      string              `json:"status,omitempty"`
	CreatedAt   string              `json:"created_at,omitempty"`
	CompletedAt string              `json:"completed_at,omitempty"`
	ExpiresAt   string              `json:"expires_at,omitempty"`
	URLs        []string            `json:"urls,omitempty"`
	UserID      string              `json:"user_id,omitempty"`
	ExportType  string              `json:"export_type,omitempty"`
	Segments    []*ExportJobSegment `json:"segments,omitempty"`
	Lists       []*ExportJobList    `json:"lists,omitempty"`
	Metadata    *_Metadata          `json:"_metadata,omitempty"`
}

type ContactRequest added in v1.10.0 

type ContactRequest struct {
	AddressLine1        string                 `json:"address_line_1,omitempty"`
	AddressLine2        string                 `json:"address_line_2,omitempty"`
	AlternateEmails     []string               `json:"alternate_emails,omitempty"`
	City                string                 `json:"city,omitempty"`
	Country             string                 `json:"country,omitempty"`
	Email               string                 `json:"email,omitempty"`
	PhoneNumberID       string                 `json:"phone_number_id,omitempty"`
	ExternalID          string                 `json:"external_id,omitempty"`
	AnonymousID         string                 `json:"anonymous_id,omitempty"`
	FirstName           string                 `json:"first_name,omitempty"`
	LastName            string                 `json:"last_name,omitempty"`
	PostalCode          string                 `json:"postal_code,omitempty"`
	StateProvinceRegion string                 `json:"state_province_region,omitempty"`
	CustomFields        map[string]interface{} `json:"custom_fields,omitempty"`
}

type Content added in v1.6.0 

type Content struct {
	Type  string `json:"type"`
	Value string `json:"value"`
}

Content represents email content with type and value

func NewContent added in v1.6.0 

func NewContent(contentType, value string) *Content

NewContent creates a new Content struct

type CreditAllocation added in v0.0.3 

type CreditAllocation struct {
	Type string `json:"type"`
}

type DNS added in v0.0.6 

type DNS struct {
	MailCname Record `json:"mail_cname,omitempty"`
	Dkim1     Record `json:"dkim1,omitempty"`
	Dkim2     Record `json:"dkim2,omitempty"`
}
type DNSBrandedLink struct {
	DomainCname Record `json:"domain_cname,omitempty"`
	OwnerCname  Record `json:"owner_cname,omitempty"`
}

type Design added in v1.0.3 

type Design struct {
	ID                   string   `json:"id,omitempty"`
	UpdatedAt            string   `json:"updated_at,omitempty"`
	CreatedAt            string   `json:"created_at,omitempty"`
	ThumbnailURL         string   `json:"thumbnail_url,omitempty"`
	Name                 string   `json:"name,omitempty"`
	Editor               string   `json:"editor,omitempty"`
	Subject              string   `json:"subject,omitempty"`
	Categories           []string `json:"categories,omitempty"`
	GeneratePlainContent bool     `json:"generate_plain_content,omitempty"`
}

type DomainAuthentication added in v0.0.6 

type DomainAuthentication struct {
	ID                      int64                         `json:"id,omitempty"`
	UserID                  int64                         `json:"user_id,omitempty"`
	Subdomain               string                        `json:"subdomain,omitempty"`
	Domain                  string                        `json:"domain,omitempty"`
	Username                string                        `json:"username,omitempty"`
	IPs                     []string                      `json:"ips,omitempty"`
	CustomSpf               bool                          `json:"custom_spf,omitempty"`
	Default                 bool                          `json:"default,omitempty"`
	Legacy                  bool                          `json:"legacy,omitempty"`
	AutomaticSecurity       bool                          `json:"automatic_security,omitempty"`
	Valid                   bool                          `json:"valid,omitempty"`
	DNS                     DNS                           `json:"dns,omitempty"`
	Subusers                []SubuserSenderAuthentication `json:"subusers,omitempty"`
	LastValidationAttemptAt int64                         `json:"last_validation_attempt_at,omitempty"`
}

type Email added in v1.6.0 

type Email struct {
	Email string `json:"email"`
	Name  string `json:"name,omitempty"`
}

Email represents an email address with optional name

func NewEmail added in v1.6.0 

func NewEmail(email, name string) *Email

NewEmail creates a new Email struct

type Error 

type Error struct {
	Field   *string `json:"field,omitempty"`
	Message *string `json:"message,omitempty"`
}

Error is sendgrid error

type ErrorResponse 

type ErrorResponse struct {
	Error string `json:"error"`
}

ErrorResponse is sendgrid error response

func (ErrorResponse) Err added in v0.0.16 

func (t ErrorResponse) Err() error

Err : error

type ErrorsResponse added in v0.0.16 

type ErrorsResponse struct {
	Errors []*Error `json:"errors"`
}

ErrorsResponse is sendgrid error response

func (ErrorsResponse) Errs added in v0.0.16 

func (t ErrorsResponse) Errs() error

Errs : error list

type EventWebhook added in v1.0.2 

type EventWebhook struct {
	ID               string `json:"id,omitempty"`
	Enabled          bool   `json:"enabled,omitempty"`
	URL              string `json:"url,omitempty"`
	GroupResubscribe bool   `json:"group_resubscribe,omitempty"`
	Delivered        bool   `json:"delivered,omitempty"`
	GroupUnsubscribe bool   `json:"group_unsubscribe,omitempty"`
	SpamReport       bool   `json:"spam_report,omitempty"`
	Bounce           bool   `json:"bounce,omitempty"`
	Deferred         bool   `json:"deferred,omitempty"`
	Unsubscribe      bool   `json:"unsubscribe,omitempty"`
	Processed        bool   `json:"processed,omitempty"`
	Open             bool   `json:"open,omitempty"`
	Click            bool   `json:"click,omitempty"`
	Dropped          bool   `json:"dropped,omitempty"`
	FriendlyName     string `json:"friendly_name,omitempty"`
	OAuthClientID    string `json:"oauth_client_id,omitempty"`
	OAuthTokenURL    string `json:"oauth_token_url,omitempty"`
	PublicKey        string `json:"public_key,omitempty"`
}

type ExportContactsNotification added in v1.10.0 

type ExportContactsNotification struct {
	Email bool `json:"email,omitempty"`
}

type ExportJobList added in v1.10.0 

type ExportJobList struct {
	ID   string `json:"ID,omitempty"`
	Name string `json:"Name,omitempty"`
}

type ExportJobSegment added in v1.10.0 

type ExportJobSegment struct {
	ID   string `json:"ID,omitempty"`
	Name string `json:"Name,omitempty"`
}

type FooterSetting added in v1.6.0 

type FooterSetting struct {
	Enable *bool  `json:"enable,omitempty"`
	Text   string `json:"text,omitempty"`
	HTML   string `json:"html,omitempty"`
}

FooterSetting represents footer settings

type GlobalStat added in v1.6.0 

type GlobalStat struct {
	Date  string      `json:"date,omitempty"`
	Stats StatMetrics `json:"stats,omitempty"`
}

GlobalStat represents global statistics

type GlobalUnsubscribe added in v1.10.0 

type GlobalUnsubscribe struct {
	Created int64  `json:"created,omitempty"`
	Email   string `json:"email,omitempty"`
}

type GoogleAnalyticsSetting added in v1.6.0 

type GoogleAnalyticsSetting struct {
	Enable      *bool  `json:"enable,omitempty"`
	UTMSource   string `json:"utm_source,omitempty"`
	UTMMedium   string `json:"utm_medium,omitempty"`
	UTMTerm     string `json:"utm_term,omitempty"`
	UTMContent  string `json:"utm_content,omitempty"`
	UTMCampaign string `json:"utm_campaign,omitempty"`
}

GoogleAnalyticsSetting represents Google Analytics settings

type IPAddress added in v1.6.0 

type IPAddress struct {
	IP         string   `json:"ip,omitempty"`
	Pools      []string `json:"pools,omitempty"`
	Warmup     bool     `json:"warmup,omitempty"`
	StartDate  int64    `json:"start_date,omitempty"`
	Subusers   []string `json:"subusers,omitempty"`
	Rdns       string   `json:"rdns,omitempty"`
	AssignedAt int64    `json:"assigned_at,omitempty"`
}

IPAddress represents an IP address

type IPPool added in v1.6.0 

type IPPool struct {
	Name string `json:"name,omitempty"`
}

IPPool represents an IP pool

type IPWarmupStatus added in v1.6.0 

type IPWarmupStatus struct {
	IP     string `json:"ip,omitempty"`
	Warmup bool   `json:"warmup,omitempty"`
}

IPWarmupStatus represents IP warmup status

type ImportContactsResults added in v1.10.0 

type ImportContactsResults struct {
	RequestedCount int64  `json:"requested_count,omitempty"`
	CreatedCount   int64  `json:"created_count,omitempty"`
	UpdatedCount   int64  `json:"updated_count,omitempty"`
	DeletedCount   int64  `json:"deleted_count,omitempty"`
	ErroredCount   int64  `json:"errored_count,omitempty"`
	ErrorsURL      string `json:"errors_url,omitempty"`
}

type ImportContactsUploadHeader added in v1.10.0 

type ImportContactsUploadHeader struct {
	Header string `json:"header,omitempty"`
	Value  string `json:"value,omitempty"`
}

type InboundParseWebhook added in v1.1.1 

type InboundParseWebhook struct {
	URL       string `json:"url,omitempty"`
	Hostname  string `json:"hostname,omitempty"`
	SpamCheck bool   `json:"spam_check,omitempty"`
	SendRaw   bool   `json:"send_raw,omitempty"`
}

type InputAddIPToAuthenticatedDomain added in v0.0.6 

type InputAddIPToAuthenticatedDomain struct {
	IP string `json:"ip,omitempty"`
}

type InputAddIPToPool added in v1.6.0 

type InputAddIPToPool struct {
	IP string `json:"ip"`
}

InputAddIPToPool represents the request to add an IP to a pool

type InputAddIPsToAllowList added in v1.10.0 

type InputAddIPsToAllowList struct {
	IPs []AllowListIP `json:"ips,omitempty"`
}

type InputAddOrUpdateContacts added in v1.10.0 

type InputAddOrUpdateContacts struct {
	ListIDs  []string          `json:"list_ids,omitempty"`
	Contacts []*ContactRequest `json:"contacts"`
}

type InputAddRecipientAddressesToGlobalSuppressions added in v1.10.0 

type InputAddRecipientAddressesToGlobalSuppressions struct {
	RecipientEmails []string `json:"recipient_emails,omitempty"`
}

type InputAddSuppressionsToGroup added in v1.10.0 

type InputAddSuppressionsToGroup struct {
	RecipientEmails []string `json:"recipient_emails,omitempty"`
}

type InputAssignIPToSubuser added in v1.6.0 

type InputAssignIPToSubuser struct {
	IPs []string `json:"ips"`
}

InputAssignIPToSubuser represents the request to assign an IP to a subuser

type InputAssociateAuthenticatedDomainWithSubuser added in v0.0.6 

type InputAssociateAuthenticatedDomainWithSubuser struct {
	Username string `json:"username,omitempty"`
}

type InputAssociateBrandedLinkWithSubuser added in v0.0.7 

type InputAssociateBrandedLinkWithSubuser struct {
	Username string `json:"username,omitempty"`
}

type InputAuthenticateDomain added in v0.0.6 

type InputAuthenticateDomain struct {
	Domain             string   `json:"domain,omitempty"`
	Subdomain          string   `json:"subdomain,omitempty"`
	Username           string   `json:"username,omitempty"`
	IPs                []string `json:"ips,omitempty"`
	CustomSpf          bool     `json:"custom_spf,omitempty"`
	Default            bool     `json:"default,omitempty"`
	AutomaticSecurity  bool     `json:"automatic_security,omitempty"`
	CustomDkimSelector string   `json:"custom_dkim_selector,omitempty"`
}

type InputCreateAPIKey added in v0.0.2 

type InputCreateAPIKey struct {
	Name   string   `json:"name,omitempty"`
	Scopes []string `json:"scopes,omitempty"`
}

type InputCreateAlert added in v1.4.0 

type InputCreateAlert struct {
	Type       string `json:"type,omitempty"`
	EmailTo    string `json:"email_to,omitempty"`
	Frequency  string `json:"frequency,omitempty"`
	Percentage int64  `json:"percentage,omitempty"`
}
type InputCreateBrandedLink struct {
	Domain    string `json:"domain,omitempty"`
	Subdomain string `json:"subdomain,omitempty"`
	Default   bool   `json:"default"`
}

type InputCreateDesign added in v1.0.3 

type InputCreateDesign struct {
	Name                 string   `json:"name,omitempty"`
	Editor               string   `json:"editor,omitempty"`
	HTMLContent          string   `json:"html_content,omitempty"`
	PlainContent         string   `json:"plain_content,omitempty"`
	GeneratePlainContent bool     `json:"generate_plain_content"`
	Subject              string   `json:"subject,omitempty"`
	Categories           []string `json:"categories,omitempty"`
}

type InputCreateEventWebhook added in v1.0.2 

type InputCreateEventWebhook struct {
	Enabled           bool   `json:"enabled"`
	URL               string `json:"url,omitempty"`
	GroupResubscribe  bool   `json:"group_resubscribe"`
	Delivered         bool   `json:"delivered"`
	GroupUnsubscribe  bool   `json:"group_unsubscribe"`
	SpamReport        bool   `json:"spam_report"`
	Bounce            bool   `json:"bounce"`
	Deferred          bool   `json:"deferred"`
	Unsubscribe       bool   `json:"unsubscribe"`
	Processed         bool   `json:"processed"`
	Open              bool   `json:"open"`
	Click             bool   `json:"click"`
	Dropped           bool   `json:"dropped"`
	FriendlyName      string `json:"friendly_name,omitempty"`
	OAuthClientID     string `json:"oauth_client_id,omitempty"`
	OAuthClientSecret string `json:"oauth_client_secret,omitempty"`
	OAuthTokenURL     string `json:"oauth_token_url,omitempty"`
}

type InputCreateInboundParseWebhook added in v1.1.1 

type InputCreateInboundParseWebhook struct {
	URL       string `json:"url,omitempty"`
	Hostname  string `json:"hostname,omitempty"`
	SpamCheck bool   `json:"spam_check"`
	SendRaw   bool   `json:"send_raw"`
}

type InputCreateReverseDNS added in v0.0.17 

type InputCreateReverseDNS struct {
	IP        string `json:"ip,omitempty"`
	Subdomain string `json:"subdomain,omitempty"`
	Domain    string `json:"domain,omitempty"`
}

type InputCreateSSOCertificate added in v0.0.20 

type InputCreateSSOCertificate struct {
	PublicCertificate string `json:"public_certificate,omitempty"`
	Enabled           bool   `json:"enabled"`
	IntegrationID     string `json:"integration_id,omitempty"`
}

type InputCreateSSOIntegration added in v0.0.19 

type InputCreateSSOIntegration struct {
	Name                 string `json:"name,omitempty"`
	Enabled              bool   `json:"enabled"`
	SigninURL            string `json:"signin_url,omitempty"`
	SignoutURL           string `json:"signout_url,omitempty"`
	EntityID             string `json:"entity_id,omitempty"`
	CompletedIntegration bool   `json:"completed_integration"`
}

type InputCreateSSOTeammate added in v1.2.0 

type InputCreateSSOTeammate struct {
	Email                      string               `json:"email"`
	FirstName                  string               `json:"first_name"`
	LastName                   string               `json:"last_name"`
	IsAdmin                    bool                 `json:"is_admin"`
	IsSSO                      bool                 `json:"is_sso"`
	Persona                    string               `json:"persona,omitempty"`
	Scopes                     []string             `json:"scopes,omitempty"`
	HasRestrictedSubuserAccess bool                 `json:"has_restricted_subuser_access,omitempty"`
	SubuserAccess              []InputSubuserAccess `json:"subuser_access,omitempty"`
}

type InputCreateSubuser added in v0.0.3 

type InputCreateSubuser struct {
	Username      string   `json:"username"`
	Email         string   `json:"email"`
	Password      string   `json:"password"`
	Ips           []string `json:"ips"`
	Region        string   `json:"region"`
	IncludeRegion bool     `json:"include_region"`
}

type InputCreateSuppressionGroup added in v0.0.13 

type InputCreateSuppressionGroup struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	IsDefault   bool   `json:"is_default"`
}

type InputCreateTemplate added in v0.0.14 

type InputCreateTemplate struct {
	Name       string `json:"name,omitempty"`
	Generation string `json:"generation,omitempty"`
}

type InputCreateTemplateVersion added in v0.0.14 

type InputCreateTemplateVersion struct {
	Active               int    `json:"active,omitempty"`
	Name                 string `json:"name,omitempty"`
	HTMLContent          string `json:"html_content,omitempty"`
	PlainContent         string `json:"plain_content,omitempty"`
	GeneratePlainContent bool   `json:"generate_plain_content"`
	Subject              string `json:"subject,omitempty"`
	Editor               string `json:"editor,omitempty"`
	TestData             string `json:"test_data,omitempty"`
}

type InputCreateVerifiedSenderRequest added in v0.0.10 

type InputCreateVerifiedSenderRequest struct {
	Nickname    string `json:"nickname,omitempty"`
	FromEmail   string `json:"from_email,omitempty"`
	FromName    string `json:"from_name,omitempty"`
	ReplyTo     string `json:"reply_to,omitempty"`
	ReplyToName string `json:"reply_to_name,omitempty"`
	Address     string `json:"address,omitempty"`
	Address2    string `json:"address2,omitempty"`
	State       string `json:"state,omitempty"`
	City        string `json:"city,omitempty"`
	Zip         string `json:"zip,omitempty"`
	Country     string `json:"country,omitempty"`
}

type InputDeleteContactIdentifier added in v1.10.0 

type InputDeleteContactIdentifier struct {
	IdentifierType  string `json:"identifier_type"`
	IdentifierValue string `json:"identifier_value"`
}

type InputDeleteContacts added in v1.10.0 

type InputDeleteContacts struct {
	IDs               []string `url:"ids,omitempty"`
	DeleteAllContacts string   `url:"delete_all_contacts,omitempty"`
}

type InputDeleteSuppressions added in v1.6.0 

type InputDeleteSuppressions struct {
	Emails    []string `json:"emails,omitempty"`
	DeleteAll bool     `json:"delete_all,omitempty"`
}

InputDeleteSuppressions represents the request body for deleting suppressions

type InputDuplicateDesign added in v1.10.0 

type InputDuplicateDesign struct {
	Name   string `json:"name,omitempty"`
	Editor string `json:"editor,omitempty"`
}

type InputDuplicateTemplate added in v0.0.14 

type InputDuplicateTemplate struct {
	Name string `json:"name,omitempty"`
}

type InputExportContacts added in v1.10.0 

type InputExportContacts struct {
	ListIDs       []string                    `json:"list_ids,omitempty"`
	SegmentIDs    []string                    `json:"segment_ids,omitempty"`
	Notifications *ExportContactsNotification `json:"notifications,omitempty"`
	FileType      string                      `json:"file_type,omitempty"`
	MaxFileSize   int64                       `json:"max_file_size,omitempty"`
}

type InputGetAccessActivities added in v1.10.0 

type InputGetAccessActivities struct {
	Limit int `json:"limit,omitempty"`
}

type InputGetAuthenticatedDomains added in v0.0.6 

type InputGetAuthenticatedDomains struct {
	Limit           int
	Offset          int
	ExcludeSubusers bool
	Username        string
	Domain          string
}

type InputGetBatchedContactsByIDs added in v1.10.0 

type InputGetBatchedContactsByIDs struct {
	IDs []string `json:"ids"`
}
type InputGetBrandedLinks struct {
	Limit int
}

type InputGetContactsByEmails added in v1.10.0 

type InputGetContactsByEmails struct {
	Emails        []string `json:"emails"`
	PhoneNumberID string   `json:"phone_number_id,omitempty"`
	ExternalID    string   `json:"external_id,omitempty"`
	AnonymousID   string   `json:"anonymous_id,omitempty"`
}

type InputGetContactsByIdentifiers added in v1.10.0 

type InputGetContactsByIdentifiers struct {
	Identifiers []string `json:"identifiers"`
}

type InputGetDefaultAuthentication added in v0.0.6 

type InputGetDefaultAuthentication struct {
	Domain string
}

type InputGetDesigns added in v1.10.0 

type InputGetDesigns struct {
	PageSize  int64  `json:"page_size,omitempty"`
	PageToken string `json:"page_token,omitempty"`
	Summary   bool   `json:"summary,omitempty"`
}

type InputGetGlobalSuppressions added in v1.10.0 

type InputGetGlobalSuppressions struct {
	StartTime int64  `json:"start_time,omitempty"`
	EndTime   int64  `json:"end_time,omitempty"`
	Limit     int    `json:"limit,omitempty"`
	Offset    int    `json:"offset,omitempty"`
	Email     string `json:"email,omitempty"`
}

type InputGetPreBuiltDesigns added in v1.10.0 

type InputGetPreBuiltDesigns struct {
	PageSize  int64  `json:"page_size,omitempty"`
	PageToken string `json:"page_token,omitempty"`
	Summary   bool   `json:"summary,omitempty"`
}

type InputGetReverseDNSs added in v0.0.17 

type InputGetReverseDNSs struct {
	Limit  int    `json:"limit,omitempty"`
	Offset int    `json:"offset,omitempty"`
	IP     string `json:"ip,omitempty"`
}

type InputGetSSOIntegrations added in v0.0.19 

type InputGetSSOIntegrations struct {
	Si bool `json:"si,omitempty"`
}

type InputGetSubusers added in v0.0.3 

type InputGetSubusers struct {
	Username      string
	Limit         int
	Offset        int
	Region        string
	IncludeRegion bool
}

type InputGetTeammateSubuserAccess added in v1.3.0 

type InputGetTeammateSubuserAccess struct {
	AfterSubuserID int64  `json:"after_subuser_id,omitempty"`
	Limit          int64  `json:"limit,omitempty"`
	Username       string `json:"username,omitempty"`
}

type InputGetTeammates added in v1.5.0 

type InputGetTeammates struct {
	Limit  int `json:"limit,omitempty"`
	Offset int `json:"offset,omitempty"`
}

type InputGetTemplates added in v0.0.14 

type InputGetTemplates struct {
	Generations string
	PageSize    int
	PageToken   string
}

type InputGetVerifiedSenders added in v0.0.10 

type InputGetVerifiedSenders struct {
	Limit      int
	LastSeenID int
	ID         int64
}

type InputImportContacts added in v1.10.0 

type InputImportContacts struct {
	ListIDs       []string `json:"list_ids,omitempty"`
	FileType      string   `json:"file_type"`
	FieldMappings []string `json:"field_mappings"`
}

type InputInviteTeammate 

type InputInviteTeammate struct {
	Email   string   `json:"email"`
	IsAdmin bool     `json:"is_admin"`
	Scopes  []string `json:"scopes"`
}

type InputRemoveIPsFromAllowList added in v1.10.0 

type InputRemoveIPsFromAllowList struct {
	IDs []int64 `json:"ids,omitempty"`
}

type InputSearchContacts added in v1.10.0 

type InputSearchContacts struct {
	Query string `json:"query,omitempty"`
}

type InputSearchGroupSuppressions added in v1.10.0 

type InputSearchGroupSuppressions struct {
	RecipientEmails []string `json:"recipient_emails,omitempty"`
}

type InputSendMail added in v1.6.0 

type InputSendMail struct {
	Personalizations []*Personalization `json:"personalizations"`
	From             *Email             `json:"from"`
	ReplyTo          *ReplyTo           `json:"reply_to,omitempty"`
	ReplyToList      []*ReplyToList     `json:"reply_to_list,omitempty"`
	Subject          string             `json:"subject,omitempty"`
	Content          []*Content         `json:"content,omitempty"`
	Attachments      []*Attachment      `json:"attachments,omitempty"`
	TemplateID       string             `json:"template_id,omitempty"`
	Headers          map[string]string  `json:"headers,omitempty"`
	Categories       []string           `json:"categories,omitempty"`
	CustomArgs       map[string]string  `json:"custom_args,omitempty"`
	SendAt           int64              `json:"send_at,omitempty"`
	BatchID          string             `json:"batch_id,omitempty"`
	ASM              *ASM               `json:"asm,omitempty"`
	IPPoolName       string             `json:"ip_pool_name,omitempty"`
	MailSettings     *MailSettings      `json:"mail_settings,omitempty"`
	TrackingSettings *TrackingSettings  `json:"tracking_settings,omitempty"`
}

InputSendMail represents the request body for sending mail

func NewInputSendMail added in v1.6.0 

func NewInputSendMail() *InputSendMail

NewInputSendMail creates a new InputSendMail struct

func (*InputSendMail) AddAttachment added in v1.6.0 

func (m *InputSendMail) AddAttachment(attachment *Attachment)

AddAttachment adds an attachment to the mail

func (*InputSendMail) AddCategory added in v1.6.0 

func (m *InputSendMail) AddCategory(category string)

AddCategory adds a category to the mail

func (*InputSendMail) AddContent added in v1.6.0 

func (m *InputSendMail) AddContent(content *Content)

AddContent adds content to the mail

func (*InputSendMail) AddPersonalization added in v1.6.0 

func (m *InputSendMail) AddPersonalization(personalization *Personalization)

AddPersonalization adds a personalization to the mail

func (*InputSendMail) SetFrom added in v1.6.0 

func (m *InputSendMail) SetFrom(from *Email)

SetFrom sets the from email address

func (*InputSendMail) SetSendAt added in v1.6.0 

func (m *InputSendMail) SetSendAt(sendAt time.Time)

SetSendAt sets the send time for the mail

func (*InputSendMail) SetSubject added in v1.6.0 

func (m *InputSendMail) SetSubject(subject string)

SetSubject sets the email subject

func (*InputSendMail) SetTemplateID added in v1.6.0 

func (m *InputSendMail) SetTemplateID(templateID string)

SetTemplateID sets the template ID for the mail

type InputSubuserAccess added in v1.2.0 

type InputSubuserAccess struct {
	ID             int64    `json:"id,omitempty"`
	PermissionType string   `json:"permission_type,omitempty"`
	Scopes         []string `json:"scopes,omitempty"`
}

type InputToggleSignatureVerification added in v1.7.0 

type InputToggleSignatureVerification struct {
	Enabled bool `json:"enabled"`
}

type InputUpdateAPIKeyName added in v0.0.2 

type InputUpdateAPIKeyName struct {
	Name string `json:"name"`
}

type InputUpdateAPIKeyNameAndScopes added in v0.0.2 

type InputUpdateAPIKeyNameAndScopes struct {
	Name   string   `json:"name"`
	Scopes []string `json:"scopes,omitempty"`
}

type InputUpdateAlert added in v1.4.0 

type InputUpdateAlert struct {
	EmailTo    string `json:"email_to,omitempty"`
	Frequency  string `json:"frequency,omitempty"`
	Percentage int64  `json:"percentage,omitempty"`
}

type InputUpdateBounceSettings added in v1.8.0 

type InputUpdateBounceSettings struct {
	Enabled     bool  `json:"enabled"`
	SoftBounces int64 `json:"soft_bounces,omitempty"`
	HardBounces int64 `json:"hard_bounces,omitempty"`
}
type InputUpdateBrandedLink struct {
	Default bool `json:"default"`
}

type InputUpdateClickTrackingSettings added in v0.0.18 

type InputUpdateClickTrackingSettings struct {
	Enabled bool `json:"enabled"`
}

type InputUpdateDesign added in v1.0.3 

type InputUpdateDesign struct {
	Name                 string   `json:"name,omitempty"`
	HTMLContent          string   `json:"html_content,omitempty"`
	PlainContent         string   `json:"plain_content,omitempty"`
	GeneratePlainContent bool     `json:"generate_plain_content"`
	Subject              string   `json:"subject,omitempty"`
	Categories           []string `json:"categories,omitempty"`
}

type InputUpdateDomainAuthentication added in v0.0.6 

type InputUpdateDomainAuthentication struct {
	Default   bool `json:"default"`
	CustomSpf bool `json:"custom_spf"`
}

type InputUpdateEnforceTLS added in v0.0.15 

type InputUpdateEnforceTLS struct {
	RequireTLS       bool    `json:"require_tls"`
	RequireValidCert bool    `json:"require_valid_cert"`
	Version          float64 `json:"version,omitempty"`
}

type InputUpdateEventWebhook added in v1.0.2 

type InputUpdateEventWebhook struct {
	Enabled           bool   `json:"enabled"`
	URL               string `json:"url,omitempty"`
	GroupResubscribe  bool   `json:"group_resubscribe"`
	Delivered         bool   `json:"delivered"`
	GroupUnsubscribe  bool   `json:"group_unsubscribe"`
	SpamReport        bool   `json:"spam_report"`
	Bounce            bool   `json:"bounce"`
	Deferred          bool   `json:"deferred"`
	Unsubscribe       bool   `json:"unsubscribe"`
	Processed         bool   `json:"processed"`
	Open              bool   `json:"open"`
	Click             bool   `json:"click"`
	Dropped           bool   `json:"dropped"`
	FriendlyName      string `json:"friendly_name,omitempty"`
	OAuthClientID     string `json:"oauth_client_id,omitempty"`
	OAuthClientSecret string `json:"oauth_client_secret,omitempty"`
	OAuthTokenURL     string `json:"oauth_token_url,omitempty"`
}

type InputUpdateGoogleAnalyticsSettings added in v0.0.18 

type InputUpdateGoogleAnalyticsSettings struct {
	Enabled     bool   `json:"enabled"`
	UTMCampaign string `json:"utm_campaign,omitempty"`
	UTMContent  string `json:"utm_content,omitempty"`
	UTMMedium   string `json:"utm_medium,omitempty"`
	UTMSource   string `json:"utm_source,omitempty"`
	UTMTerm     string `json:"utm_term,omitempty"`
}

type InputUpdateInboundParseWebhook added in v1.1.1 

type InputUpdateInboundParseWebhook struct {
	URL       string `json:"url,omitempty"`
	SpamCheck bool   `json:"spam_check"`
	SendRaw   bool   `json:"send_raw"`
}

type InputUpdateOpenTrackingSettings added in v0.0.18 

type InputUpdateOpenTrackingSettings struct {
	Enabled bool `json:"enabled"`
}

type InputUpdateSSOCertificate added in v0.0.19 

type InputUpdateSSOCertificate struct {
	PublicCertificate string `json:"public_certificate,omitempty"`
	Enabled           bool   `json:"enabled"`
	IntegrationID     string `json:"integration_id,omitempty"`
}

type InputUpdateSSOIntegration added in v0.0.19 

type InputUpdateSSOIntegration struct {
	Name                 string `json:"name,omitempty"`
	Enabled              bool   `json:"enabled"`
	SigninURL            string `json:"signin_url,omitempty"`
	SignoutURL           string `json:"signout_url,omitempty"`
	EntityID             string `json:"entity_id,omitempty"`
	CompletedIntegration bool   `json:"completed_integration"`
}

type InputUpdateSSOTeammate added in v1.2.0 

type InputUpdateSSOTeammate struct {
	FirstName                  string               `json:"first_name"`
	LastName                   string               `json:"last_name"`
	IsAdmin                    bool                 `json:"is_admin"`
	Persona                    string               `json:"persona,omitempty"`
	Scopes                     []string             `json:"scopes,omitempty"`
	HasRestrictedSubuserAccess bool                 `json:"has_restricted_subuser_access,omitempty"`
	SubuserAccess              []InputSubuserAccess `json:"subuser_access,omitempty"`
}

type InputUpdateScheduledSend added in v1.10.0 

type InputUpdateScheduledSend struct {
	Status string `json:"status,omitempty"`
}

type InputUpdateSubscriptionTrackingSettings added in v0.0.18 

type InputUpdateSubscriptionTrackingSettings struct {
	Enabled      bool   `json:"enabled"`
	HTMLContent  string `json:"html_content,omitempty"`
	Landing      string `json:"landing,omitempty"`
	PlainContent string `json:"plain_content,omitempty"`
	Replace      string `json:"replace,omitempty"`
	URL          string `json:"url,omitempty"`
}

type InputUpdateSubuserStatus added in v0.0.3 

type InputUpdateSubuserStatus struct {
	Disabled bool `json:"disabled"`
}

type InputUpdateSuppressionGroup added in v0.0.13 

type InputUpdateSuppressionGroup struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	IsDefault   bool   `json:"is_default"`
}

type InputUpdateTeammatePermissions 

type InputUpdateTeammatePermissions struct {
	IsAdmin bool     `json:"is_admin"`
	Scopes  []string `json:"scopes"`
}

type InputUpdateTemplate added in v0.0.14 

type InputUpdateTemplate struct {
	Name string `json:"name,omitempty"`
}

type InputUpdateTemplateVersion added in v0.0.14 

type InputUpdateTemplateVersion struct {
	Active               int    `json:"active,omitempty"`
	Name                 string `json:"name,omitempty"`
	HTMLContent          string `json:"html_content,omitempty"`
	PlainContent         string `json:"plain_content,omitempty"`
	GeneratePlainContent bool   `json:"generate_plain_content"`
	Subject              string `json:"subject,omitempty"`
	Editor               string `json:"editor,omitempty"`
	TestData             string `json:"test_data,omitempty"`
}

type InputUpdateVerifiedSender added in v0.0.10 

type InputUpdateVerifiedSender struct {
	Nickname    string `json:"nickname,omitempty"`
	FromEmail   string `json:"from_email,omitempty"`
	FromName    string `json:"from_name,omitempty"`
	ReplyTo     string `json:"reply_to,omitempty"`
	ReplyToName string `json:"reply_to_name,omitempty"`
	Address     string `json:"address,omitempty"`
	Address2    string `json:"address2,omitempty"`
	State       string `json:"state,omitempty"`
	City        string `json:"city,omitempty"`
	Zip         string `json:"zip,omitempty"`
	Country     string `json:"country,omitempty"`
}

type InvalidEmail added in v1.6.0 

type InvalidEmail struct {
	Created int64  `json:"created"`
	Email   string `json:"email"`
	Reason  string `json:"reason"`
}

InvalidEmail represents an invalid email

type MailSettings added in v1.6.0 

type MailSettings struct {
	BypassListManagement        *Setting          `json:"bypass_list_management,omitempty"`
	BypassSpamManagement        *Setting          `json:"bypass_spam_management,omitempty"`
	BypassBounceManagement      *Setting          `json:"bypass_bounce_management,omitempty"`
	BypassUnsubscribeManagement *Setting          `json:"bypass_unsubscribe_management,omitempty"`
	Footer                      *FooterSetting    `json:"footer,omitempty"`
	SandBoxMode                 *Setting          `json:"sandbox_mode,omitempty"`
	SpamCheck                   *SpamCheckSetting `json:"spam_check,omitempty"`
}

MailSettings contains various mail settings

type Member added in v1.2.1 

type Member struct {
	Teammate

	Company string   `json:"company,omitempty"`
	IsSSO   bool     `json:"is_sso,omitempty"`
	Scopes  []string `json:"scopes,omitempty"`
}

consolidating normal teammate and SSO teammate fields

type Metadata added in v0.0.14 

type Metadata struct {
	Prev  string `json:"prev,omitempty"`
	Self  string `json:"self,omitempty"`
	Next  string `json:"next,omitempty"`
	Count int    `json:"count,omitempty"`
}

type MetadataGetTeammateSubuserAccess added in v1.3.0 

type MetadataGetTeammateSubuserAccess struct {
	NextParams NextParams `json:"next_params,omitempty"`
}

type NextParams added in v1.3.0 

type NextParams struct {
	Limit          int64  `json:"limit"`
	AfterSubuserID int64  `json:"after_subuser_id,omitempty"`
	Username       string `json:"username,omitempty"`
}

type OpenTrackingSetting added in v1.6.0 

type OpenTrackingSetting struct {
	Enable          *bool  `json:"enable,omitempty"`
	SubstitutionTag string `json:"substitution_tag,omitempty"`
}

OpenTrackingSetting represents open tracking settings

type Option 

type Option func(*Client)

Option defines an option for a Client

type OutputActivateTemplateVersion added in v0.0.14 

type OutputActivateTemplateVersion struct {
	ID                   string    `json:"id,omitempty"`
	TemplateID           string    `json:"template_id,omitempty"`
	Active               int       `json:"active,omitempty"`
	Name                 string    `json:"name,omitempty"`
	HTMLContent          string    `json:"html_content,omitempty"`
	PlainContent         string    `json:"plain_content,omitempty"`
	GeneratePlainContent bool      `json:"generate_plain_content,omitempty"`
	Subject              string    `json:"subject,omitempty"`
	Editor               string    `json:"editor,omitempty"`
	TestData             string    `json:"test_data,omitempty"`
	UpdatedAt            string    `json:"updated_at,omitempty"`
	Warnings             []Warning `json:"warnings,omitempty"`
	ThumbnailURL         string    `json:"thumbnail_url,omitempty"`
}

type OutputAddIPToAuthenticatedDomain added in v0.0.6 

type OutputAddIPToAuthenticatedDomain struct {
	ID                      int64    `json:"id,omitempty"`
	UserID                  int64    `json:"user_id,omitempty"`
	Subdomain               string   `json:"subdomain,omitempty"`
	Domain                  string   `json:"domain,omitempty"`
	Username                string   `json:"username,omitempty"`
	IPs                     []string `json:"ips,omitempty"`
	CustomSpf               bool     `json:"custom_spf,omitempty"`
	Default                 bool     `json:"default,omitempty"`
	Legacy                  bool     `json:"legacy,omitempty"`
	AutomaticSecurity       bool     `json:"automatic_security,omitempty"`
	Valid                   bool     `json:"valid,omitempty"`
	DNS                     DNS      `json:"dns,omitempty"`
	LastValidationAttemptAt int64    `json:"last_validation_attempt_at,omitempty"`
}

type OutputAddIPsToAllowList added in v1.10.0 

type OutputAddIPsToAllowList struct {
	Result []*AllowedIP `json:"result,omitempty"`
}

type OutputAddOrUpdateContacts added in v1.10.0 

type OutputAddOrUpdateContacts struct {
	JobID string `json:"job_id,omitempty"`
}

type OutputAddRecipientAddressesToGlobalSuppressions added in v1.10.0 

type OutputAddRecipientAddressesToGlobalSuppressions struct {
	RecipientEmails []string `json:"recipient_emails,omitempty"`
}

type OutputAddSuppressionsToGroup added in v1.10.0 

type OutputAddSuppressionsToGroup struct {
	RecipientEmails []string `json:"recipient_emails,omitempty"`
}

type OutputAssignedIPs added in v1.6.0 

type OutputAssignedIPs struct {
	IPs []string `json:"ips,omitempty"`
}

OutputAssignedIPs represents the response for assigned IPs

type OutputAssociateAuthenticatedDomainWithSubuser added in v0.0.6 

type OutputAssociateAuthenticatedDomainWithSubuser struct {
	ID                      int64    `json:"id,omitempty"`
	UserID                  int64    `json:"user_id,omitempty"`
	Subdomain               string   `json:"subdomain,omitempty"`
	Domain                  string   `json:"domain,omitempty"`
	Username                string   `json:"username,omitempty"`
	IPs                     []string `json:"ips,omitempty"`
	CustomSpf               bool     `json:"custom_spf,omitempty"`
	Default                 bool     `json:"default,omitempty"`
	Legacy                  bool     `json:"legacy,omitempty"`
	AutomaticSecurity       bool     `json:"automatic_security,omitempty"`
	Valid                   bool     `json:"valid,omitempty"`
	DNS                     DNS      `json:"dns,omitempty"`
	LastValidationAttemptAt int64    `json:"last_validation_attempt_at,omitempty"`
}

type OutputAssociateBrandedLinkWithSubuser added in v0.0.7 

type OutputAssociateBrandedLinkWithSubuser struct {
	ID        int64          `json:"id,omitempty"`
	Domain    string         `json:"domain,omitempty"`
	Subdomain string         `json:"subdomain,omitempty"`
	Username  string         `json:"username,omitempty"`
	UserID    int64          `json:"user_id,omitempty"`
	Default   bool           `json:"default,omitempty"`
	Valid     bool           `json:"valid,omitempty"`
	Legacy    bool           `json:"legacy,omitempty"`
	DNS       DNSBrandedLink `json:"dns,omitempty"`
}

type OutputAuthenticateDomain added in v0.0.6 

type OutputAuthenticateDomain struct {
	ID                int64    `json:"id,omitempty"`
	UserID            int64    `json:"user_id,omitempty"`
	Subdomain         string   `json:"subdomain,omitempty"`
	Domain            string   `json:"domain,omitempty"`
	Username          string   `json:"username,omitempty"`
	IPs               []string `json:"ips,omitempty"`
	CustomSpf         bool     `json:"custom_spf,omitempty"`
	Default           bool     `json:"default,omitempty"`
	Legacy            bool     `json:"legacy,omitempty"`
	AutomaticSecurity bool     `json:"automatic_security,omitempty"`
	Valid             bool     `json:"valid,omitempty"`
	DNS               DNS      `json:"dns,omitempty"`
}

type OutputCancelOrPauseScheduledSend added in v1.10.0 

type OutputCancelOrPauseScheduledSend struct {
	BatchID string `json:"batch_id,omitempty"`
	Status  string `json:"status,omitempty"`
}

type OutputCompletedStepsVerifiedSender added in v0.0.10 

type OutputCompletedStepsVerifiedSender struct {
	CompletedStepsVerifiedSender *CompletedStepsVerifiedSender `json:"results,omitempty"`
}

type OutputCreateAPIKey added in v0.0.2 

type OutputCreateAPIKey struct {
	ApiKey   string   `json:"api_key,omitempty"`
	ApiKeyId string   `json:"api_key_id,omitempty"`
	Name     string   `json:"name,omitempty"`
	Scopes   []string `json:"scopes,omitempty"`
}

type OutputCreateAlert added in v1.4.0 

type OutputCreateAlert struct {
	ID         int64  `json:"id,omitempty"`
	EmailTo    string `json:"email_to,omitempty"`
	Frequency  string `json:"frequency,omitempty"`
	Type       string `json:"type,omitempty"`
	Percentage int64  `json:"percentage,omitempty"`
	CreatedAt  int64  `json:"created_at,omitempty"`
	UpdatedAt  int64  `json:"updated_at,omitempty"`
}

type OutputCreateBatchID added in v1.10.0 

type OutputCreateBatchID struct {
	BatchID string `json:"batch_id,omitempty"`
}
type OutputCreateBrandedLink struct {
	ID        int64          `json:"id,omitempty"`
	Domain    string         `json:"domain,omitempty"`
	Subdomain string         `json:"subdomain,omitempty"`
	Username  string         `json:"username,omitempty"`
	UserID    int64          `json:"user_id,omitempty"`
	Default   bool           `json:"default,omitempty"`
	Valid     bool           `json:"valid,omitempty"`
	Legacy    bool           `json:"legacy,omitempty"`
	DNS       DNSBrandedLink `json:"dns,omitempty"`
}

type OutputCreateDesign added in v1.0.3 

type OutputCreateDesign struct {
	ID                   string   `json:"id,omitempty"`
	UpdatedAt            string   `json:"updated_at,omitempty"`
	CreatedAt            string   `json:"created_at,omitempty"`
	ThumbnailURL         string   `json:"thumbnail_url,omitempty"`
	Name                 string   `json:"name,omitempty"`
	Editor               string   `json:"editor,omitempty"`
	HTMLContent          string   `json:"html_content,omitempty"`
	PlainContent         string   `json:"plain_content,omitempty"`
	GeneratePlainContent bool     `json:"generate_plain_content,omitempty"`
	Subject              string   `json:"subject,omitempty"`
	Categories           []string `json:"categories,omitempty"`
}

type OutputCreateEventWebhook added in v1.0.2 

type OutputCreateEventWebhook struct {
	ID                  string `json:"id,omitempty"`
	Enabled             bool   `json:"enabled,omitempty"`
	URL                 string `json:"url,omitempty"`
	AccountStatusChange bool   `json:"account_status_change,omitempty"`
	GroupResubscribe    bool   `json:"group_resubscribe,omitempty"`
	Delivered           bool   `json:"delivered,omitempty"`
	GroupUnsubscribe    bool   `json:"group_unsubscribe,omitempty"`
	SpamReport          bool   `json:"spam_report,omitempty"`
	Bounce              bool   `json:"bounce,omitempty"`
	Deferred            bool   `json:"deferred,omitempty"`
	Unsubscribe         bool   `json:"unsubscribe,omitempty"`
	Processed           bool   `json:"processed,omitempty"`
	Open                bool   `json:"open,omitempty"`
	Click               bool   `json:"click,omitempty"`
	Dropped             bool   `json:"dropped,omitempty"`
	FriendlyName        string `json:"friendly_name,omitempty"`
	CreatedDate         string `json:"created_date,omitempty"`
	UpdatedDate         string `json:"updated_date,omitempty"`
	OAuthClientID       string `json:"oauth_client_id,omitempty"`
	OAuthTokenURL       string `json:"oauth_token_url,omitempty"`
}

type OutputCreateInboundParseWebhook added in v1.1.1 

type OutputCreateInboundParseWebhook struct {
	URL       string `json:"url,omitempty"`
	Hostname  string `json:"hostname,omitempty"`
	SpamCheck bool   `json:"spam_check,omitempty"`
	SendRaw   bool   `json:"send_raw,omitempty"`
}

type OutputCreateReverseDNS added in v0.0.17 

type OutputCreateReverseDNS struct {
	ID                      int64   `json:"id,omitempty"`
	IP                      string  `json:"ip,omitempty"`
	RDNS                    string  `json:"rdns,omitempty"`
	Users                   []*User `json:"users,omitempty"`
	Subdomain               string  `json:"subdomain,omitempty"`
	Domain                  string  `json:"domain,omitempty"`
	Valid                   bool    `json:"valid,omitempty"`
	Legacy                  bool    `json:"legacy,omitempty"`
	LastValidationAttemptAt int64   `json:"last_validation_attempt_at,omitempty"`
	ARecord                 ARecord `json:"a_record,omitempty"`
}

type OutputCreateSSOCertificate added in v0.0.20 

type OutputCreateSSOCertificate struct {
	ID                int64  `json:"id,omitempty"`
	PublicCertificate string `json:"public_certificate,omitempty"`
	NotBefore         int64  `json:"not_before,omitempty"`
	NotAfter          int64  `json:"not_after,omitempty"`
	IntegrationID     string `json:"integration_id,omitempty"`
}

type OutputCreateSSOIntegration added in v0.0.19 

type OutputCreateSSOIntegration struct {
	ID                   string `json:"id,omitempty"`
	Name                 string `json:"name,omitempty"`
	Enabled              bool   `json:"enabled,omitempty"`
	SigninURL            string `json:"signin_url,omitempty"`
	SignoutURL           string `json:"signout_url,omitempty"`
	EntityID             string `json:"entity_id,omitempty"`
	CompletedIntegration bool   `json:"completed_integration,omitempty"`
	LastUpdated          int64  `json:"last_updated,omitempty"`
	SingleSignonURL      string `json:"single_signon_url,omitempty"`
	AudienceURL          string `json:"audience_url,omitempty"`
}

type OutputCreateSSOTeammate added in v1.2.0 

type OutputCreateSSOTeammate struct {
	FirstName                  string                `json:"first_name,omitempty"`
	LastName                   string                `json:"last_name,omitempty"`
	Email                      string                `json:"email,omitempty"`
	IsAdmin                    bool                  `json:"is_admin,omitempty"`
	IsSSO                      bool                  `json:"is_sso,omitempty"`
	Scopes                     []string              `json:"scopes,omitempty"`
	HasRestrictedSubuserAccess bool                  `json:"has_restricted_subuser_access,omitempty"`
	SubuserAccess              []OutputSubuserAccess `json:"subuser_access,omitempty"`
}

type OutputCreateSubuser added in v0.0.3 

type OutputCreateSubuser struct {
	UserID             int64            `json:"user_id"`
	Username           string           `json:"username"`
	Email              string           `json:"email"`
	SignupSessionToken string           `json:"signup_session_token"`
	AuthorizationToken string           `json:"authorization_token"`
	CreditAllocation   CreditAllocation `json:"credit_allocation"`
	Region             string           `json:"region"`
}

type OutputCreateSuppressionGroup added in v0.0.13 

type OutputCreateSuppressionGroup struct {
	ID          int64  `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	IsDefault   bool   `json:"is_default,omitempty"`
}

type OutputCreateTemplate added in v0.0.14 

type OutputCreateTemplate struct {
	ID         string    `json:"id,omitempty"`
	Name       string    `json:"name,omitempty"`
	Generation string    `json:"generation,omitempty"`
	UpdatedAt  string    `json:"updated_at,omitempty"`
	Versions   []Version `json:"versions,omitempty"`
	Warning    Warning   `json:"warning,omitempty"`
}

type OutputCreateTemplateVersion added in v0.0.14 

type OutputCreateTemplateVersion struct {
	ID                   string    `json:"id,omitempty"`
	TemplateID           string    `json:"template_id,omitempty"`
	Active               int       `json:"active,omitempty"`
	Name                 string    `json:"name,omitempty"`
	HTMLContent          string    `json:"html_content,omitempty"`
	PlainContent         string    `json:"plain_content,omitempty"`
	GeneratePlainContent bool      `json:"generate_plain_content,omitempty"`
	Subject              string    `json:"subject,omitempty"`
	Editor               string    `json:"editor,omitempty"`
	TestData             string    `json:"test_data,omitempty"`
	UpdatedAt            string    `json:"updated_at,omitempty"`
	Warnings             []Warning `json:"warnings,omitempty"`
	ThumbnailURL         string    `json:"thumbnail_url,omitempty"`
}

type OutputCreateVerifiedSenderRequest added in v0.0.10 

type OutputCreateVerifiedSenderRequest struct {
	ID          int64  `json:"id,omitempty"`
	Nickname    string `json:"nickname,omitempty"`
	FromEmail   string `json:"from_email,omitempty"`
	FromName    string `json:"from_name,omitempty"`
	ReplyTo     string `json:"reply_to,omitempty"`
	ReplyToName string `json:"reply_to_name,omitempty"`
	Address     string `json:"address,omitempty"`
	Address2    string `json:"address2,omitempty"`
	State       string `json:"state,omitempty"`
	City        string `json:"city,omitempty"`
	Zip         string `json:"zip,omitempty"`
	Country     string `json:"country,omitempty"`
	Verified    bool   `json:"verified,omitempty"`
	Locked      bool   `json:"locked,omitempty"`
}

type OutputDeleteContactIdentifier added in v1.10.0 

type OutputDeleteContactIdentifier struct {
	JobID interface{} `json:"job_id,omitempty"`
}

type OutputDeleteContacts added in v1.10.0 

type OutputDeleteContacts struct {
	JobID interface{} `json:"job_id,omitempty"`
}

type OutputDuplicateDesign added in v1.10.0 

type OutputDuplicateDesign struct {
	ID                   string   `json:"id,omitempty"`
	UpdatedAt            string   `json:"updated_at,omitempty"`
	CreatedAt            string   `json:"created_at,omitempty"`
	ThumbnailURL         string   `json:"thumbnail_url,omitempty"`
	Name                 string   `json:"name,omitempty"`
	Editor               string   `json:"editor,omitempty"`
	HTMLContent          string   `json:"html_content,omitempty"`
	PlainContent         string   `json:"plain_content,omitempty"`
	GeneratePlainContent bool     `json:"generate_plain_content,omitempty"`
	Subject              string   `json:"subject,omitempty"`
	Categories           []string `json:"categories,omitempty"`
}

type OutputDuplicateTemplate added in v0.0.14 

type OutputDuplicateTemplate struct {
	ID         string    `json:"id,omitempty"`
	Name       string    `json:"name,omitempty"`
	Generation string    `json:"generation,omitempty"`
	UpdatedAt  string    `json:"updated_at,omitempty"`
	Versions   []Version `json:"versions,omitempty"`
	Warning    Warning   `json:"warning,omitempty"`
}

type OutputExportContacts added in v1.10.0 

type OutputExportContacts struct {
	ID       string    `json:"id,omitempty"`
	Metadata _Metadata `json:"_metadata,omitempty"`
}

type OutputGetAPIKey added in v0.0.2 

type OutputGetAPIKey struct {
	ApiKeyId string   `json:"api_key_id,omitempty"`
	Name     string   `json:"name,omitempty"`
	Scopes   []string `json:"scopes,omitempty"`
}

type OutputGetAPIKeys added in v0.0.2 

type OutputGetAPIKeys struct {
	APIKeys []APIKey `json:"result,omitempty"`
}

type OutputGetAccessActivities added in v1.10.0 

type OutputGetAccessActivities struct {
	Result []*AccessActivity `json:"result,omitempty"`
}

type OutputGetAlert added in v1.4.0 

type OutputGetAlert struct {
	ID         int64  `json:"id,omitempty"`
	EmailTo    string `json:"email_to,omitempty"`
	Frequency  string `json:"frequency,omitempty"`
	Type       string `json:"type,omitempty"`
	Percentage int64  `json:"percentage,omitempty"`
	CreatedAt  int64  `json:"created_at,omitempty"`
	UpdatedAt  int64  `json:"updated_at,omitempty"`
}

type OutputGetAllExistingExports added in v1.10.0 

type OutputGetAllExistingExports struct {
	Result   []*ContactExportJob `json:"result,omitempty"`
	Metadata *_Metadata          `json:"_metadata,omitempty"`
}

type OutputGetAllowedIP added in v1.10.0 

type OutputGetAllowedIP struct {
	Result []*AllowedIP `json:"result,omitempty"`
}

type OutputGetAllowedIPs added in v1.10.0 

type OutputGetAllowedIPs struct {
	Result []*AllowedIP `json:"result,omitempty"`
}

type OutputGetAuthenticatedDomain added in v0.0.6 

type OutputGetAuthenticatedDomain struct {
	ID                int64    `json:"id,omitempty"`
	UserID            int64    `json:"user_id,omitempty"`
	Subdomain         string   `json:"subdomain,omitempty"`
	Domain            string   `json:"domain,omitempty"`
	Username          string   `json:"username,omitempty"`
	IPs               []string `json:"ips,omitempty"`
	CustomSpf         bool     `json:"custom_spf,omitempty"`
	Default           bool     `json:"default,omitempty"`
	Legacy            bool     `json:"legacy,omitempty"`
	AutomaticSecurity bool     `json:"automatic_security,omitempty"`
	Valid             bool     `json:"valid,omitempty"`
	DNS               DNS      `json:"dns,omitempty"`
}

type OutputGetAuthenticatedDomainAssociatedWithSubuser added in v0.0.6 

type OutputGetAuthenticatedDomainAssociatedWithSubuser struct {
	ID                      int64    `json:"id,omitempty"`
	UserID                  int64    `json:"user_id,omitempty"`
	Subdomain               string   `json:"subdomain,omitempty"`
	Domain                  string   `json:"domain,omitempty"`
	Username                string   `json:"username,omitempty"`
	IPs                     []string `json:"ips,omitempty"`
	CustomSpf               bool     `json:"custom_spf,omitempty"`
	Default                 bool     `json:"default,omitempty"`
	Legacy                  bool     `json:"legacy,omitempty"`
	AutomaticSecurity       bool     `json:"automatic_security,omitempty"`
	Valid                   bool     `json:"valid,omitempty"`
	DNS                     DNS      `json:"dns,omitempty"`
	LastValidationAttemptAt int64    `json:"last_validation_attempt_at,omitempty"`
}

type OutputGetBatchedContactsByIDs added in v1.10.0 

type OutputGetBatchedContactsByIDs struct {
	Result []*Contact `json:"result,omitempty"`
}

type OutputGetBlocks added in v1.6.0 

type OutputGetBlocks struct {
	Blocks []Block `json:"blocks,omitempty"`
}

OutputGetBlocks represents the response for blocks list

type OutputGetBounceSettings added in v1.8.1 

type OutputGetBounceSettings struct {
	Enabled     bool  `json:"enabled,omitempty"`
	SoftBounces int64 `json:"soft_bounces,omitempty"`
	HardBounces int64 `json:"hard_bounces,omitempty"`
}

type OutputGetBounces added in v1.6.0 

type OutputGetBounces struct {
	Bounces []Bounce `json:"bounces,omitempty"`
}

OutputGetBounces represents the response for bounces list 

type OutputGetBrandedLink struct {
	ID        int64          `json:"id,omitempty"`
	Domain    string         `json:"domain,omitempty"`
	Subdomain string         `json:"subdomain,omitempty"`
	Username  string         `json:"username,omitempty"`
	UserID    int64          `json:"user_id,omitempty"`
	Default   bool           `json:"default,omitempty"`
	Valid     bool           `json:"valid,omitempty"`
	Legacy    bool           `json:"legacy,omitempty"`
	DNS       DNSBrandedLink `json:"dns,omitempty"`
}

type OutputGetClickTrackingSettings added in v0.0.18 

type OutputGetClickTrackingSettings struct {
	EnableText bool `json:"enable_text,omitempty"`
	Enabled    bool `json:"enabled,omitempty"`
}

type OutputGetContact added in v1.10.0 

type OutputGetContact struct {
	Contact *Contact `json:"contact,omitempty"`
}

type OutputGetContactsByEmails added in v1.10.0 

type OutputGetContactsByEmails struct {
	Result map[string]*ContactByEmailResult `json:"result,omitempty"`
}

type OutputGetContactsByIdentifiers added in v1.10.0 

type OutputGetContactsByIdentifiers struct {
	Result map[string]*ContactByIdentifierResult `json:"result,omitempty"`
}

type OutputGetDefaultAuthentication added in v0.0.6 

type OutputGetDefaultAuthentication struct {
	ID                      int64                         `json:"id,omitempty"`
	UserID                  int64                         `json:"user_id,omitempty"`
	Subdomain               string                        `json:"subdomain,omitempty"`
	Domain                  string                        `json:"domain,omitempty"`
	Username                string                        `json:"username,omitempty"`
	IPs                     []string                      `json:"ips,omitempty"`
	CustomSpf               bool                          `json:"custom_spf,omitempty"`
	Default                 bool                          `json:"default,omitempty"`
	Legacy                  bool                          `json:"legacy,omitempty"`
	AutomaticSecurity       bool                          `json:"automatic_security,omitempty"`
	Valid                   bool                          `json:"valid,omitempty"`
	DNS                     DNS                           `json:"dns,omitempty"`
	Subusers                []SubuserSenderAuthentication `json:"subusers,omitempty"`
	LastValidationAttemptAt int64                         `json:"last_validation_attempt_at,omitempty"`
}
type OutputGetDefaultBrandedLink struct {
	ID        int64          `json:"id,omitempty"`
	Domain    string         `json:"domain,omitempty"`
	Subdomain string         `json:"subdomain,omitempty"`
	Username  string         `json:"username,omitempty"`
	UserID    int64          `json:"user_id,omitempty"`
	Default   bool           `json:"default,omitempty"`
	Valid     bool           `json:"valid,omitempty"`
	Legacy    bool           `json:"legacy,omitempty"`
	DNS       DNSBrandedLink `json:"dns,omitempty"`
}

type OutputGetDesign added in v1.0.3 

type OutputGetDesign struct {
	ID                   string   `json:"id,omitempty"`
	UpdatedAt            string   `json:"updated_at,omitempty"`
	CreatedAt            string   `json:"created_at,omitempty"`
	ThumbnailURL         string   `json:"thumbnail_url,omitempty"`
	Name                 string   `json:"name,omitempty"`
	Editor               string   `json:"editor,omitempty"`
	HTMLContent          string   `json:"html_content,omitempty"`
	PlainContent         string   `json:"plain_content,omitempty"`
	GeneratePlainContent bool     `json:"generate_plain_content,omitempty"`
	Subject              string   `json:"subject,omitempty"`
	Categories           []string `json:"categories,omitempty"`
}

type OutputGetDesigns added in v1.0.3 

type OutputGetDesigns struct {
	Result   []*Design `json:"result,omitempty"`
	Metadata _Metadata `json:"_metadata,omitempty"`
}

type OutputGetEnforceTLS added in v0.0.15 

type OutputGetEnforceTLS struct {
	RequireTLS       bool    `json:"require_tls,omitempty"`
	RequireValidCert bool    `json:"require_valid_cert,omitempty"`
	Version          float64 `json:"version,omitempty"`
}

type OutputGetEventWebhook added in v1.0.2 

type OutputGetEventWebhook struct {
	ID               string `json:"id,omitempty"`
	Enabled          bool   `json:"enabled,omitempty"`
	URL              string `json:"url,omitempty"`
	GroupResubscribe bool   `json:"group_resubscribe,omitempty"`
	Delivered        bool   `json:"delivered,omitempty"`
	GroupUnsubscribe bool   `json:"group_unsubscribe,omitempty"`
	SpamReport       bool   `json:"spam_report,omitempty"`
	Bounce           bool   `json:"bounce,omitempty"`
	Deferred         bool   `json:"deferred,omitempty"`
	Unsubscribe      bool   `json:"unsubscribe,omitempty"`
	Processed        bool   `json:"processed,omitempty"`
	Open             bool   `json:"open,omitempty"`
	Click            bool   `json:"click,omitempty"`
	Dropped          bool   `json:"dropped,omitempty"`
	FriendlyName     string `json:"friendly_name,omitempty"`
	OAuthClientID    string `json:"oauth_client_id,omitempty"`
	OAuthTokenURL    string `json:"oauth_token_url,omitempty"`
	PublicKey        string `json:"public_key,omitempty"`
}

type OutputGetEventWebhooks added in v1.0.2 

type OutputGetEventWebhooks struct {
	MaxAllowed int             `json:"max_allowed,omitempty"`
	Webhooks   []*EventWebhook `json:"webhooks,omitempty"`
}

type OutputGetExportContactsStatus added in v1.10.0 

type OutputGetExportContactsStatus struct {
	ID           string    `json:"id,omitempty"`
	Status       string    `json:"status,omitempty"`
	CreatedAt    string    `json:"created_at,omitempty"`
	UpdatedAt    string    `json:"updated_at,omitempty"`
	CompletedAt  string    `json:"completed_at,omitempty"`
	ExpiresAt    string    `json:"expires_at,omitempty"`
	URLs         []string  `json:"urls,omitempty"`
	Message      string    `json:"message,omitempty"`
	Metadata     _Metadata `json:"_metadata,omitempty"`
	ContactCount int64     `json:"contact_count,omitempty"`
}

type OutputGetGlobalSuppression added in v1.10.0 

type OutputGetGlobalSuppression struct {
	RecipientEmail string `json:"recipient_email,omitempty"`
}

type OutputGetGoogleAnalyticsSettings added in v0.0.18 

type OutputGetGoogleAnalyticsSettings struct {
	Enabled     bool   `json:"enabled,omitempty"`
	UTMCampaign string `json:"utm_campaign,omitempty"`
	UTMContent  string `json:"utm_content,omitempty"`
	UTMMedium   string `json:"utm_medium,omitempty"`
	UTMSource   string `json:"utm_source,omitempty"`
	UTMTerm     string `json:"utm_term,omitempty"`
}

type OutputGetImportContactsStatus added in v1.10.0 

type OutputGetImportContactsStatus struct {
	ID         string                 `json:"id,omitempty"`
	Status     string                 `json:"status,omitempty"`
	JobType    string                 `json:"job_type,omitempty"`
	Results    *ImportContactsResults `json:"results,omitempty"`
	StartedAt  string                 `json:"started_at,omitempty"`
	FinishedAt string                 `json:"finished_at,omitempty"`
}

type OutputGetInboundParseWebhook added in v1.1.1 

type OutputGetInboundParseWebhook struct {
	URL       string `json:"url,omitempty"`
	Hostname  string `json:"hostname,omitempty"`
	SpamCheck bool   `json:"spam_check,omitempty"`
	SendRaw   bool   `json:"send_raw,omitempty"`
}

type OutputGetInboundParseWebhooks added in v1.1.1 

type OutputGetInboundParseWebhooks struct {
	Result []*InboundParseWebhook `json:"result,omitempty"`
}

type OutputGetInvalidEmails added in v1.6.0 

type OutputGetInvalidEmails struct {
	InvalidEmails []InvalidEmail `json:"invalid_emails,omitempty"`
}

OutputGetInvalidEmails represents the response for invalid emails list

type OutputGetOpenTrackingSettings added in v0.0.18 

type OutputGetOpenTrackingSettings struct {
	Enabled bool `json:"enabled,omitempty"`
}

type OutputGetPendingTeammates 

type OutputGetPendingTeammates struct {
	PendingTeammates []PendingTeammate `json:"result,omitempty"`
}

type OutputGetPreBuiltDesigns added in v1.10.0 

type OutputGetPreBuiltDesigns struct {
	Result   []*Design `json:"result,omitempty"`
	Metadata _Metadata `json:"_metadata,omitempty"`
}

type OutputGetReverseDNS added in v0.0.17 

type OutputGetReverseDNS struct {
	ID                      int64   `json:"id,omitempty"`
	IP                      string  `json:"ip,omitempty"`
	RDNS                    string  `json:"rdns,omitempty"`
	Users                   []*User `json:"users,omitempty"`
	Subdomain               string  `json:"subdomain,omitempty"`
	Domain                  string  `json:"domain,omitempty"`
	Valid                   bool    `json:"valid,omitempty"`
	Legacy                  bool    `json:"legacy,omitempty"`
	LastValidationAttemptAt int64   `json:"last_validation_attempt_at,omitempty"`
	ARecord                 ARecord `json:"a_record,omitempty"`
}

type OutputGetSSOCertificate added in v0.0.19 

type OutputGetSSOCertificate struct {
	ID                int64  `json:"id,omitempty"`
	PublicCertificate string `json:"public_certificate,omitempty"`
	NotBefore         int64  `json:"not_before,omitempty"`
	NotAfter          int64  `json:"not_after,omitempty"`
	IntegrationID     string `json:"integration_id,omitempty"`
}

type OutputGetSSOIntegration added in v0.0.19 

type OutputGetSSOIntegration struct {
	ID                   string `json:"id,omitempty"`
	Name                 string `json:"name,omitempty"`
	Enabled              bool   `json:"enabled,omitempty"`
	SigninURL            string `json:"signin_url,omitempty"`
	SignoutURL           string `json:"signout_url,omitempty"`
	EntityID             string `json:"entity_id,omitempty"`
	CompletedIntegration bool   `json:"completed_integration,omitempty"`
	LastUpdated          int64  `json:"last_updated,omitempty"`
	SingleSignonURL      string `json:"single_signon_url,omitempty"`
	AudienceURL          string `json:"audience_url,omitempty"`
}

type OutputGetSampleContacts added in v1.10.0 

type OutputGetSampleContacts struct {
	Result       []*Contact `json:"result,omitempty"`
	ContactCount int64      `json:"contact_count,omitempty"`
	Metadata     _Metadata  `json:"_metadata,omitempty"`
}

type OutputGetScheduledSend added in v1.10.0 

type OutputGetScheduledSend struct {
	BatchID string `json:"batch_id,omitempty"`
	Status  string `json:"status,omitempty"`
}

type OutputGetSignedEventWebhooksPublicKey added in v1.7.0 

type OutputGetSignedEventWebhooksPublicKey struct {
	PublicKey string `json:"public_key,omitempty"`
}

type OutputGetSpamReports added in v1.6.0 

type OutputGetSpamReports struct {
	SpamReports []SpamReport `json:"spam_reports,omitempty"`
}

OutputGetSpamReports represents the response for spam reports list

type OutputGetSubscriptionTrackingSettings added in v0.0.18 

type OutputGetSubscriptionTrackingSettings struct {
	Enabled      bool   `json:"enabled,omitempty"`
	HTMLContent  string `json:"html_content,omitempty"`
	Landing      string `json:"landing,omitempty"`
	PlainContent string `json:"plain_content,omitempty"`
	Replace      string `json:"replace,omitempty"`
	URL          string `json:"url,omitempty"`
}
type OutputGetSubuserBrandedLink struct {
	ID        int64          `json:"id,omitempty"`
	Domain    string         `json:"domain,omitempty"`
	Subdomain string         `json:"subdomain,omitempty"`
	Username  string         `json:"username,omitempty"`
	UserID    int64          `json:"user_id,omitempty"`
	Default   bool           `json:"default,omitempty"`
	Valid     bool           `json:"valid,omitempty"`
	Legacy    bool           `json:"legacy,omitempty"`
	DNS       DNSBrandedLink `json:"dns,omitempty"`
}

type OutputGetSuppressionGroupsByEmail added in v1.10.0 

type OutputGetSuppressionGroupsByEmail struct {
	Suppressions []*ASMSuppressionGroup `json:"suppressions,omitempty"`
}

type OutputGetTeammate 

type OutputGetTeammate struct {
	Username  string   `json:"username,omitempty"`
	FirstName string   `json:"first_name,omitempty"`
	LastName  string   `json:"last_name,omitempty"`
	Email     string   `json:"email,omitempty"`
	Scopes    []string `json:"scopes,omitempty"`
	UserType  string   `json:"user_type,omitempty"`
	IsAdmin   bool     `json:"is_admin,omitempty"`
	Phone     string   `json:"phone,omitempty"`
	Website   string   `json:"website,omitempty"`
	Address   string   `json:"address,omitempty"`
	Address2  string   `json:"address2,omitempty"`
	City      string   `json:"city,omitempty"`
	State     string   `json:"state,omitempty"`
	Zip       string   `json:"zip,omitempty"`
	Country   string   `json:"country,omitempty"`
}

type OutputGetTeammateSubuserAccess added in v1.3.0 

type OutputGetTeammateSubuserAccess struct {
	HasRestrictedSubuserAccess bool                             `json:"has_restricted_subuser_access,omitempty"`
	SubuserAccess              []SubuserAccess                  `json:"subuser_access,omitempty"`
	Metadata                   MetadataGetTeammateSubuserAccess `json:"_metadata,omitempty"`
}

type OutputGetTeammates 

type OutputGetTeammates struct {
	Teammates []Teammate `json:"result,omitempty"`
}

type OutputGetTemplate added in v0.0.14 

type OutputGetTemplate struct {
	ID         string    `json:"id,omitempty"`
	Name       string    `json:"name,omitempty"`
	Generation string    `json:"generation,omitempty"`
	UpdatedAt  string    `json:"updated_at,omitempty"`
	Versions   []Version `json:"versions,omitempty"`
	Warning    Warning   `json:"warning,omitempty"`
}

type OutputGetTemplateVersion added in v0.0.14 

type OutputGetTemplateVersion struct {
	ID                   string  `json:"id,omitempty"`
	TemplateID           string  `json:"template_id,omitempty"`
	Active               int     `json:"active,omitempty"`
	Name                 string  `json:"name,omitempty"`
	HTMLContent          string  `json:"html_content,omitempty"`
	PlainContent         string  `json:"plain_content,omitempty"`
	GeneratePlainContent bool    `json:"generate_plain_content,omitempty"`
	Subject              string  `json:"subject,omitempty"`
	Editor               string  `json:"editor,omitempty"`
	TestData             string  `json:"test_data,omitempty"`
	UpdatedAt            string  `json:"updated_at,omitempty"`
	Warnings             Warning `json:"warnings,omitempty"`
	ThumbnailURL         string  `json:"thumbnail_url,omitempty"`
}

type OutputGetTemplates added in v0.0.14 

type OutputGetTemplates struct {
	Templates []Template `json:"result,omitempty"`
	Metadata  Metadata   `json:"_metadata,omitempty"`
}

type OutputGetTotalContactCount added in v1.10.0 

type OutputGetTotalContactCount struct {
	ContactCount      int64                     `json:"contact_count,omitempty"`
	BillableCount     int64                     `json:"billable_count,omitempty"`
	BillableBreakdown *ContactBillableBreakdown `json:"billable_breakdown,omitempty"`
}

type OutputGetTrackingSettings added in v0.0.18 

type OutputGetTrackingSettings struct {
	Result []*ResultGetTrackingSettings `json:"result,omitempty"`
}

type OutputGetVerifiedSenders added in v0.0.10 

type OutputGetVerifiedSenders struct {
	VerifiedSenders []*VerifiedSender `json:"results,omitempty"`
}

type OutputImportContacts added in v1.10.0 

type OutputImportContacts struct {
	JobID         string                        `json:"job_id,omitempty"`
	UploadURI     string                        `json:"upload_uri,omitempty"`
	UploadHeaders []*ImportContactsUploadHeader `json:"upload_headers,omitempty"`
}

type OutputInviteTeammate 

type OutputInviteTeammate struct {
	Token   string   `json:"token,omitempty"`
	Email   string   `json:"email"`
	IsAdmin bool     `json:"is_admin"`
	Scopes  []string `json:"scopes"`
}

type OutputSearchContacts added in v1.10.0 

type OutputSearchContacts struct {
	Result       []*Contact `json:"result,omitempty"`
	ContactCount int64      `json:"contact_count,omitempty"`
	Metadata     _Metadata  `json:"_metadata,omitempty"`
}

type OutputSendMail added in v1.6.0 

type OutputSendMail struct {
	MessageID string `json:"message-id,omitempty"`
}

OutputSendMail represents the response from sending mail

type OutputSubuserAccess added in v1.2.0 

type OutputSubuserAccess struct {
	ID             int64    `json:"id,omitempty"`
	Username       string   `json:"username,omitempty"`
	Email          string   `json:"email,omitempty"`
	Disabled       bool     `json:"disabled,omitempty"`
	PermissionType string   `json:"permission_type,omitempty"`
	Scopes         []string `json:"scopes,omitempty"`
}

type OutputToggleSignatureVerification added in v1.7.0 

type OutputToggleSignatureVerification struct {
	ID        string `json:"id,omitempty"`
	PublicKey string `json:"public_key,omitempty"`
}

type OutputUpdateAPIKeyName added in v0.0.2 

type OutputUpdateAPIKeyName struct {
	ApiKeyId string `json:"api_key_id,omitempty"`
	Name     string `json:"name,omitempty"`
}

type OutputUpdateAPIKeyNameAndScopes added in v0.0.2 

type OutputUpdateAPIKeyNameAndScopes struct {
	ApiKeyId string   `json:"api_key_id,omitempty"`
	Name     string   `json:"name"`
	Scopes   []string `json:"scopes,omitempty"`
}

type OutputUpdateAlert added in v1.4.0 

type OutputUpdateAlert struct {
	ID         int64  `json:"id,omitempty"`
	EmailTo    string `json:"email_to,omitempty"`
	Frequency  string `json:"frequency,omitempty"`
	Type       string `json:"type,omitempty"`
	Percentage int64  `json:"percentage,omitempty"`
	CreatedAt  int64  `json:"created_at,omitempty"`
	UpdatedAt  int64  `json:"updated_at,omitempty"`
}

type OutputUpdateBounceSettings added in v1.8.1 

type OutputUpdateBounceSettings struct {
	Enabled     bool  `json:"enabled,omitempty"`
	SoftBounces int64 `json:"soft_bounces,omitempty"`
	HardBounces int64 `json:"hard_bounces,omitempty"`
}
type OutputUpdateBrandedLink struct {
	ID        int64          `json:"id,omitempty"`
	Domain    string         `json:"domain,omitempty"`
	Subdomain string         `json:"subdomain,omitempty"`
	Username  string         `json:"username,omitempty"`
	UserID    int64          `json:"user_id,omitempty"`
	Default   bool           `json:"default,omitempty"`
	Valid     bool           `json:"valid,omitempty"`
	Legacy    bool           `json:"legacy,omitempty"`
	DNS       DNSBrandedLink `json:"dns,omitempty"`
}

type OutputUpdateClickTrackingSettings added in v0.0.18 

type OutputUpdateClickTrackingSettings struct {
	EnableText bool `json:"enable_text,omitempty"`
	Enabled    bool `json:"enabled,omitempty"`
}

type OutputUpdateDesign added in v1.0.3 

type OutputUpdateDesign struct {
	ID                   string   `json:"id,omitempty"`
	UpdatedAt            string   `json:"updated_at,omitempty"`
	CreatedAt            string   `json:"created_at,omitempty"`
	ThumbnailURL         string   `json:"thumbnail_url,omitempty"`
	Name                 string   `json:"name,omitempty"`
	Editor               string   `json:"editor,omitempty"`
	HTMLContent          string   `json:"html_content,omitempty"`
	PlainContent         string   `json:"plain_content,omitempty"`
	GeneratePlainContent bool     `json:"generate_plain_content,omitempty"`
	Subject              string   `json:"subject,omitempty"`
	Categories           []string `json:"categories,omitempty"`
}

type OutputUpdateDomainAuthentication added in v0.0.6 

type OutputUpdateDomainAuthentication struct {
	ID                      int64                         `json:"id,omitempty"`
	UserID                  int64                         `json:"user_id,omitempty"`
	Subdomain               string                        `json:"subdomain,omitempty"`
	Domain                  string                        `json:"domain,omitempty"`
	Username                string                        `json:"username,omitempty"`
	IPs                     []string                      `json:"ips,omitempty"`
	CustomSpf               bool                          `json:"custom_spf,omitempty"`
	Default                 bool                          `json:"default,omitempty"`
	Legacy                  bool                          `json:"legacy,omitempty"`
	AutomaticSecurity       bool                          `json:"automatic_security,omitempty"`
	Valid                   bool                          `json:"valid,omitempty"`
	DNS                     DNS                           `json:"dns,omitempty"`
	Subusers                []SubuserSenderAuthentication `json:"subusers,omitempty"`
	LastValidationAttemptAt int64                         `json:"last_validation_attempt_at,omitempty"`
}

type OutputUpdateEnforceTLS added in v0.0.15 

type OutputUpdateEnforceTLS struct {
	RequireTLS       bool    `json:"require_tls,omitempty"`
	RequireValidCert bool    `json:"require_valid_cert,omitempty"`
	Version          float64 `json:"version,omitempty"`
}

type OutputUpdateEventWebhook added in v1.0.2 

type OutputUpdateEventWebhook struct {
	ID               string `json:"id,omitempty"`
	Enabled          bool   `json:"enabled,omitempty"`
	URL              string `json:"url,omitempty"`
	GroupResubscribe bool   `json:"group_resubscribe,omitempty"`
	Delivered        bool   `json:"delivered,omitempty"`
	GroupUnsubscribe bool   `json:"group_unsubscribe,omitempty"`
	SpamReport       bool   `json:"spam_report,omitempty"`
	Bounce           bool   `json:"bounce,omitempty"`
	Deferred         bool   `json:"deferred,omitempty"`
	Unsubscribe      bool   `json:"unsubscribe,omitempty"`
	Processed        bool   `json:"processed,omitempty"`
	Open             bool   `json:"open,omitempty"`
	Click            bool   `json:"click,omitempty"`
	Dropped          bool   `json:"dropped,omitempty"`
	FriendlyName     string `json:"friendly_name,omitempty"`
	CreatedDate      string `json:"created_date,omitempty"`
	UpdatedDate      string `json:"updated_date,omitempty"`
	OAuthClientID    string `json:"oauth_client_id,omitempty"`
	OAuthTokenURL    string `json:"oauth_token_url,omitempty"`
}

type OutputUpdateGoogleAnalyticsSettings added in v0.0.18 

type OutputUpdateGoogleAnalyticsSettings struct {
	Enabled     bool   `json:"enabled,omitempty"`
	UTMCampaign string `json:"utm_campaign,omitempty"`
	UTMContent  string `json:"utm_content,omitempty"`
	UTMMedium   string `json:"utm_medium,omitempty"`
	UTMSource   string `json:"utm_source,omitempty"`
	UTMTerm     string `json:"utm_term,omitempty"`
}

type OutputUpdateInboundParseWebhook added in v1.1.1 

type OutputUpdateInboundParseWebhook struct {
	URL       string `json:"url,omitempty"`
	Hostname  string `json:"hostname,omitempty"`
	SpamCheck bool   `json:"spam_check,omitempty"`
	SendRaw   bool   `json:"send_raw,omitempty"`
}

type OutputUpdateOpenTrackingSettings added in v0.0.18 

type OutputUpdateOpenTrackingSettings struct {
	Enabled bool `json:"enabled,omitempty"`
}

type OutputUpdateSSOCertificate added in v0.0.19 

type OutputUpdateSSOCertificate struct {
	ID                int64  `json:"id,omitempty"`
	PublicCertificate string `json:"public_certificate,omitempty"`
	NotBefore         int64  `json:"not_before,omitempty"`
	NotAfter          int64  `json:"not_after,omitempty"`
	IntegrationID     string `json:"integration_id,omitempty"`
}

type OutputUpdateSSOIntegration added in v0.0.19 

type OutputUpdateSSOIntegration struct {
	ID                   string `json:"id,omitempty"`
	Name                 string `json:"name,omitempty"`
	Enabled              bool   `json:"enabled,omitempty"`
	SigninURL            string `json:"signin_url,omitempty"`
	SignoutURL           string `json:"signout_url,omitempty"`
	EntityID             string `json:"entity_id,omitempty"`
	CompletedIntegration bool   `json:"completed_integration,omitempty"`
	LastUpdated          int64  `json:"last_updated,omitempty"`
	SingleSignonURL      string `json:"single_signon_url,omitempty"`
	AudienceURL          string `json:"audience_url,omitempty"`
}

type OutputUpdateSSOTeammate added in v1.2.0 

type OutputUpdateSSOTeammate struct {
	Address                    string                `json:"address,omitempty"`
	Address2                   string                `json:"address2,omitempty"`
	City                       string                `json:"city,omitempty"`
	Company                    string                `json:"company,omitempty"`
	Country                    string                `json:"country,omitempty"`
	Username                   string                `json:"username,omitempty"`
	Phone                      string                `json:"phone,omitempty"`
	State                      string                `json:"state,omitempty"`
	UserType                   string                `json:"user_type,omitempty"`
	Website                    string                `json:"website,omitempty"`
	Zip                        string                `json:"zip,omitempty"`
	FirstName                  string                `json:"first_name,omitempty"`
	LastName                   string                `json:"last_name,omitempty"`
	Email                      string                `json:"email,omitempty"`
	IsAdmin                    bool                  `json:"is_admin,omitempty"`
	IsSSO                      bool                  `json:"is_sso,omitempty"`
	Scopes                     []string              `json:"scopes,omitempty"`
	HasRestrictedSubuserAccess bool                  `json:"has_restricted_subuser_access,omitempty"`
	SubuserAccess              []OutputSubuserAccess `json:"subuser_access,omitempty"`
}

type OutputUpdateSubscriptionTrackingSettings added in v0.0.18 

type OutputUpdateSubscriptionTrackingSettings struct {
	Enabled      bool   `json:"enabled,omitempty"`
	HTMLContent  string `json:"html_content,omitempty"`
	Landing      string `json:"landing,omitempty"`
	PlainContent string `json:"plain_content,omitempty"`
	Replace      string `json:"replace,omitempty"`
	URL          string `json:"url,omitempty"`
}

type OutputUpdateSuppressionGroup added in v0.0.13 

type OutputUpdateSuppressionGroup struct {
	ID              int64  `json:"id,omitempty"`
	Name            string `json:"name,omitempty"`
	Description     string `json:"description,omitempty"`
	IsDefault       bool   `json:"is_default,omitempty"`
	LastEmailSentAt string `json:"last_email_sent_at,omitempty"`
	Unsubscribes    int64  `json:"unsubscribes,omitempty"`
}

type OutputUpdateTeammatePermissions 

type OutputUpdateTeammatePermissions struct {
	Username  string   `json:"username,omitempty"`
	FirstName string   `json:"first_name,omitempty"`
	LastName  string   `json:"last_name,omitempty"`
	Email     string   `json:"email,omitempty"`
	Scopes    []string `json:"scopes,omitempty"`
	UserType  string   `json:"user_type,omitempty"`
	IsAdmin   bool     `json:"is_admin,omitempty"`
	Phone     string   `json:"phone,omitempty"`
	Website   string   `json:"website,omitempty"`
	Address   string   `json:"address,omitempty"`
	Address2  string   `json:"address2,omitempty"`
	City      string   `json:"city,omitempty"`
	State     string   `json:"state,omitempty"`
	Zip       string   `json:"zip,omitempty"`
	Country   string   `json:"country,omitempty"`
}

type OutputUpdateTemplate added in v0.0.14 

type OutputUpdateTemplate struct {
	ID         string    `json:"id,omitempty"`
	Name       string    `json:"name,omitempty"`
	Generation string    `json:"generation,omitempty"`
	UpdatedAt  string    `json:"updated_at,omitempty"`
	Versions   []Version `json:"versions,omitempty"`
}

type OutputUpdateTemplateVersion added in v0.0.14 

type OutputUpdateTemplateVersion struct {
	ID                   string    `json:"id,omitempty"`
	TemplateID           string    `json:"template_id,omitempty"`
	Active               int       `json:"active,omitempty"`
	Name                 string    `json:"name,omitempty"`
	HTMLContent          string    `json:"html_content,omitempty"`
	PlainContent         string    `json:"plain_content,omitempty"`
	GeneratePlainContent bool      `json:"generate_plain_content,omitempty"`
	Subject              string    `json:"subject,omitempty"`
	Editor               string    `json:"editor,omitempty"`
	TestData             string    `json:"test_data,omitempty"`
	UpdatedAt            string    `json:"updated_at,omitempty"`
	Warnings             []Warning `json:"warnings,omitempty"`
	ThumbnailURL         string    `json:"thumbnail_url,omitempty"`
}

type OutputUpdateVerifiedSender added in v0.0.10 

type OutputUpdateVerifiedSender struct {
	ID          int64  `json:"id,omitempty"`
	Nickname    string `json:"nickname,omitempty"`
	FromEmail   string `json:"from_email,omitempty"`
	FromName    string `json:"from_name,omitempty"`
	ReplyTo     string `json:"reply_to,omitempty"`
	ReplyToName string `json:"reply_to_name,omitempty"`
	Address     string `json:"address,omitempty"`
	Address2    string `json:"address2,omitempty"`
	State       string `json:"state,omitempty"`
	City        string `json:"city,omitempty"`
	Zip         string `json:"zip,omitempty"`
	Country     string `json:"country,omitempty"`
	Verified    bool   `json:"verified,omitempty"`
	Locked      bool   `json:"locked,omitempty"`
}

type OutputValidateBatchID added in v1.10.0 

type OutputValidateBatchID struct {
	BatchID string `json:"batch_id,omitempty"`
}
type OutputValidateBrandedLink struct {
	ID                int64                        `json:"id,omitempty"`
	Valid             bool                         `json:"valid,omitempty"`
	ValidationResults ValidationResultsBrandedLink `json:"validation_results,omitempty"`
}

type OutputValidateDomainAuthentication added in v0.0.6 

type OutputValidateDomainAuthentication struct {
	ID                int64             `json:"id,omitempty"`
	Valid             bool              `json:"valid,omitempty"`
	ValidationResults ValidationResults `json:"validation_results,omitempty"`
}

type OutputValidateReverseDNS added in v0.0.17 

type OutputValidateReverseDNS struct {
	ID                int64                       `json:"id,omitempty"`
	Valid             bool                        `json:"valid,omitempty"`
	ValidationResults ValidationResultsReverseDNS `json:"validation_results,omitempty"`
}

type PendingTeammate 

type PendingTeammate struct {
	Email          string   `json:"email,omitempty"`
	Scopes         []string `json:"scopes,omitempty"`
	IsAdmin        bool     `json:"is_admin,omitempty"`
	Token          string   `json:"token,omitempty"`
	ExpirationDate int      `json:"expiration_date,omitempty"`
}

type Personalization added in v1.6.0 

type Personalization struct {
	To                  []*Email               `json:"to,omitempty"`
	Cc                  []*Email               `json:"cc,omitempty"`
	Bcc                 []*Email               `json:"bcc,omitempty"`
	Subject             string                 `json:"subject,omitempty"`
	Headers             map[string]string      `json:"headers,omitempty"`
	Substitutions       map[string]string      `json:"substitutions,omitempty"`
	DynamicTemplateData map[string]interface{} `json:"dynamic_template_data,omitempty"`
	CustomArgs          map[string]string      `json:"custom_args,omitempty"`
	SendAt              int64                  `json:"send_at,omitempty"`
}

Personalization contains personalized data for recipients

func NewPersonalization added in v1.6.0 

func NewPersonalization() *Personalization

NewPersonalization creates a new Personalization struct

func (*Personalization) AddBcc added in v1.6.0 

func (p *Personalization) AddBcc(email *Email)

AddBcc adds a BCC recipient to personalization

func (*Personalization) AddCc added in v1.6.0 

func (p *Personalization) AddCc(email *Email)

AddCc adds a CC recipient to personalization

func (*Personalization) AddTo added in v1.6.0 

func (p *Personalization) AddTo(email *Email)

AddTo adds a recipient to personalization

func (*Personalization) SetSendAt added in v1.6.0 

func (p *Personalization) SetSendAt(sendAt time.Time)

SetSendAt sets the send time for personalization

type RateLimitedError added in v1.0.0 

type RateLimitedError struct {
	RetryAfter time.Duration
}

func (*RateLimitedError) Error added in v1.0.0 

func (e *RateLimitedError) Error() string

type Record added in v0.0.6 

type Record struct {
	Valid bool   `json:"valid,omitempty"`
	Type  string `json:"type,omitempty"`
	Host  string `json:"host,omitempty"`
	Data  string `json:"data,omitempty"`
}

type ReplyTo added in v1.6.0 

type ReplyTo struct {
	Email string `json:"email"`
	Name  string `json:"name,omitempty"`
}

ReplyTo represents reply-to settings

type ReplyToList added in v1.6.0 

type ReplyToList struct {
	Email string `json:"email"`
	Name  string `json:"name,omitempty"`
}

ReplyToList represents a list of reply-to addresses

type Reputation added in v0.0.3 

type Reputation struct {
	Reputation float64 `json:"reputation,omitempty"`
	Username   string  `json:"username,omitempty"`
}

type ResultGetTrackingSettings added in v0.0.18 

type ResultGetTrackingSettings struct {
	Name        string `json:"name,omitempty"`
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
	Enabled     bool   `json:"enabled,omitempty"`
}

type SSOCertificate added in v0.0.19 

type SSOCertificate struct {
	ID                int64  `json:"id,omitempty"`
	PublicCertificate string `json:"public_certificate,omitempty"`
	NotBefore         int64  `json:"not_before,omitempty"`
	NotAfter          int64  `json:"not_after,omitempty"`
	IntegrationID     string `json:"integration_id,omitempty"`
}

type SSOIntegration added in v0.0.19 

type SSOIntegration struct {
	ID                   string `json:"id,omitempty"`
	Name                 string `json:"name,omitempty"`
	Enabled              bool   `json:"enabled,omitempty"`
	SigninURL            string `json:"signin_url,omitempty"`
	SignoutURL           string `json:"signout_url,omitempty"`
	EntityID             string `json:"entity_id,omitempty"`
	CompletedIntegration bool   `json:"completed_integration,omitempty"`
	LastUpdated          int64  `json:"last_updated,omitempty"`
	SingleSignonURL      string `json:"single_signon_url,omitempty"`
	AudienceURL          string `json:"audience_url,omitempty"`
}

type ScheduledSend added in v1.10.0 

type ScheduledSend struct {
	BatchID string `json:"batch_id,omitempty"`
	Status  string `json:"status,omitempty"`
}

type Setting added in v1.6.0 

type Setting struct {
	Enable *bool `json:"enable,omitempty"`
}

Setting represents a boolean setting

type SpamCheckSetting added in v1.6.0 

type SpamCheckSetting struct {
	Enable    *bool  `json:"enable,omitempty"`
	Threshold int    `json:"threshold,omitempty"`
	PostToURL string `json:"post_to_url,omitempty"`
}

SpamCheckSetting represents spam check settings

type SpamReport added in v1.6.0 

type SpamReport struct {
	Created int64  `json:"created"`
	Email   string `json:"email"`
	IP      string `json:"ip"`
}

SpamReport represents a spam report

type Stat added in v1.6.0 

type Stat struct {
	Date  string     `json:"date,omitempty"`
	Stats []StatItem `json:"stats,omitempty"`
}

Stat represents statistics data

type StatItem added in v1.6.0 

type StatItem struct {
	Metrics StatMetrics `json:"metrics,omitempty"`
	Name    string      `json:"name,omitempty"`
	Type    string      `json:"type,omitempty"`
}

StatItem represents individual statistic metrics

type StatMetrics added in v1.6.0 

type StatMetrics struct {
	Blocks           int `json:"blocks,omitempty"`
	BounceDrops      int `json:"bounce_drops,omitempty"`
	Bounces          int `json:"bounces,omitempty"`
	Clicks           int `json:"clicks,omitempty"`
	DeferredDrops    int `json:"deferred_drops,omitempty"`
	Delivered        int `json:"delivered,omitempty"`
	InvalidEmails    int `json:"invalid_emails,omitempty"`
	Opens            int `json:"opens,omitempty"`
	Processed        int `json:"processed,omitempty"`
	Requests         int `json:"requests,omitempty"`
	SpamReportDrops  int `json:"spam_report_drops,omitempty"`
	SpamReports      int `json:"spam_reports,omitempty"`
	UniqueClicks     int `json:"unique_clicks,omitempty"`
	UniqueOpens      int `json:"unique_opens,omitempty"`
	UnsubscribeDrops int `json:"unsubscribe_drops,omitempty"`
	Unsubscribes     int `json:"unsubscribes,omitempty"`
}

StatMetrics represents metric data

type StatsOptions added in v1.6.0 

type StatsOptions struct {
	StartDate   string   `url:"start_date,omitempty"`
	EndDate     string   `url:"end_date,omitempty"`
	Aggregation string   `url:"aggregated_by,omitempty"`
	Categories  []string `url:"-"`
	Subusers    []string `url:"-"`
	Tags        []string `url:"-"`
	Limit       int      `url:"limit,omitempty"`
	Offset      int      `url:"offset,omitempty"`
}

StatsOptions represents query parameters for stats requests

type SubscriptionTrackingSetting added in v1.6.0 

type SubscriptionTrackingSetting struct {
	Enable          *bool  `json:"enable,omitempty"`
	Text            string `json:"text,omitempty"`
	HTML            string `json:"html,omitempty"`
	SubstitutionTag string `json:"substitution_tag,omitempty"`
}

SubscriptionTrackingSetting represents subscription tracking settings

type Subuser added in v0.0.3 

type Subuser struct {
	ID       int64  `json:"id,omitempty"`
	Disabled bool   `json:"disabled,omitempty"`
	Username string `json:"username,omitempty"`
	Email    string `json:"email,omitempty"`
	Region   string `json:"region,omitempty"`
}

type SubuserAccess added in v1.3.0 

type SubuserAccess struct {
	ID             int64    `json:"id,omitempty"`
	Username       string   `json:"username,omitempty"`
	Email          string   `json:"email,omitempty"`
	Disabled       bool     `json:"disabled,omitempty"`
	PermissionType string   `json:"permission_type,omitempty"`
	Scopes         []string `json:"scopes,omitempty"`
}

type SubuserSenderAuthentication added in v0.0.6 

type SubuserSenderAuthentication struct {
	UserID   int64  `json:"user_id,omitempty"`
	Username string `json:"username,omitempty"`
}

type SubuserStat added in v1.6.0 

type SubuserStat struct {
	Date  string     `json:"date,omitempty"`
	Stats []StatItem `json:"stats,omitempty"`
}

SubuserStat represents subuser statistics

type Suppression added in v1.10.0 

type Suppression struct {
	Email     string `json:"email,omitempty"`
	GroupID   int64  `json:"group_id,omitempty"`
	GroupName string `json:"group_name,omitempty"`
	CreatedAt int64  `json:"created_at,omitempty"`
}

type SuppressionGroup added in v0.0.13 

type SuppressionGroup struct {
	ID              int64  `json:"id,omitempty"`
	Name            string `json:"name,omitempty"`
	Description     string `json:"description,omitempty"`
	IsDefault       bool   `json:"is_default,omitempty"`
	Unsubscribes    int64  `json:"unsubscribes,omitempty"`
	LastEmailSentAt string `json:"last_email_sent_at,omitempty"`
}

type SuppressionListOptions added in v1.6.0 

type SuppressionListOptions struct {
	StartTime int64  `url:"start_time,omitempty"`
	EndTime   int64  `url:"end_time,omitempty"`
	Limit     int    `url:"limit,omitempty"`
	Offset    int    `url:"offset,omitempty"`
	Email     string `url:"email,omitempty"`
}

SuppressionListOptions represents query parameters for suppression list requests

type Teammate 

type Teammate struct {
	Username  string `json:"username,omitempty"`
	Email     string `json:"email,omitempty"`
	FirstName string `json:"first_name,omitempty"`
	LastName  string `json:"last_name,omitempty"`
	UserType  string `json:"user_type,omitempty"`
	IsAdmin   bool   `json:"is_admin,omitempty"`
	Phone     string `json:"phone,omitempty"`
	Website   string `json:"website,omitempty"`
	Address   string `json:"address,omitempty"`
	Address2  string `json:"address2,omitempty"`
	City      string `json:"city,omitempty"`
	State     string `json:"state,omitempty"`
	Zip       string `json:"zip,omitempty"`
	Country   string `json:"country,omitempty"`
}

type Template added in v0.0.14 

type Template struct {
	ID         string    `json:"id,omitempty"`
	Name       string    `json:"name,omitempty"`
	Generation string    `json:"generation,omitempty"`
	UpdatedAt  string    `json:"updated_at,omitempty"`
	Versions   []Version `json:"versions,omitempty"`
}

type TrackingSettings added in v1.6.0 

type TrackingSettings struct {
	ClickTracking        *ClickTrackingSetting        `json:"click_tracking,omitempty"`
	OpenTracking         *OpenTrackingSetting         `json:"open_tracking,omitempty"`
	SubscriptionTracking *SubscriptionTrackingSetting `json:"subscription_tracking,omitempty"`
	GoogleAnalytics      *GoogleAnalyticsSetting      `json:"ganalytics,omitempty"`
}

TrackingSettings contains various tracking settings

type User added in v0.0.17 

type User struct {
	Username string `json:"username,omitempty"`
	UserID   int64  `json:"user_id,omitempty"`
}

type ValidationResult added in v0.0.6 

type ValidationResult struct {
	Valid  bool   `json:"valid,omitempty"`
	Reason string `json:"reason,omitempty"`
}

type ValidationResults added in v0.0.6 

type ValidationResults struct {
	MailCname ValidationResult `json:"mail_cname,omitempty"`
	Dkim1     ValidationResult `json:"dkim1,omitempty"`
	Dkim2     ValidationResult `json:"dkim2,omitempty"`
	SPF       ValidationResult `json:"spf,omitempty"`
}
type ValidationResultsBrandedLink struct {
	DomainCname ValidationResult `json:"domain_cname,omitempty"`
	OwnerCname  ValidationResult `json:"owner_cname,omitempty"`
}

type ValidationResultsReverseDNS added in v0.0.17 

type ValidationResultsReverseDNS struct {
	ARecordValidationResults ARecordValidationResults `json:"a_record,omitempty"`
}

type VerifiedSender added in v0.0.10 

type VerifiedSender struct {
	ID          int64  `json:"id,omitempty"`
	Nickname    string `json:"nickname,omitempty"`
	FromEmail   string `json:"from_email,omitempty"`
	FromName    string `json:"from_name,omitempty"`
	ReplyTo     string `json:"reply_to,omitempty"`
	ReplyToName string `json:"reply_to_name,omitempty"`
	Address     string `json:"address,omitempty"`
	Address2    string `json:"address2,omitempty"`
	State       string `json:"state,omitempty"`
	City        string `json:"city,omitempty"`
	Zip         string `json:"zip,omitempty"`
	Country     string `json:"country,omitempty"`
	Verified    bool   `json:"verified,omitempty"`
	Locked      bool   `json:"locked,omitempty"`
}

type Version added in v0.0.14 

type Version struct {
	ID                   string `json:"id,omitempty"`
	TemplateID           string `json:"template_id,omitempty"`
	Name                 string `json:"name,omitempty"`
	Subject              string `json:"subject,omitempty"`
	UpdatedAt            string `json:"updated_at,omitempty"`
	GeneratePlainContent bool   `json:"generate_plain_content,omitempty"`
	HTMLContent          string `json:"html_content,omitempty"`
	PlainContent         string `json:"plain_content,omitempty"`
	Editor               string `json:"editor,omitempty"`
	ThumbnailURL         string `json:"thumbnail_url,omitempty"`
}

type Warning added in v0.0.14 

type Warning struct {
	Message string `json:"message,omitempty"`
}

Source Files

View all Source files

Directories

Path Synopsis
cmd
scraper command
examples
activate_template_version command
add_ip_to_authenticated_domain command
associate_authenticated_domain_with_subuser command
associate_branded_link_with_subuser command
authenticate_domain command
create_alert command
create_api_key command
create_branded_link command
create_design command
create_event_webhook command
create_inbound_parse_webhook command
create_sso_teammate command
create_subuser command
create_suppression_group command
create_template command
create_template_version command
create_verified_sender_request command
delete_alert command
delete_api_key command
delete_branded_link command
delete_design command
delete_inbound_parse_webhook command
delete_pending_teammate command
delete_subuser command
delete_suppression_group command
delete_teammate command
delete_template command
delete_template_version command
disassociate_authenticated_domain_from_subuser command
disassociate_branded_link_with_subuser command
duplicate_template command
get_alert command
get_alerts command
get_api_key command
get_api_keys command
get_authenticated_domain command
get_authenticated_domains command
get_bounce_settings command
get_bounces command
get_branded_link command
get_branded_links command
get_default_authentication command
get_design command
get_designs command
get_enforce_tls command
get_global_stats command
get_inbound_parse_webhook command
get_inbound_parse_webhooks command
get_ip_address command
get_reverse_dnss command
get_signed_event_webhooks_public_key command
get_subuser command
get_subuser_branded_link command
get_subuser_reputation command
get_subusers command
get_suppression_group command
get_suppression_groups command
get_teammate command
get_teammate_subuser_access command
get_teammates command
get_template command
get_template_version command
get_templates command
get_tracking_settings command
get_verified_senders command
get_verified_senders_warn_list command
invite_teammate command
pending_teammates command
remove_ip_from_authenticated_domain command
resend_verified_sender_request command
send_mail command
toggle_signature_verification command
update_alert command
update_api_key_name command
update_api_key_name_and_scopes command
update_bounce_settings command
update_branded_link command
update_design command
update_domain_authentication command
update_inbound_parse_webhook command
update_sender_verification command
update_sso_teammate command
update_subuser command
update_suppression_group command
update_teammate_permissions command
update_template command
update_template_version command
update_verified_sender command
validate_branded_link command
validate_domain_authentication command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.