addyrest

package module
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Dec 24, 2024 License: MIT Imports: 9 Imported by: 0

README

addyrest

Addy RESTful API client library.

builds.sr.ht status Go Reference

INSTALL

Enter your project folder, and issue go get:

go get git.sr.ht/~kovmir/addyrest

USAGE

Go to your account settings to issue a new token, and then:

package main

import (
	"fmt"

	"git.sr.ht/~kovmir/addyrest"
)

func main() {
	c := addyrest.NewClient("YOUR_TOKEN")

	// Get token name.
	details, err := c.TokenGetAPIDetails()
	if err != nil {
		panic(err)
	}
	fmt.Printf("Token name: %s\n", details.Name)

	// Get first 5 active aliases.
	aliases, err := c.AliasesGet(&addyrest.AliasesGetArgs{
		Filter:   map[string]string{"active": "true"},
		PageSize: 5,
	})
	if err != nil {
		panic(err)
	}
	for i, v := range aliases.Data {
		fmt.Printf("%d. %s\n", i, v.Email)
	}

	// Create a new UUID alias.
	alias, err := c.AliasNew(&addyrest.AliasNewArgs{
		Desc:   "addy client test",
		Domain: "mailer.me",
		Format: addyrest.AliasFmtUUID,
	})
	if err != nil {
		panic(err)
	}
	fmt.Printf("alias %s created successfully\n", alias.Data.ID)
}

DOCUMENTATION

The entire codebase resides within client.go, the rest of the files define methods and JSONs from Addy API reference. Each method is more or less self-descriptive and has a URL pointing to the upstream reference.

Documentation

Index

Constants

