workmailmessageflow

package
v0.0.0-...-7b64836 Latest Latest
Warning

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

 Go to latest Published: Dec 17, 2024 License: Apache-2.0, Apache-2.0 Imports: 10 Imported by: 0

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

View Source 
const (

	// ErrCodeInvalidContentLocation for service response error code
	// "InvalidContentLocation".
	//
	// WorkMail could not access the updated email content. Possible reasons:
	//
	//    * You made the request in a region other than your S3 bucket region.
	//
	//    * The S3 bucket owner (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-owner-condition.html)
	//    is not the same as the calling AWS account.
	//
	//    * You have an incomplete or missing S3 bucket policy. For more information
	//    about policies, see Updating message content with AWS Lambda (https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html)
	//    in the WorkMail Administrator Guide.
	ErrCodeInvalidContentLocation = "InvalidContentLocation"

	// ErrCodeMessageFrozen for service response error code
	// "MessageFrozen".
	//
	// The requested email is not eligible for update. This is usually the case
	// for a redirected email.
	ErrCodeMessageFrozen = "MessageFrozen"

	// ErrCodeMessageRejected for service response error code
	// "MessageRejected".
	//
	// The requested email could not be updated due to an error in the MIME content.
	// Check the error message for more information about what caused the error.
	ErrCodeMessageRejected = "MessageRejected"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested email message is not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source 
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

Variables

This section is empty.

Functions

This section is empty.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidContentLocation 

type InvalidContentLocation struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

WorkMail could not access the updated email content. Possible reasons:

func (*InvalidContentLocation) Code 

func (s *InvalidContentLocation) Code() string

Code returns the exception type name.

func (*InvalidContentLocation) Error 

func (s *InvalidContentLocation) Error() string

func (InvalidContentLocation) GoString 

func (s InvalidContentLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidContentLocation) Message 

func (s *InvalidContentLocation) Message() string

Message returns the exception's message.

func (*InvalidContentLocation) OrigErr 

func (s *InvalidContentLocation) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidContentLocation) RequestID 

func (s *InvalidContentLocation) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidContentLocation) StatusCode 

func (s *InvalidContentLocation) StatusCode() int

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

func (InvalidContentLocation) String 

func (s InvalidContentLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MessageFrozen 

type MessageFrozen struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

The requested email is not eligible for update. This is usually the case for a redirected email.

func (*MessageFrozen) Code 

func (s *MessageFrozen) Code() string

Code returns the exception type name.

func (*MessageFrozen) Error 

func (s *MessageFrozen) Error() string

func (MessageFrozen) GoString 

func (s MessageFrozen) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MessageFrozen) Message 

func (s *MessageFrozen) Message() string

Message returns the exception's message.

func (*MessageFrozen) OrigErr 

func (s *MessageFrozen) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MessageFrozen) RequestID 

func (s *MessageFrozen) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MessageFrozen) StatusCode 

func (s *MessageFrozen) StatusCode() int

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

func (MessageFrozen) String 

func (s MessageFrozen) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MessageRejected 

type MessageRejected struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

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

The requested email could not be updated due to an error in the MIME content. Check the error message for more information about what caused the error.

func (*MessageRejected) Code 

func (s *MessageRejected) Code() string

Code returns the exception type name.

func (*MessageRejected) Error 

func (s *MessageRejected) Error() string

func (MessageRejected) GoString 

func (s MessageRejected) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MessageRejected) Message 

func (s *MessageRejected) Message() string

Message returns the exception's message.

func (*MessageRejected) OrigErr 

func (s *MessageRejected) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MessageRejected) RequestID 

func (s *MessageRejected) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MessageRejected) StatusCode 

func (s *MessageRejected) StatusCode() int

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

func (MessageRejected) String 

func (s MessageRejected) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutRawMessageContentInput 

