smtp

package
v0.9.0 Latest Latest
Warning

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

Go to latest
Published: Jul 3, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

Client for smtp API

func (*Client) GetAPI24SMTPServers

func (a *Client) GetAPI24SMTPServers(params *GetAPI24SMTPServersParams) (*GetApi24SMTPServersOK, error)

GetAPI24SMTPServers lists SMTP server attributes

Displays SMTP server attributes. Values include `user_name`, `password`, `relay_host`, `sender_domain`, and `name`.

func (*Client) PatchAPI24SMTPServers

func (a *Client) PatchAPI24SMTPServers(params *PatchAPI24SMTPServersParams) (*PatchApi24SMTPServersOK, error)

PatchAPI24SMTPServers modifies SMTP server attributes

Modifies SMTP server attributes. Values include `user_name`, `password`, `relay_host`, `sender_domain`, and `name`.

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	GetAPI24SMTPServers(params *GetAPI24SMTPServersParams) (*GetApi24SMTPServersOK, error)

	PatchAPI24SMTPServers(params *PatchAPI24SMTPServersParams) (*PatchApi24SMTPServersOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new smtp API client.

type GetAPI24SMTPServersParams

type GetAPI24SMTPServersParams struct {

	/*Authorization
	  Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)

	*/
	Authorization *string
	/*XRequestID
	  Supplied by client during request or generated by server.

	*/
	XRequestID *string
	/*Filter
	  Narrows down the results to only the response objects that satisfy the filter criteria.

	*/
	Filter *string
	/*Limit
	  Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

	*/
	Limit *int32
	/*Offset
	  The starting position based on the results of the query in relation to the full set of response objects returned.

	*/
	Offset *int32
	/*Sort
	  Returns the response objects in the order specified. Set `sort` to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (`-`) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

	*/
	Sort []string
	/*TotalItemCount
	  If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`.

	*/
	TotalItemCount *bool

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetAPI24SMTPServersParams contains all the parameters to send to the API endpoint for the get API 24 SMTP servers operation typically these are written to a http.Request

func NewGetAPI24SMTPServersParams

func NewGetAPI24SMTPServersParams() *GetAPI24SMTPServersParams

NewGetAPI24SMTPServersParams creates a new GetAPI24SMTPServersParams object with the default values initialized.

func NewGetAPI24SMTPServersParamsWithContext

func NewGetAPI24SMTPServersParamsWithContext(ctx context.Context) *GetAPI24SMTPServersParams

NewGetAPI24SMTPServersParamsWithContext creates a new GetAPI24SMTPServersParams object with the default values initialized, and the ability to set a context for a request

func NewGetAPI24SMTPServersParamsWithHTTPClient

func NewGetAPI24SMTPServersParamsWithHTTPClient(client *http.Client) *GetAPI24SMTPServersParams

NewGetAPI24SMTPServersParamsWithHTTPClient creates a new GetAPI24SMTPServersParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewGetAPI24SMTPServersParamsWithTimeout

func NewGetAPI24SMTPServersParamsWithTimeout(timeout time.Duration) *GetAPI24SMTPServersParams

NewGetAPI24SMTPServersParamsWithTimeout creates a new GetAPI24SMTPServersParams object with the default values initialized, and the ability to set a timeout on a request

func (*GetAPI24SMTPServersParams) SetAuthorization

func (o *GetAPI24SMTPServersParams) SetAuthorization(authorization *string)

SetAuthorization adds the authorization to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) SetContext

func (o *GetAPI24SMTPServersParams) SetContext(ctx context.Context)

SetContext adds the context to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) SetFilter

func (o *GetAPI24SMTPServersParams) SetFilter(filter *string)

SetFilter adds the filter to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) SetHTTPClient

func (o *GetAPI24SMTPServersParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) SetLimit

func (o *GetAPI24SMTPServersParams) SetLimit(limit *int32)

SetLimit adds the limit to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) SetOffset

func (o *GetAPI24SMTPServersParams) SetOffset(offset *int32)

SetOffset adds the offset to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) SetSort

func (o *GetAPI24SMTPServersParams) SetSort(sort []string)

SetSort adds the sort to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) SetTimeout

func (o *GetAPI24SMTPServersParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) SetTotalItemCount