View Source 
const (
	AliasSortLocalPart  AliasSortCond = "local_part"
	AliasSortDomain     AliasSortCond = "domain"
	AliasSortEmail      AliasSortCond = "email"
	AliasSortEmailsFwd  AliasSortCond = "emails_forwarded"
	AliasSortEmailsBlkd AliasSortCond = "emails_blocked"
	AliasSortEmailsRepl AliasSortCond = "emails_replied"
	AliasSortEmailsSent AliasSortCond = "emails_sent"
	AliasSortActive     AliasSortCond = "active"
	AliasSortCreatedAt  AliasSortCond = "created_at"
	AliasSortUpdatedAt  AliasSortCond = "updated_at"
	AliasSortDeletedAt  AliasSortCond = "deleted_at"

	AliasFmtRndChars AliasFormat = "random_characters"
	AliasFmtUUID     AliasFormat = "uuid"
	AliasFmtRndWords AliasFormat = "random_words"
	AliasFmtCustom   AliasFormat = "custom"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountDetails 

type AccountDetails struct {
	ID                           string    `json:"id"`
	Username                     string    `json:"username"`
	FromName                     string    `json:"from_name"`
	EmailSubject                 string    `json:"email_subject"`
	BannerLocation               string    `json:"banner_location"`
	Bandwidth                    uint      `json:"bandwidth"`
	UsernameCount                uint      `json:"username_count"`
	UsernameLimit                uint      `json:"username_limit"`
	DefaultRecipientID           string    `json:"default_recipient_id"`
	DefaultAliasDomain           string    `json:"default_alias_domain"`
	DefaultAliasFormat           string    `json:"default_alias_format"`
	Subscription                 string    `json:"subscription"`
	SubscriptionEndsAt           *UnixTime `json:"subscription_ends_at"`
	BandwidthLimit               uint      `json:"bandwidth_limit"`
	RecipientCount               uint      `json:"recipient_count"`
	RecipientLimit               uint      `json:"recipient_limit"`
	ActiveDomainCount            uint      `json:"active_domain_count"`
	ActiveDomainLimit            uint      `json:"active_domain_limit"`
	ActiveSharedDomainAliasCount uint      `json:"active_shared_domain_alias_count"`
	ActiveSharedDomainAliasLimit uint      `json:"active_shared_domain_alias_limit"`
	TotalEmailsForwarded         uint      `json:"total_emails_forwarded"`
	TotalEmailsBlocked           uint      `json:"total_emails_blocked"`
	TotalEmailsReplied           uint      `json:"total_emails_replied"`
	TotalEmailsSent              uint      `json:"total_emails_sent"`
	CreatedAt                    UnixTime  `json:"created_at"`
	UpdatedAt                    *UnixTime `json:"updated_at"`
}

type AccountDetailsWrap 

type AccountDetailsWrap struct {
	Data AccountDetails `json:"data"`
}

type Action 

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

type Actions 

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

type AddyOperator 

type AddyOperator string
const (
	AddyANDCond AddyOperator = "AND"
	AddyORCond  AddyOperator = "OR"
)

type Alias 

type Alias struct {
	ID              string      `json:"id"`
	UserID          string      `json:"user_id"`
	AliasableID     string      `json:"aliasable_id"`
	AliasableType   string      `json:"aliasable_type"`
	LocalPart       string      `json:"local_part"`
	Extension       string      `json:"extension"`
	Domain          string      `json:"domain"`
	Email           string      `json:"email"`
	Active          bool        `json:"active"`
	Description     string      `json:"description"`
	EmailsForwarded uint        `json:"emails_forwarded"`
	EmailsBlocked   uint        `json:"emails_blocked"`
	EmailsReplied   uint        `json:"emails_replied"`
	EmailsSent      uint        `json:"emails_sent"`
	Recipients      []Recipient `json:"recipients"`
	CreatedAt       UnixTime    `json:"created_at"`
	UpdatedAt       *UnixTime   `json:"updated_at"`
	DeletedAt       *UnixTime   `json:"deleted_at"`
}

type AliasFormat 

type AliasFormat string

type AliasNewArgs 

type AliasNewArgs struct {
	// The domain of the alias.
	Domain string `json:"domain"`
	// The description of the alias
	Desc string `json:"description,omitempty"`
	// The chosen format for the alias.
	Format AliasFormat `json:"format,omitempty"`
	// The chosen local part for the alias (only required if you have the
	// format as custom)
	LocalPart string `json:"local_part,omitempty"`
	// An array of recipient ids to add (the default recipient will be used
	// if none provided)
	Recipients []string `json:"recipient_ids,omitempty"`
}

type AliasRecipientArgs 

type AliasRecipientArgs struct {
	AliasID      string   `json:"alias_id"`
	RecipientIDs []string `json:"recipient_ids"`
}

type AliasSortCond 

type AliasSortCond string

type AliasUpdateArgs 

type AliasUpdateArgs struct {
	Desc     string `json:"description,omitempty"`
	FromName string `json:"from_name,omitempty"`
}

type AliasWrap 

type AliasWrap struct {
	Data Alias `json:"data"`
}

type AliasesGetArgs 

type AliasesGetArgs struct {
	// Include deleted or only deleted:
	// Filter[deleted] = with | only
	//
	// Choose to return active or unactive aliases:
	// Filter[active] = true | false
	//
	// Search aliases by email and description.
	// Filter[search] = <search_string>
	Filter map[string]string
	// Paginate the alias results, default 100, min 1 max 100.
	PageSize uint
	// Paginate the alias results; what page number do you want?
	PageNumber uint
	// Sort aliases based on this given condition.
	SortCond AliasSortCond
	// Descending sort?
	SortDesc bool
	// Return aliases with recipients?
	WithRecipients bool
	// Return aliases using the recipient with the specified ID.
	Recipient string
	// Return aliases using the custom domain with the specified ID.
	Domain string
	// Return aliases using the username with the specified ID.
	Username string
}
type AliasesLinks struct {
	First string `json:"first"`
	Last  string `json:"last"`
	Prev  string `json:"prev"`
	Next  string `json:"next"`
}

type AliasesMeta 

type AliasesMeta struct {
	CurrentPage int                `json:"current_page"`
	From        int                `json:"from"`
	LastPage    int                `json:"last_page"`
	Links       []AliasesMetaLinks `json:"links"`
	Path        string             `json:"path"`
	PerPage     int                `json:"per_page"`
	To          int                `json:"to"`
	Total       int                `json:"total"`
}
type AliasesMetaLinks struct {
	URL    any    `json:"url"`
	Label  string `json:"label"`
	Active bool   `json:"active"`
}

type AliasesWrap 

type AliasesWrap struct {
	Data  []Alias      `json:"data"`
	Links AliasesLinks `json:"links"`
	Meta  AliasesMeta  `json:"meta"`
}

type AppVersion 

type AppVersion struct {
	Version string `json:"version"`
	Major   int    `json:"major"`
	Minor   int    `json:"minor"`
	Patch   int    `json:"patch"`
}

type Bulk 

type Bulk struct {
	Message string   `json:"message"`
	IDs     []string `json:"ids"`
}

type BulkWrap 

type BulkWrap struct {
	Data Bulk `json:"data"`
}

Responce from bulk actions.

type Client 

type Client struct {
	BaseURL string
	Token   string
	Ctx     context.Context
}

func NewClient 

func NewClient(token string) *Client

Initialize a new default API client, only provide the token.

func NewCustomClient 

func NewCustomClient(ctx context.Context, url, token string) *Client

Initialize a new API client.

func (*Client) AccountGetDetails 

func (c *Client) AccountGetDetails() (*AccountDetailsWrap, error)

https://app.addy.io/docs/#account-details-GETapi-v1-account-details

func (*Client) AliasDelete 

func (c *Client) AliasDelete(id string) error

https://app.addy.io/docs/#aliases-DELETEapi-v1-aliases--id-

func (*Client) AliasDisable 

func (c *Client) AliasDisable(id string) error

https://app.addy.io/docs/#aliases-DELETEapi-v1-active-aliases--id-

func (*Client) AliasEnable 

func (c *Client) AliasEnable(id string) (*AliasWrap, error)

https://app.addy.io/docs/#aliases-POSTapi-v1-active-aliases

func (*Client) AliasForget 

func (c *Client) AliasForget(id string) error

https://app.addy.io/docs/#aliases-DELETEapi-v1-aliases--id--forget

func (*Client) AliasGet 

func (c *Client) AliasGet(id string) (*AliasWrap, error)

https://app.addy.io/docs/#aliases-GETapi-v1-aliases--id-

func (*Client) AliasNew 

func (c *Client) AliasNew(params *AliasNewArgs) (*AliasWrap, error)

https://app.addy.io/docs/#aliases-POSTapi-v1-aliases

func (*Client) AliasRestore 

func (c *Client) AliasRestore(id string) (*AliasWrap, error)

https://app.addy.io/docs/#aliases-PATCHapi-v1-aliases--id--restore

func (*Client) AliasUpdRecipients 

func (c *Client) AliasUpdRecipients(data *AliasRecipientArgs) (*AliasWrap, error)

https://app.addy.io/docs/#aliases-POSTapi-v1-alias-recipients

func (*Client) AliasUpdate 

func (c *Client) AliasUpdate(id string, data *AliasUpdateArgs) (*AliasWrap, error)

https://app.addy.io/docs/#aliases-PATCHapi-v1-aliases--id-

func (*Client) AliasesGet 

func (c *Client) AliasesGet(params *AliasesGetArgs) (*AliasesWrap, error)

https://app.addy.io/docs/#aliases-GETapi-v1-aliases

func (*Client) AppGetVersion 

func (c *Client) AppGetVersion() (*AppVersion, error)

func (*Client) BulkAliasesDelete 

func (c *Client) BulkAliasesDelete(ids []string) (*BulkWrap, error)

https://app.addy.io/docs/#alias-bulk-actions-POSTapi-v1-aliases-delete-bulk

func (*Client) BulkAliasesDisable 

func (c *Client) BulkAliasesDisable(ids []string) (*BulkWrap, error)

https://app.addy.io/docs/#alias-bulk-actions-POSTapi-v1-aliases-deactivate-bulk

func (*Client) BulkAliasesEnable 

func (c *Client) BulkAliasesEnable(ids []string) (*BulkWrap, error)

https://app.addy.io/docs/#alias-bulk-actions-POSTapi-v1-aliases-activate-bulk

func (*Client) BulkAliasesForget 

func (c *Client) BulkAliasesForget(ids []string) (*BulkWrap, error)

https://app.addy.io/docs/#alias-bulk-actions-POSTapi-v1-aliases-forget-bulk

func (*Client) BulkAliasesGet 

func (c *Client) BulkAliasesGet(ids []string) (*AliasesWrap, error)

https://app.addy.io/docs/#alias-bulk-actions-POSTapi-v1-aliases-get-bulk

func (*Client) BulkAliasesRestore 

func (c *Client) BulkAliasesRestore(ids []string) (*BulkWrap, error)

https://app.addy.io/docs/#alias-bulk-actions-POSTapi-v1-aliases-restore-bulk

func (*Client) BulkAliasesUpdRecipients 

func (c *Client) BulkAliasesUpdRecipients(aliasIDs, recipientIDs []string) (*BulkWrap, error)

https://app.addy.io/docs/#alias-bulk-actions-POSTapi-v1-aliases-recipients-bulk

func (*Client) DomainDelete 

func (c *Client) DomainDelete(id string) error

https://app.addy.io/docs/#domains-DELETEapi-v1-domains--id-

func (*Client) DomainDisabCatchAll 

func (c *Client) DomainDisabCatchAll(id string) error

https://app.addy.io/docs/#domains-DELETEapi-v1-catch-all-domains--id-

func (*Client) DomainDisable 

func (c *Client) DomainDisable(id string) error

https://app.addy.io/docs/#domains-DELETEapi-v1-active-domains--id-

func (*Client) DomainEnabCatchAll 

func (c *Client) DomainEnabCatchAll(id string) (*DomainWrap, error)

https://app.addy.io/docs/#domains-POSTapi-v1-catch-all-domains

func (*Client) DomainEnable 

func (c *Client) DomainEnable(id string) (*DomainWrap, error)

https://app.addy.io/docs/#domains-POSTapi-v1-active-domains

func (*Client) DomainGet 

func (c *Client) DomainGet(id string) (*DomainWrap, error)

https://app.addy.io/docs/#domains-GETapi-v1-domains--id-

func (*Client) DomainGetOpts 

func (c *Client) DomainGetOpts() (*DomainOptions, error)

func (*Client) DomainNew 

func (c *Client) DomainNew(domain string) (*DomainWrap, error)

https://app.addy.io/docs/#domains-POSTapi-v1-domains

func (*Client) DomainUpdDefRecipient 

func (c *Client) DomainUpdDefRecipient(id, recipient string) (*DomainWrap, error)

https://app.addy.io/docs/#domains-PATCHapi-v1-domains--id--default-recipient

func (*Client) DomainUpdate 

func (c *Client) DomainUpdate(id string, data *DomainUpdateArgs) (*DomainWrap, error)

https://app.addy.io/docs/#domains-PATCHapi-v1-domains--id-

func (*Client) DomainsGet 

func (c *Client) DomainsGet() (*DomainsWrap, error)

https://app.addy.io/docs/#domains-GETapi-v1-domains

func (*Client) FailedDeliveriesGet 

func (c *Client) FailedDeliveriesGet() (*FailedDeliveriesWrap, error)

https://app.addy.io/docs/#failed-deliveries-GETapi-v1-failed-deliveries

func (*Client) FailedDeliveryDel 

func (c *Client) FailedDeliveryDel(id string) error

https://app.addy.io/docs/#failed-deliveries-DELETEapi-v1-failed-deliveries--id-

func (*Client) FailedDeliveryGet 

func (c *Client) FailedDeliveryGet(id string) (*FailedDeliveryWrap, error)

https://app.addy.io/docs/#failed-deliveries-GETapi-v1-failed-deliveries--id-

func (*Client) RecipientAddPubKey 

func (c *Client) RecipientAddPubKey(id, pubKey string) (*RecipientWrap, error)

https://app.addy.io/docs/#recipients-PATCHapi-v1-recipient-keys--id-

func (*Client) RecipientDelPubKey 

func (c *Client) RecipientDelPubKey(id string) error

https://app.addy.io/docs/#recipients-DELETEapi-v1-recipient-keys--id-

func (*Client) RecipientDelete 

func (c *Client) RecipientDelete(id string) error

https://app.addy.io/docs/#recipients-DELETEapi-v1-recipients--id-

func (*Client) RecipientDisabEnc 

func (c *Client) RecipientDisabEnc(id string) error

https://app.addy.io/docs/#recipients-DELETEapi-v1-encrypted-recipients--id-

func (*Client) RecipientDisabInlEnc 

func (c *Client) RecipientDisabInlEnc(id string) error

https://app.addy.io/docs/#recipients-DELETEapi-v1-inline-encrypted-recipients--id-

func (*Client) RecipientDisabProtHeads 

func (c *Client) RecipientDisabProtHeads(id string) error

https://app.addy.io/docs/#recipients-DELETEapi-v1-protected-headers-recipients--id-

func (*Client) RecipientDisabReplSend 

func (c *Client) RecipientDisabReplSend(id string) error

https://app.addy.io/docs/#recipients-DELETEapi-v1-allowed-recipients--id-

func (*Client) RecipientEnabEnc 

func (c *Client) RecipientEnabEnc(id string) (*RecipientWrap, error)

https://app.addy.io/docs/#recipients-POSTapi-v1-encrypted-recipients

func (*Client) RecipientEnabEncInl 

func (c *Client) RecipientEnabEncInl(id string) (*RecipientWrap, error)

https://app.addy.io/docs/#recipients-POSTapi-v1-inline-encrypted-recipients

func (*Client) RecipientEnabProtHead 

func (c *Client) RecipientEnabProtHead(id string) (*RecipientWrap, error)

https://app.addy.io/docs/#recipients-POSTapi-v1-protected-headers-recipients

func (*Client) RecipientEnabReplSend 

func (c *Client) RecipientEnabReplSend(id string) (*RecipientWrap, error)

https://app.addy.io/docs/#recipients-POSTapi-v1-allowed-recipients

func (*Client) RecipientGet 

func (c *Client) RecipientGet(id string) (*RecipientWrap, error)

https://app.addy.io/docs/#recipients-GETapi-v1-recipients--id-

func (*Client) RecipientNew 

func (c *Client) RecipientNew(email string) (*RecipientWrap, error)

https://app.addy.io/docs/#recipients-POSTapi-v1-recipients

func (*Client) RecipientResendEmail 

func (c *Client) RecipientResendEmail(id string) error

https://app.addy.io/docs/#recipients-POSTapi-v1-recipients-email-resend

func (*Client) RecipientsGet 

func (c *Client) RecipientsGet(params *RecipientsGetArgs) (*RecipientsWrap, error)

https://app.addy.io/docs/#recipients-GETapi-v1-recipients

func (*Client) RuleDelete 

func (c *Client) RuleDelete(id string) error

https://app.addy.io/docs/#rules-DELETEapi-v1-rules--id-

func (*Client) RuleDisable 

func (c *Client) RuleDisable(id string) error

https://app.addy.io/docs/#rules-DELETEapi-v1-active-rules--id-

func (*Client) RuleEnable 

func (c *Client) RuleEnable(id string) (*RuleWrap, error)

https://app.addy.io/docs/#rules-POSTapi-v1-active-rules

func (*Client) RuleGet 

func (c *Client) RuleGet(id string) (*RuleWrap, error)

https://app.addy.io/docs/#rules-GETapi-v1-rules--id-

func (*Client) RuleNew 

func (c *Client) RuleNew(data *RuleNewParams) (*RuleWrap, error)

https://app.addy.io/docs/#rules-POSTapi-v1-rules

func (*Client) RuleUpdate 

func (c *Client) RuleUpdate(id string, data *RuleUpdateArgs) (*RuleWrap, error)

https://app.addy.io/docs/#rules-PATCHapi-v1-rules--id-

func (*Client) RulesGet 

func (c *Client) RulesGet() (*RulesWrap, error)

https://app.addy.io/docs/#rules-GETapi-v1-rules

func (*Client) RulesUpdOrder 

func (c *Client) RulesUpdOrder(ids []string) error

https://app.addy.io/docs/#rules-POSTapi-v1-reorder-rules

func (*Client) TokenGetAPIDetails 

func (c *Client) TokenGetAPIDetails() (*TokenAPIDetails, error)

https://app.addy.io/docs/#api-token-GETapi-v1-api-token-details

func (*Client) UserAllowLogin 

func (c *Client) UserAllowLogin(id string) (*UserWrap, error)

https://app.addy.io/docs/#usernames-POSTapi-v1-loginable-usernames

func (*Client) UserDelete 

func (c *Client) UserDelete(id string) error

https://app.addy.io/docs/#usernames-DELETEapi-v1-usernames--id-

func (*Client) UserDisabCatchAll 

func (c *Client) UserDisabCatchAll(id string) error

https://app.addy.io/docs/#usernames-DELETEapi-v1-catch-all-usernames--id-

func (*Client) UserDisable 

func (c *Client) UserDisable(id string) error

https://app.addy.io/docs/#usernames-DELETEapi-v1-active-usernames--id-

func (*Client) UserDisallowLogin 

func (c *Client) UserDisallowLogin(id string) error

https://app.addy.io/docs/#usernames-DELETEapi-v1-catch-all-usernames--id-

func (*Client) UserEnabCatchAll 

func (c *Client) UserEnabCatchAll(id string) (*UserWrap, error)

https://app.addy.io/docs/#usernames-POSTapi-v1-catch-all-usernames

func (*Client) UserEnable 

func (c *Client) UserEnable(id string) (*UserWrap, error)

https://app.addy.io/docs/#usernames-POSTapi-v1-active-usernames

func (*Client) UserGet 

func (c *Client) UserGet(id string) (*UserWrap, error)

https://app.addy.io/docs/#usernames-GETapi-v1-usernames--id-

func (*Client) UserNew 

func (c *Client) UserNew(username string) (*UserWrap, error)

https://app.addy.io/docs/#usernames-POSTapi-v1-usernames

func (*Client) UserUpdRecipient 

func (c *Client) UserUpdRecipient(id, recipent string) (*UserWrap, error)

https://app.addy.io/docs/#usernames-PATCHapi-v1-usernames--id--default-recipient

func (*Client) UserUpdate 

func (c *Client) UserUpdate(id string, data *UserUpdateArgs) (*UserWrap, error)

https://app.addy.io/docs/#usernames-PATCHapi-v1-usernames--id-

func (*Client) UsersGet 

func (c *Client) UsersGet() (*UsersWrap, error)

https://app.addy.io/docs/#usernames-GETapi-v1-usernames

type Condition 

type Condition struct {
	Type   string   `json:"type"`
	Match  string   `json:"match,omitempty"`
	Values []string `json:"values"`
}

type Conditions 

type Conditions struct {
	Type   string   `json:"type"`
	Match  string   `json:"match"`
	Values []string `json:"values"`
}

type Domain 

type Domain struct {
	ID                      string    `json:"id"`
	UserID                  string    `json:"user_id"`
	Domain                  string    `json:"domain"`
	Description             string    `json:"description"`
	Aliases                 []Alias   `json:"aliases"`
	DefaultRecipient        Recipient `json:"default_recipient"`
	Active                  bool      `json:"active"`
	CatchAll                bool      `json:"catch_all"`
	DomainVerifiedAt        *UnixTime `json:"domain_verified_at"`
	DomainMxValidatedAt     *UnixTime `json:"domain_mx_validated_at"`
	DomainSendingVerifiedAt *UnixTime `json:"domain_sending_verified_at"`
	CreatedAt               UnixTime  `json:"created_at"`
	UpdatedAt               *UnixTime `json:"updated_at"`
}

type DomainOptions 

type DomainOptions struct {
	Data               []string `json:"data"`
	DefaultAliasDomain string   `json:"defaultAliasDomain"`
	DefaultAliasFormat string   `json:"defaultAliasFormat"`
}

type DomainUpdateArgs 

type DomainUpdateArgs struct {
	Desc     string `json:"description,omitempty"`
	FromName string `json:"from_name,omitempty"`
}

type DomainWrap 

type DomainWrap struct {
	Data Domain `json:"data"`
}

type DomainsWrap 

type DomainsWrap struct {
	Data []Domain `json:"data"`
}

type FailedDeliveriesWrap 

type FailedDeliveriesWrap struct {
	Data []FailedDelivery `json:"data"`
}

type FailedDelivery 

type FailedDelivery struct {
	ID             string    `json:"id"`
	UserID         string    `json:"user_id"`
	RecipientID    string    `json:"recipient_id"`
	RecipientEmail string    `json:"recipient_email"`
	AliasID        string    `json:"alias_id"`
	AliasEmail     string    `json:"alias_email"`
	BounceType     string    `json:"bounce_type"`
	RemoteMta      string    `json:"remote_mta"`
	Sender         string    `json:"sender"`
	EmailType      string    `json:"email_type"`
	Status         string    `json:"status"`
	Code           string    `json:"code"`
	AttemptedAt    UnixTime  `json:"attempted_at"`
	CreatedAt      *UnixTime `json:"created_at"`
	UpdatedAt      *UnixTime `json:"updated_at"`
}

type FailedDeliveryWrap 

type FailedDeliveryWrap struct {
	Data FailedDelivery `json:"data"`
}

type IDGeneric 

type IDGeneric struct {
	ID string `json:"id"`
}

Multiple methods require either ID or an array of IDs as arguments.

type IDsGeneric 

type IDsGeneric struct {
	IDs []string `json:"ids"`
}

type Recipient 

type Recipient struct {
	ID               string    `json:"id"`
	UserID           string    `json:"user_id"`
	Email            string    `json:"email"`
	CanReplySend     bool      `json:"can_reply_send"`
	ShouldEncrypt    bool      `json:"should_encrypt"`
	InlineEncryption bool      `json:"inline_encryption"`
	ProtectedHeaders bool      `json:"protected_headers"`
	Fingerprint      string    `json:"fingerprint"`
	EmailVerifiedAt  *UnixTime `json:"email_verified_at"`
	Aliases          []Alias   `json:"aliases"`
	CreatedAt        UnixTime  `json:"created_at"`
	UpdatedAt        *UnixTime `json:"updated_at"`
}

type RecipientWrap 

type RecipientWrap struct {
	Data Recipient `json:"data"`
}

type RecipientsGetArgs 

type RecipientsGetArgs struct {
	Filter map[string]string
}

type RecipientsWrap 

type RecipientsWrap struct {
	Data []Recipient `json:"data"`
}

type Rule 

type Rule struct {
	ID         string       `json:"id"`
	UserID     string       `json:"user_id"`
	Name       string       `json:"name"`
	Order      int          `json:"order"`
	Conditions []Conditions `json:"conditions"`
	Actions    []Actions    `json:"actions"`
	Operator   string       `json:"operator"`
	Forwards   bool         `json:"forwards"`
	Replies    bool         `json:"replies"`
	Sends      bool         `json:"sends"`
	Active     bool         `json:"active"`
	CreatedAt  UnixTime     `json:"created_at"`
	UpdatedAt  *UnixTime    `json:"updated_at"`
}

type RuleNewParams 

type RuleNewParams struct {
	Name       string      `json:"name"`
	Conditions []Condition `json:"conditions"`
	Actions    []Action    `json:"actions"`
	Operator   string      `json:"operator,omitempty"`
	Forwards   bool        `json:"forwards,omitempty"`
	Replies    bool        `json:"replies,omitempty"`
	Sends      bool        `json:"sends,omitempty"`
}

type RuleUpdateArgs 

type RuleUpdateArgs struct {
	Name       string       `json:"name"`
	Conditions []Condition  `json:"conditions"`
	Actions    []Action     `json:"actions"`
	Operator   AddyOperator `json:"operator,omitempty"`
	Forwards   bool         `json:"forwards,omitempty"`
	Replies    bool         `json:"replies,omitempty"`
	Sends      bool         `json:"sends,omitempty"`
}

type RuleWrap 

type RuleWrap struct {
	Data Rule `json:"data"`
}

type RulesWrap 

type RulesWrap struct {
	Data []Rule `json:"data"`
}

type TokenAPIDetails 

type TokenAPIDetails struct {
	Name      string    `json:"name"`
	CreatedAt UnixTime  `json:"created_at"`
	ExpiresAt *UnixTime `json:"expires_at"`
}

type UnixTime 

type UnixTime struct {
	time.Time
}

Time format returned by Addy.

func (*UnixTime) UnmarshalJSON 

func (ut *UnixTime) UnmarshalJSON(b []byte) error

type User 

type User struct {
	ID               string    `json:"id"`
	UserID           string    `json:"user_id"`
	Username         string    `json:"username"`
	Description      string    `json:"description"`
	Aliases          []Alias   `json:"aliases"`
	DefaultRecipient string    `json:"default_recipient"`
	Active           bool      `json:"active"`
	CatchAll         bool      `json:"catch_all"`
	CanLogin         bool      `json:"can_login"`
	CreatedAt        UnixTime  `json:"created_at"`
	UpdatedAt        *UnixTime `json:"updated_at"`
}

type UserUpdateArgs 

type UserUpdateArgs struct {
	Desc     string `json:"description,omitempty"`
	FromName string `json:"from_name,omitempty"`
}

type UserWrap 

type UserWrap struct {
	Data User `json:"data"`
}

type UsersWrap 

type UsersWrap struct {
	Data []User `json:"data"`
}

Source Files

View all Source files

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.