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 contact 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 WorkMailMessageFlow for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/workmailmessageflow/#New

Index

• Constants
• type GetRawMessageContentInput
  • func (s GetRawMessageContentInput) GoString() string
  • func (s *GetRawMessageContentInput) SetMessageId(v string) *GetRawMessageContentInput
  • func (s GetRawMessageContentInput) String() string
  • func (s *GetRawMessageContentInput) Validate() error
• type GetRawMessageContentOutput
  • func (s GetRawMessageContentOutput) GoString() string
  • func (s *GetRawMessageContentOutput) SetMessageContent(v io.ReadCloser) *GetRawMessageContentOutput
  • func (s GetRawMessageContentOutput) String() string
• type ResourceNotFoundException
  • func (s ResourceNotFoundException) Code() string
  • func (s ResourceNotFoundException) Error() string
  • func (s ResourceNotFoundException) GoString() string
  • func (s ResourceNotFoundException) Message() string
  • func (s ResourceNotFoundException) OrigErr() error
  • func (s ResourceNotFoundException) RequestID() string
  • func (s ResourceNotFoundException) StatusCode() int
  • func (s ResourceNotFoundException) String() string
• type WorkMailMessageFlow
  • func New(p client.ConfigProvider, cfgs ...*aws.Config) *WorkMailMessageFlow
  • func (c *WorkMailMessageFlow) GetRawMessageContent(input *GetRawMessageContentInput) (*GetRawMessageContentOutput, error)
  • func (c *WorkMailMessageFlow) GetRawMessageContentRequest(input *GetRawMessageContentInput) (req *request.Request, output *GetRawMessageContentOutput)
  • func (c *WorkMailMessageFlow) GetRawMessageContentWithContext(ctx aws.Context, input *GetRawMessageContentInput, opts ...request.Option) (*GetRawMessageContentOutput, error)

Constants

const (
	ServiceName = "WorkMailMessageFlow" // Name of service.
	EndpointsID = "workmailmessageflow" // ID to lookup a service endpoint with.
	ServiceID   = "WorkMailMessageFlow" // ServiceID is a unique identifier of a specific service.
)

Service information constants

const (

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

Types

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) GoString

func (s GetRawMessageContentInput) GoString() string

GoString returns the string representation

func (*GetRawMessageContentInput) SetMessageId

func (s *GetRawMessageContentInput) SetMessageId(v string) *GetRawMessageContentInput

SetMessageId sets the MessageId field's value.

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) GoString

func (s GetRawMessageContentOutput) GoString() string

GoString returns the string representation

func (*GetRawMessageContentOutput) SetMessageContent

func (s *GetRawMessageContentOutput) SetMessageContent(v io.ReadCloser) *GetRawMessageContentOutput

SetMessageContent sets the MessageContent field's value.

func (GetRawMessageContentOutput) String

func (s GetRawMessageContentOutput) String() string

String returns the string representation

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The requested email message is not found.

func (ResourceNotFoundException) Code

func (s ResourceNotFoundException) Code() string

Code returns the exception type name.

func (ResourceNotFoundException) Error

func (s ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (ResourceNotFoundException) Message

func (s ResourceNotFoundException) Message() string

Message returns the exception's message.

func (ResourceNotFoundException) OrigErr

func (s ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (ResourceNotFoundException) RequestID

func (s ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (ResourceNotFoundException) StatusCode

func (s ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation

type WorkMailMessageFlow

type WorkMailMessageFlow struct {
	*client.Client
}

WorkMailMessageFlow 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.

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

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *WorkMailMessageFlow

New creates a new instance of the WorkMailMessageFlow client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a WorkMailMessageFlow client from just a session.
svc := workmailmessageflow.New(mySession)

// Create a WorkMailMessageFlow client with additional configuration
svc := workmailmessageflow.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*WorkMailMessageFlow) GetRawMessageContent

func (c *WorkMailMessageFlow) GetRawMessageContent(input *GetRawMessageContentInput) (*GetRawMessageContentOutput, error)

GetRawMessageContent API operation for Amazon WorkMail Message Flow.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkMail Message Flow's API operation GetRawMessageContent for usage and error information.

Returned Error Types:

• ResourceNotFoundException The requested email message is not found.

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

func (*WorkMailMessageFlow) GetRawMessageContentRequest

func (c *WorkMailMessageFlow) GetRawMessageContentRequest(input *GetRawMessageContentInput) (req *request.Request, output *GetRawMessageContentOutput)

GetRawMessageContentRequest generates a "aws/request.Request" representing the client's request for the GetRawMessageContent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRawMessageContent for more information on using the GetRawMessageContent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRawMessageContentRequest method.
req, resp := client.GetRawMessageContentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkMailMessageFlow) GetRawMessageContentWithContext

func (c *WorkMailMessageFlow) GetRawMessageContentWithContext(ctx aws.Context, input *GetRawMessageContentInput, opts ...request.Option) (*GetRawMessageContentOutput, error)

GetRawMessageContentWithContext is the same as GetRawMessageContent with the addition of the ability to pass a context and additional request options.

See GetRawMessageContent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.