func (o *GetAPI24SMTPServersParams) SetTotalItemCount(totalItemCount *bool)

SetTotalItemCount adds the totalItemCount to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) SetXRequestID

func (o *GetAPI24SMTPServersParams) SetXRequestID(xRequestID *string)

SetXRequestID adds the xRequestId to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) WithAuthorization

func (o *GetAPI24SMTPServersParams) WithAuthorization(authorization *string) *GetAPI24SMTPServersParams

WithAuthorization adds the authorization to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) WithContext

WithContext adds the context to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) WithFilter

WithFilter adds the filter to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) WithHTTPClient

func (o *GetAPI24SMTPServersParams) WithHTTPClient(client *http.Client) *GetAPI24SMTPServersParams

WithHTTPClient adds the HTTPClient to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) WithLimit

WithLimit adds the limit to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) WithOffset

WithOffset adds the offset to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) WithSort

WithSort adds the sort to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) WithTimeout

WithTimeout adds the timeout to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) WithTotalItemCount

func (o *GetAPI24SMTPServersParams) WithTotalItemCount(totalItemCount *bool) *GetAPI24SMTPServersParams

WithTotalItemCount adds the totalItemCount to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) WithXRequestID

func (o *GetAPI24SMTPServersParams) WithXRequestID(xRequestID *string) *GetAPI24SMTPServersParams

WithXRequestID adds the xRequestID to the get API 24 SMTP servers params

