workmailmessageflow

Documentation

Overview

Package workmailmessageflow provides the client and types for making API requests to Amazon WorkMail Message Flow.

The WorkMail Message Flow API provides access to email messages as they are being sent and received by a WorkMail organization.

See https://docs.aws.amazon.com/goto/WebAPI/workmailmessageflow-2019-05-01 for more information on this service.

See workmailmessageflow package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/workmailmessageflow/

Using the Client

To use Amazon WorkMail Message Flow with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon WorkMail Message Flow client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/workmailmessageflow/#New

Index

• Constants
• type Client
  • func New(config aws.Config) *Client
  • func (c *Client) GetRawMessageContentRequest(input *GetRawMessageContentInput) GetRawMessageContentRequest
• type GetRawMessageContentInput
  • func (s GetRawMessageContentInput) MarshalFields(e protocol.FieldEncoder) error
  • func (s GetRawMessageContentInput) String() string
  • func (s *GetRawMessageContentInput) Validate() error
• type GetRawMessageContentOutput
  • func (s GetRawMessageContentOutput) MarshalFields(e protocol.FieldEncoder) error
  • func (s GetRawMessageContentOutput) String() string
• type GetRawMessageContentRequest
  • func (r GetRawMessageContentRequest) Send(ctx context.Context) (*GetRawMessageContentResponse, error)
• type GetRawMessageContentResponse
  • func (r *GetRawMessageContentResponse) SDKResponseMetdata() *aws.Response

Constants

const (
	ServiceName = "Amazon WorkMail Message Flow" // Service's name
	ServiceID   = "WorkMailMessageFlow"          // Service's identifier
	EndpointsID = "workmailmessageflow"          // Service's Endpoint identifier
)

const (

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested email message is not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)

Types

type Client

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Amazon WorkMail Message Flow. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := workmailmessageflow.New(myConfig)

func (*Client) GetRawMessageContentRequest

func (c *Client) GetRawMessageContentRequest(input *GetRawMessageContentInput) GetRawMessageContentRequest

GetRawMessageContentRequest returns a request value for making API operation for Amazon WorkMail Message Flow.

Retrieves the raw content of an in-transit email message, in MIME format.

// Example sending a request using GetRawMessageContentRequest.
req := client.GetRawMessageContentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workmailmessageflow-2019-05-01/GetRawMessageContent

type GetRawMessageContentInput

type GetRawMessageContentInput struct {

	// The identifier of the email message to retrieve.
	//
	// MessageId is a required field
	MessageId *string `location:"uri" locationName:"messageId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetRawMessageContentInput) MarshalFields

func (s GetRawMessageContentInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetRawMessageContentInput) String

func (s GetRawMessageContentInput) String() string

String returns the string representation

func (*GetRawMessageContentInput) Validate

func (s *GetRawMessageContentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetRawMessageContentOutput

type GetRawMessageContentOutput struct {

	// The raw content of the email message, in MIME format.
	//
	// MessageContent is a required field
	MessageContent io.ReadCloser `locationName:"messageContent" type:"blob" required:"true"`
	// contains filtered or unexported fields
}

func (GetRawMessageContentOutput) MarshalFields

func (s GetRawMessageContentOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetRawMessageContentOutput) String

func (s GetRawMessageContentOutput) String() string

String returns the string representation

type GetRawMessageContentRequest

type GetRawMessageContentRequest struct {
	*aws.Request
	Input *GetRawMessageContentInput
	Copy  func(*GetRawMessageContentInput) GetRawMessageContentRequest
}

GetRawMessageContentRequest is the request type for the GetRawMessageContent API operation.

func (GetRawMessageContentRequest) Send

func (r GetRawMessageContentRequest) Send(ctx context.Context) (*GetRawMessageContentResponse, error)

Send marshals and sends the GetRawMessageContent API request.

type GetRawMessageContentResponse

type GetRawMessageContentResponse struct {
	*GetRawMessageContentOutput
	// contains filtered or unexported fields
}

GetRawMessageContentResponse is the response type for the GetRawMessageContent API operation.

func (*GetRawMessageContentResponse) SDKResponseMetdata

func (r *GetRawMessageContentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetRawMessageContent request.