type PutRawMessageContentInput struct {

	// Describes the raw message content of the updated email message.
	//
	// Content is a required field
	Content *RawMessageContent `locationName:"content" type:"structure" required:"true"`

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

func (PutRawMessageContentInput) GoString 

func (s PutRawMessageContentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRawMessageContentInput) SetContent 

func (s *PutRawMessageContentInput) SetContent(v *RawMessageContent) *PutRawMessageContentInput

SetContent sets the Content field's value.

func (*PutRawMessageContentInput) SetMessageId 

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

SetMessageId sets the MessageId field's value.

func (PutRawMessageContentInput) String 

func (s PutRawMessageContentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRawMessageContentInput) Validate 

func (s *PutRawMessageContentInput) Validate() error

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

type PutRawMessageContentOutput 

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

func (PutRawMessageContentOutput) GoString 

func (s PutRawMessageContentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutRawMessageContentOutput) String 

func (s PutRawMessageContentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RawMessageContent 

type RawMessageContent struct {

	// The S3 reference of an email message.
	//
	// S3Reference is a required field
	S3Reference *S3Reference `locationName:"s3Reference" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Provides the MIME content of the updated email message as an S3 object. All MIME content must meet the following criteria:

  • Each part of a multipart MIME message must be formatted properly.

  • Attachments must be of a content type that Amazon SES supports. For more information, see Unsupported Attachment Types (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mime-types-appendix.html).

  • If any of the MIME parts in a message contain content that is outside of the 7-bit ASCII character range, we recommend encoding that content.

  • Per RFC 5321 (https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6), the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.

  • The message must contain all the required header fields. Check the returned error message for more information.

  • The value of immutable headers must remain unchanged. Check the returned error message for more information.

  • Certain unique headers can only appear once. Check the returned error message for more information.

func (RawMessageContent) GoString 

func (s RawMessageContent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RawMessageContent) SetS3Reference 

func (s *RawMessageContent) SetS3Reference(v *S3Reference) *RawMessageContent

SetS3Reference sets the S3Reference field's value.

func (RawMessageContent) String 

func (s RawMessageContent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RawMessageContent) Validate 

func (s *RawMessageContent) Validate() error

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

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3Reference 

type S3Reference struct {

	// The S3 bucket name.
	//
	// Bucket is a required field
	Bucket *string `locationName:"bucket" min:"3" type:"string" required:"true"`

	// The S3 key object name.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// If you enable versioning for the bucket, you can specify the object version.
	ObjectVersion *string `locationName:"objectVersion" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Amazon S3 object representing the updated message content, in MIME format.

The region for the S3 bucket containing the S3 object must match the region used for WorkMail operations. Also, for WorkMail to process an S3 object, it must have permission to access that object. For more information, see Updating message content with AWS Lambda (https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html).

func (S3Reference) GoString 

func (s S3Reference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Reference) SetBucket 

func (s *S3Reference) SetBucket(v string) *S3Reference

SetBucket sets the Bucket field's value.

func (*S3Reference) SetKey 

func (s *S3Reference) SetKey(v string) *S3Reference

SetKey sets the Key field's value.

func (*S3Reference) SetObjectVersion 

func (s *S3Reference) SetObjectVersion(v string) *S3Reference

SetObjectVersion sets the ObjectVersion field's value.

func (S3Reference) String 

func (s S3Reference) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Reference) Validate 

func (s *S3Reference) Validate() error

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

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.

func (*WorkMailMessageFlow) PutRawMessageContent 

func (c *WorkMailMessageFlow) PutRawMessageContent(input *PutRawMessageContentInput) (*PutRawMessageContentOutput, error)

PutRawMessageContent API operation for Amazon WorkMail Message Flow.

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

This example describes how to update in-transit email message. For more information and examples for using this API, see Updating message content with AWS Lambda (https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html).

Updates to an in-transit message only appear when you call PutRawMessageContent from an AWS Lambda function configured with a synchronous Run Lambda (https://docs.aws.amazon.com/workmail/latest/adminguide/lambda.html#synchronous-rules) rule. If you call PutRawMessageContent on a delivered or sent message, the message remains unchanged, even though GetRawMessageContent (https://docs.aws.amazon.com/workmail/latest/APIReference/API_messageflow_GetRawMessageContent.html) returns an updated message.

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 PutRawMessageContent for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested email message is not found.

  • InvalidContentLocation WorkMail could not access the updated email content. Possible reasons:

  • You made the request in a region other than your S3 bucket region.

  • The S3 bucket owner (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-owner-condition.html) is not the same as the calling AWS account.

  • You have an incomplete or missing S3 bucket policy. For more information about policies, see Updating message content with AWS Lambda (https://docs.aws.amazon.com/workmail/latest/adminguide/update-with-lambda.html) in the WorkMail Administrator Guide.

  • MessageRejected The requested email could not be updated due to an error in the MIME content. Check the error message for more information about what caused the error.

  • MessageFrozen The requested email is not eligible for update. This is usually the case for a redirected email.

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

func (*WorkMailMessageFlow) PutRawMessageContentRequest 

func (c *WorkMailMessageFlow) PutRawMessageContentRequest(input *PutRawMessageContentInput) (req *request.Request, output *PutRawMessageContentOutput)

PutRawMessageContentRequest generates a "aws/request.Request" representing the client's request for the PutRawMessageContent 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 PutRawMessageContent for more information on using the PutRawMessageContent 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 PutRawMessageContentRequest method.
req, resp := client.PutRawMessageContentRequest(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/PutRawMessageContent

func (*WorkMailMessageFlow) PutRawMessageContentWithContext 

func (c *WorkMailMessageFlow) PutRawMessageContentWithContext(ctx aws.Context, input *PutRawMessageContentInput, opts ...request.Option) (*PutRawMessageContentOutput, error)

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

See PutRawMessageContent 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.

Source Files

View all Source files

Directories

Path Synopsis
Package workmailmessageflowiface provides an interface to enable mocking the Amazon WorkMail Message Flow service client for testing your code.
 Package workmailmessageflowiface provides an interface to enable mocking the Amazon WorkMail Message Flow service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.