func (*GetAPI24SMTPServersParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetAPI24SMTPServersReader

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

GetAPI24SMTPServersReader is a Reader for the GetAPI24SMTPServers structure.

func (*GetAPI24SMTPServersReader) ReadResponse

func (o *GetAPI24SMTPServersReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetApi24SMTPServersBadRequest

type GetApi24SMTPServersBadRequest struct {
	Payload *models.Error
}

GetApi24SMTPServersBadRequest handles this case with default header values.

BadRequest

func NewGetApi24SMTPServersBadRequest

func NewGetApi24SMTPServersBadRequest() *GetApi24SMTPServersBadRequest

NewGetApi24SMTPServersBadRequest creates a GetApi24SMTPServersBadRequest with default headers values

func (*GetApi24SMTPServersBadRequest) Error

func (*GetApi24SMTPServersBadRequest) GetPayload

func (o *GetApi24SMTPServersBadRequest) GetPayload() *models.Error

type GetApi24SMTPServersOK

type GetApi24SMTPServersOK struct {
	Payload *models.SMTPServerGetResponse
}

GetApi24SMTPServersOK handles this case with default header values.

OK

func NewGetApi24SMTPServersOK

func NewGetApi24SMTPServersOK() *GetApi24SMTPServersOK

NewGetApi24SMTPServersOK creates a GetApi24SMTPServersOK with default headers values

func (*GetApi24SMTPServersOK) Error

func (o *GetApi24SMTPServersOK) Error() string

func (*GetApi24SMTPServersOK) GetPayload

type PatchAPI24SMTPServersParams

type PatchAPI24SMTPServersParams struct {

	/*Authorization
	  Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`)

	*/
	Authorization *string
	/*XRequestID
	  Supplied by client during request or generated by server.

	*/
	XRequestID *string
	/*SMTP*/
	SMTP *models.SMTPServer

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

PatchAPI24SMTPServersParams contains all the parameters to send to the API endpoint for the patch API 24 SMTP servers operation typically these are written to a http.Request

func NewPatchAPI24SMTPServersParams

func NewPatchAPI24SMTPServersParams() *PatchAPI24SMTPServersParams

NewPatchAPI24SMTPServersParams creates a new PatchAPI24SMTPServersParams object with the default values initialized.

func NewPatchAPI24SMTPServersParamsWithContext

func NewPatchAPI24SMTPServersParamsWithContext(ctx context.Context) *PatchAPI24SMTPServersParams

NewPatchAPI24SMTPServersParamsWithContext creates a new PatchAPI24SMTPServersParams object with the default values initialized, and the ability to set a context for a request

func NewPatchAPI24SMTPServersParamsWithHTTPClient

func NewPatchAPI24SMTPServersParamsWithHTTPClient(client *http.Client) *PatchAPI24SMTPServersParams

NewPatchAPI24SMTPServersParamsWithHTTPClient creates a new PatchAPI24SMTPServersParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewPatchAPI24SMTPServersParamsWithTimeout

func NewPatchAPI24SMTPServersParamsWithTimeout(timeout time.Duration) *PatchAPI24SMTPServersParams

NewPatchAPI24SMTPServersParamsWithTimeout creates a new PatchAPI24SMTPServersParams object with the default values initialized, and the ability to set a timeout on a request

func (*PatchAPI24SMTPServersParams) SetAuthorization

func (o *PatchAPI24SMTPServersParams) SetAuthorization(authorization *string)

SetAuthorization adds the authorization to the patch API 24 SMTP servers params

func (*PatchAPI24SMTPServersParams) SetContext

func (o *PatchAPI24SMTPServersParams) SetContext(ctx context.Context)

SetContext adds the context to the patch API 24 SMTP servers params

func (*PatchAPI24SMTPServersParams) SetHTTPClient

func (o *PatchAPI24SMTPServersParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the patch API 24 SMTP servers params

func (*PatchAPI24SMTPServersParams) SetSMTP

func (o *PatchAPI24SMTPServersParams) SetSMTP(smtp *models.SMTPServer)

SetSMTP adds the smtp to the patch API 24 SMTP servers params

func (*PatchAPI24SMTPServersParams) SetTimeout

func (o *PatchAPI24SMTPServersParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the patch API 24 SMTP servers params

func (*PatchAPI24SMTPServersParams) SetXRequestID

func (o *PatchAPI24SMTPServersParams) SetXRequestID(xRequestID *string)

SetXRequestID adds the xRequestId to the patch API 24 SMTP servers params

func (*PatchAPI24SMTPServersParams) WithAuthorization

func (o *PatchAPI24SMTPServersParams) WithAuthorization(authorization *string) *PatchAPI24SMTPServersParams

WithAuthorization adds the authorization to the patch API 24 SMTP servers params

func (*PatchAPI24SMTPServersParams) WithContext

WithContext adds the context to the patch API 24 SMTP servers params

func (*PatchAPI24SMTPServersParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the patch API 24 SMTP servers params

func (*PatchAPI24SMTPServersParams) WithSMTP

WithSMTP adds the smtp to the patch API 24 SMTP servers params

func (*PatchAPI24SMTPServersParams) WithTimeout

WithTimeout adds the timeout to the patch API 24 SMTP servers params

func (*PatchAPI24SMTPServersParams) WithXRequestID

func (o *PatchAPI24SMTPServersParams) WithXRequestID(xRequestID *string) *PatchAPI24SMTPServersParams

WithXRequestID adds the xRequestID to the patch API 24 SMTP servers params

func (*PatchAPI24SMTPServersParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type PatchAPI24SMTPServersReader

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

PatchAPI24SMTPServersReader is a Reader for the PatchAPI24SMTPServers structure.

func (*PatchAPI24SMTPServersReader) ReadResponse

func (o *PatchAPI24SMTPServersReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type PatchApi24SMTPServersBadRequest

type PatchApi24SMTPServersBadRequest struct {
	Payload *models.Error
}

PatchApi24SMTPServersBadRequest handles this case with default header values.

BadRequest

func NewPatchApi24SMTPServersBadRequest

func NewPatchApi24SMTPServersBadRequest() *PatchApi24SMTPServersBadRequest

NewPatchApi24SMTPServersBadRequest creates a PatchApi24SMTPServersBadRequest with default headers values

func (*PatchApi24SMTPServersBadRequest) Error

func (*PatchApi24SMTPServersBadRequest) GetPayload

func (o *PatchApi24SMTPServersBadRequest) GetPayload() *models.Error

type PatchApi24SMTPServersOK

type PatchApi24SMTPServersOK struct {
	Payload *models.SMTPServerResponse
}

PatchApi24SMTPServersOK handles this case with default header values.

OK

func NewPatchApi24SMTPServersOK

func NewPatchApi24SMTPServersOK() *PatchApi24SMTPServersOK

NewPatchApi24SMTPServersOK creates a PatchApi24SMTPServersOK with default headers values

func (*PatchApi24SMTPServersOK) Error

func (o *PatchApi24SMTPServersOK) Error() string

func (*PatchApi24SMTPServersOK) GetPayload

Jump to

Keyboard shortcuts

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