mailgun

Documentation

Overview

Code generated by go generate; DO NOT EDIT.

Index

• Variables
• func AnalyzeAndPrintPermissions(cfg *config.Config, apiKey string)
• type Analyzer
  • func (a Analyzer) Analyze(_ context.Context, credInfo map[string]string) (*analyzers.AnalyzerResult, error)
  • func (Analyzer) Type() analyzers.AnalyzerType
• type Domain
• type DomainsJSON
• type Key
• type KeysJSON
• type Permission
  • func PermissionFromID(id int) (Permission, error)
  • func PermissionFromString(s string) (Permission, error)
  • func (p Permission) ToID() (int, error)
  • func (p Permission) ToString() (string, error)
• type SecretInfo
  • func AnalyzePermissions(cfg *config.Config, apiKey string) (*SecretInfo, error)

Variables

var (
	PermissionStrings = map[Permission]string{
		Read:       "read",
		Write:      "write",
		FullAccess: "full_access",
	}

	StringToPermission = map[string]Permission{
		"read":        Read,
		"write":       Write,
		"full_access": FullAccess,
	}

	PermissionIDs = map[Permission]int{
		Read:       1,
		Write:      2,
		FullAccess: 3,
	}

	IdToPermission = map[int]Permission{
		1: Read,
		2: Write,
		3: FullAccess,
	}
)

Functions

func AnalyzeAndPrintPermissions

func AnalyzeAndPrintPermissions(cfg *config.Config, apiKey string)

Types

type Analyzer

type Analyzer struct {
	Cfg *config.Config
}

func (Analyzer) Analyze

func (a Analyzer) Analyze(_ context.Context, credInfo map[string]string) (*analyzers.AnalyzerResult, error)

func (Analyzer) Type

func (Analyzer) Type() analyzers.AnalyzerType

type Domain

type Domain struct {
	ID         string `json:"id"`
	URL        string `json:"name"`
	IsDisabled bool   `json:"is_disabled"`
	Type       string `json:"type"`
	State      string `json:"state"`
	CreatedAt  string `json:"created_at"`
}

Domain is a single mailgun domain details

type DomainsJSON

type DomainsJSON struct {
	Items      []Domain `json:"items"`
	TotalCount int      `json:"total_count"`
}

DomainsJSON is /domains API response

type Key

type Key struct {
	ID        string `json:"id"`
	Requester string `json:"requestor"`
	UserName  string `json:"user_name"`
	Role      string `json:"role"`
	Type      string `json:"kind"`
	ExpiresAt string `json:"expires_at"`
}

Key is a single mailgun Key details

type KeysJSON

type KeysJSON struct {
	Items      []Key `json:"items"`
	TotalCount int   `json:"total_count"`
}

KeysJSON is /v1/keys API response

type Permission

type Permission int

const (
	Invalid    Permission = iota
	Read       Permission = iota
	Write      Permission = iota
	FullAccess Permission = iota
)

func PermissionFromID

func PermissionFromID(id int) (Permission, error)

PermissionFromID converts an ID to its Permission enum

func PermissionFromString

func PermissionFromString(s string) (Permission, error)

PermissionFromString converts a string representation to its Permission enum

func (Permission) ToID

func (p Permission) ToID() (int, error)

ToID converts a Permission enum to its ID

func (Permission) ToString

func (p Permission) ToString() (string, error)

ToString converts a Permission enum to its string representation

type SecretInfo

type SecretInfo struct {
	ID        string // key id
	UserName  string
	Type      string // type of key
	Role      string // key role
	ExpiresAt string // key expiry time if any
	Domains   []Domain
}

func AnalyzePermissions

func AnalyzePermissions(cfg *config.Config, apiKey string) (*SecretInfo, error)