email

Documentation

Overview

Package email is the client.Object.EmailServerProfile namespace.

For Panorama, there are two possibilities: managing this object on Panorama itself or inside of a Template.

To manage objects save on Panorama, leave "tmpl" and "ts" params empty and set "dg" to "shared" (which is also the default).

To manage objects in a template, specify the template name and the vsys (if unspecified, defaults to "shared").

Normalized object: Entry

Index

• type Entry
  • func (o *Entry) Copy(s Entry)
• type FwEmail
  • func (c *FwEmail) Delete(vsys string, e ...interface{}) error
  • func (c *FwEmail) Edit(vsys string, e Entry) error
  • func (c *FwEmail) Get(vsys, name string) (Entry, error)
  • func (c *FwEmail) GetList(vsys string) ([]string, error)
  • func (c *FwEmail) Initialize(con util.XapiClient)
  • func (c *FwEmail) Set(vsys string, e ...Entry) error
  • func (c *FwEmail) SetWithoutSubconfig(vsys string, e Entry) error
  • func (c *FwEmail) Show(vsys, name string) (Entry, error)
  • func (c *FwEmail) ShowList(vsys string) ([]string, error)
• type PanoEmail
  • func (c *PanoEmail) Delete(tmpl, ts, vsys, dg string, e ...interface{}) error
  • func (c *PanoEmail) Edit(tmpl, ts, vsys, dg string, e Entry) error
  • func (c *PanoEmail) Get(tmpl, ts, vsys, dg, name string) (Entry, error)
  • func (c *PanoEmail) GetList(tmpl, ts, vsys, dg string) ([]string, error)
  • func (c *PanoEmail) Initialize(con util.XapiClient)
  • func (c *PanoEmail) Set(tmpl, ts, vsys, dg string, e ...Entry) error
  • func (c *PanoEmail) SetWithoutSubconfig(tmpl, ts, vsys, dg string, e Entry) error
  • func (c *PanoEmail) Show(tmpl, ts, vsys, dg, name string) (Entry, error)
  • func (c *PanoEmail) ShowList(tmpl, ts, vsys, dg string) ([]string, error)

Types

type Entry

type Entry struct {
	Name              string
	Config            string
	System            string
	Threat            string
	Traffic           string
	HipMatch          string
	Url               string // 8.0+
	Data              string // 8.0+
	Wildfire          string // 8.0+
	Tunnel            string // 8.0+
	UserId            string // 8.0+
	Gtp               string // 8.0+
	Auth              string // 8.0+
	Sctp              string // 8.1+
	Iptag             string // 9.0+
	EscapedCharacters string
	EscapeCharacter   string
	// contains filtered or unexported fields
}

Entry is a normalized, version independent representation of an email profile.

PAN-OS 7.1+.

func (*Entry) Copy

func (o *Entry) Copy(s Entry)

Copy copies the information from source Entry `s` to this object. As the Name field relates to the XPATH of this object, this field is not copied.

type FwEmail

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

FwEmail is the client.Network.EmailServerProfile namespace.

func (*FwEmail) Delete

func (c *FwEmail) Delete(vsys string, e ...interface{}) error

Delete removes the given objects.

Objects can be a string or an Entry object.

func (*FwEmail) Edit

func (c *FwEmail) Edit(vsys string, e Entry) error

Edit performs EDIT to create / update one object.

func (*FwEmail) Get

func (c *FwEmail) Get(vsys, name string) (Entry, error)

Get performs GET to retrieve information for the given uid.

func (*FwEmail) GetList

func (c *FwEmail) GetList(vsys string) ([]string, error)

GetList performs GET to retrieve a list of values.

func (*FwEmail) Initialize

func (c *FwEmail) Initialize(con util.XapiClient)

Initialize is invoked by client.Initialize().

func (*FwEmail) Set

func (c *FwEmail) Set(vsys string, e ...Entry) error

Set performs SET to create / update one or more objects.

func (*FwEmail) SetWithoutSubconfig

func (c *FwEmail) SetWithoutSubconfig(vsys string, e Entry) error

SetWithoutSubconfig performs a DELETE to remove any subconfig before performing a SET to create an object.

func (*FwEmail) Show

func (c *FwEmail) Show(vsys, name string) (Entry, error)

Show performs SHOW to retrieve information for the given uid.

func (*FwEmail) ShowList

func (c *FwEmail) ShowList(vsys string) ([]string, error)

ShowList performs SHOW to retrieve a list of values.

type PanoEmail

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

PanoEmail is the client.Network.EmailServerProfile namespace.

func (*PanoEmail) Delete

func (c *PanoEmail) Delete(tmpl, ts, vsys, dg string, e ...interface{}) error

Delete removes the given objects.

Objects can be a string or an Entry object.

func (*PanoEmail) Edit

func (c *PanoEmail) Edit(tmpl, ts, vsys, dg string, e Entry) error

Edit performs EDIT to create / update one object.

func (*PanoEmail) Get

func (c *PanoEmail) Get(tmpl, ts, vsys, dg, name string) (Entry, error)

Get performs GET to retrieve information for the given uid.

func (*PanoEmail) GetList

func (c *PanoEmail) GetList(tmpl, ts, vsys, dg string) ([]string, error)

GetList performs GET to retrieve a list of values.

func (*PanoEmail) Initialize

func (c *PanoEmail) Initialize(con util.XapiClient)

Initialize is invoked by client.Initialize().

func (*PanoEmail) Set

func (c *PanoEmail) Set(tmpl, ts, vsys, dg string, e ...Entry) error

Set performs SET to create / update one or more objects.

func (*PanoEmail) SetWithoutSubconfig

func (c *PanoEmail) SetWithoutSubconfig(tmpl, ts, vsys, dg string, e Entry) error

SetWithoutSubconfig performs a DELETE to remove any subconfig before performing a SET to create an object.

func (*PanoEmail) Show

func (c *PanoEmail) Show(tmpl, ts, vsys, dg, name string) (Entry, error)

Show performs SHOW to retrieve information for the given uid.

func (*PanoEmail) ShowList

func (c *PanoEmail) ShowList(tmpl, ts, vsys, dg string) ([]string, error)

ShowList performs SHOW to retrieve a list of values.