awssesactions

Documentation

Index

• func NewAddHeader_Override(a AddHeader, props *AddHeaderProps)
• func NewBounceTemplate_Override(b BounceTemplate, props *BounceTemplateProps)
• func NewBounce_Override(b Bounce, props *BounceProps)
• func NewLambda_Override(l Lambda, props *LambdaProps)
• func NewS3_Override(s S3, props *S3Props)
• func NewSns_Override(s Sns, props *SnsProps)
• func NewStop_Override(s Stop, props *StopProps)
• type AddHeader
  • func NewAddHeader(props *AddHeaderProps) AddHeader
• type AddHeaderProps
• type Bounce
  • func NewBounce(props *BounceProps) Bounce
• type BounceProps
• type BounceTemplate
  • func BounceTemplate_MAILBOX_DOES_NOT_EXIST() BounceTemplate
  • func BounceTemplate_MAILBOX_FULL() BounceTemplate
  • func BounceTemplate_MESSAGE_CONTENT_REJECTED() BounceTemplate
  • func BounceTemplate_MESSAGE_TOO_LARGE() BounceTemplate
  • func BounceTemplate_TEMPORARY_FAILURE() BounceTemplate
  • func NewBounceTemplate(props *BounceTemplateProps) BounceTemplate
• type BounceTemplateProps
• type EmailEncoding
• type Lambda
  • func NewLambda(props *LambdaProps) Lambda
• type LambdaInvocationType
• type LambdaProps
• type S3
  • func NewS3(props *S3Props) S3
• type S3Props
• type Sns
  • func NewSns(props *SnsProps) Sns
• type SnsProps
• type Stop
  • func NewStop(props *StopProps) Stop
• type StopProps

Functions

func NewAddHeader_Override

func NewAddHeader_Override(a AddHeader, props *AddHeaderProps)

Experimental.

func NewBounceTemplate_Override

func NewBounceTemplate_Override(b BounceTemplate, props *BounceTemplateProps)

Experimental.

func NewBounce_Override

func NewBounce_Override(b Bounce, props *BounceProps)

Experimental.

func NewLambda_Override

func NewLambda_Override(l Lambda, props *LambdaProps)

Experimental.

func NewS3_Override

func NewS3_Override(s S3, props *S3Props)

Experimental.

func NewSns_Override

func NewSns_Override(s Sns, props *SnsProps)

Experimental.

func NewStop_Override

func NewStop_Override(s Stop, props *StopProps)

Experimental.

Types

type AddHeader

type AddHeader interface {
	awsses.IReceiptRuleAction
	Bind(_rule awsses.IReceiptRule) *awsses.ReceiptRuleActionConfig
}

Adds a header to the received email. Experimental.

func NewAddHeader

func NewAddHeader(props *AddHeaderProps) AddHeader

Experimental.

type AddHeaderProps

type AddHeaderProps struct {
	// The name of the header to add.
	//
	// Must be between 1 and 50 characters,
	// inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters
	// and dashes only.
	// Experimental.
	Name *string `json:"name"`
	// The value of the header to add.
	//
	// Must be less than 2048 characters,
	// and must not contain newline characters ("\r" or "\n").
	// Experimental.
	Value *string `json:"value"`
}

Construction properties for a add header action. Experimental.

type Bounce

type Bounce interface {
	awsses.IReceiptRuleAction
	Bind(_rule awsses.IReceiptRule) *awsses.ReceiptRuleActionConfig
}

Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon SNS. Experimental.

func NewBounce

func NewBounce(props *BounceProps) Bounce

Experimental.

type BounceProps

type BounceProps struct {
	// The email address of the sender of the bounced email.
	//
	// This is the address
	// from which the bounce message will be sent.
	// Experimental.
	Sender *string `json:"sender"`
	// The template containing the message, reply code and status code.
	// Experimental.
	Template BounceTemplate `json:"template"`
	// The SNS topic to notify when the bounce action is taken.
	// Experimental.
	Topic awssns.ITopic `json:"topic"`
}

Construction properties for a bounce action. Experimental.

type BounceTemplate

type BounceTemplate interface {
	Props() *BounceTemplateProps
}

A bounce template. Experimental.

func BounceTemplate_MAILBOX_DOES_NOT_EXIST

func BounceTemplate_MAILBOX_DOES_NOT_EXIST() BounceTemplate

func BounceTemplate_MAILBOX_FULL

func BounceTemplate_MAILBOX_FULL() BounceTemplate

func BounceTemplate_MESSAGE_CONTENT_REJECTED

func BounceTemplate_MESSAGE_CONTENT_REJECTED() BounceTemplate

func BounceTemplate_MESSAGE_TOO_LARGE

func BounceTemplate_MESSAGE_TOO_LARGE() BounceTemplate

func BounceTemplate_TEMPORARY_FAILURE

func BounceTemplate_TEMPORARY_FAILURE() BounceTemplate

func NewBounceTemplate

func NewBounceTemplate(props *BounceTemplateProps) BounceTemplate

Experimental.

type BounceTemplateProps

type BounceTemplateProps struct {
	// Human-readable text to include in the bounce message.
	// Experimental.
	Message *string `json:"message"`
	// The SMTP reply code, as defined by RFC 5321.
	// See: https://tools.ietf.org/html/rfc5321
	//
	// Experimental.
	SmtpReplyCode *string `json:"smtpReplyCode"`
	// The SMTP enhanced status code, as defined by RFC 3463.
	// See: https://tools.ietf.org/html/rfc3463
	//
	// Experimental.
	StatusCode *string `json:"statusCode"`
}

Construction properties for a BounceTemplate. Experimental.

type EmailEncoding

type EmailEncoding string

The type of email encoding to use for a SNS action. Experimental.

const (
	EmailEncoding_BASE64 EmailEncoding = "BASE64"
	EmailEncoding_UTF8   EmailEncoding = "UTF8"
)

type Lambda

type Lambda interface {
	awsses.IReceiptRuleAction
	Bind(rule awsses.IReceiptRule) *awsses.ReceiptRuleActionConfig
}

Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS. Experimental.

func NewLambda

func NewLambda(props *LambdaProps) Lambda

Experimental.

type LambdaInvocationType

type LambdaInvocationType string

The type of invocation to use for a Lambda Action. Experimental.

const (
	LambdaInvocationType_EVENT            LambdaInvocationType = "EVENT"
	LambdaInvocationType_REQUEST_RESPONSE LambdaInvocationType = "REQUEST_RESPONSE"
)

type LambdaProps

type LambdaProps struct {
	// The Lambda function to invoke.
	// Experimental.
	Function awslambda.IFunction `json:"function"`
	// The invocation type of the Lambda function.
	// Experimental.
	InvocationType LambdaInvocationType `json:"invocationType"`
	// The SNS topic to notify when the Lambda action is taken.
	// Experimental.
	Topic awssns.ITopic `json:"topic"`
}

Construction properties for a Lambda action. Experimental.

type S3

type S3 interface {
	awsses.IReceiptRuleAction
	Bind(rule awsses.IReceiptRule) *awsses.ReceiptRuleActionConfig
}

Saves the received message to an Amazon S3 bucket and, optionally, publishes a notification to Amazon SNS. Experimental.

func NewS3

func NewS3(props *S3Props) S3

Experimental.

type S3Props

type S3Props struct {
	// The S3 bucket that incoming email will be saved to.
	// Experimental.
	Bucket awss3.IBucket `json:"bucket"`
	// The master key that SES should use to encrypt your emails before saving them to the S3 bucket.
	// Experimental.
	KmsKey awskms.IKey `json:"kmsKey"`
	// The key prefix of the S3 bucket.
	// Experimental.
	ObjectKeyPrefix *string `json:"objectKeyPrefix"`
	// The SNS topic to notify when the S3 action is taken.
	// Experimental.
	Topic awssns.ITopic `json:"topic"`
}

Construction properties for a S3 action. Experimental.

type Sns

type Sns interface {
	awsses.IReceiptRuleAction
	Bind(_rule awsses.IReceiptRule) *awsses.ReceiptRuleActionConfig
}

Publishes the email content within a notification to Amazon SNS. Experimental.

func NewSns

func NewSns(props *SnsProps) Sns

Experimental.

type SnsProps

type SnsProps struct {
	// The SNS topic to notify.
	// Experimental.
	Topic awssns.ITopic `json:"topic"`
	// The encoding to use for the email within the Amazon SNS notification.
	// Experimental.
	Encoding EmailEncoding `json:"encoding"`
}

Construction properties for a SNS action. Experimental.

type Stop

type Stop interface {
	awsses.IReceiptRuleAction
	Bind(_rule awsses.IReceiptRule) *awsses.ReceiptRuleActionConfig
}

Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS. Experimental.

func NewStop

func NewStop(props *StopProps) Stop

Experimental.

type StopProps

type StopProps struct {
	// The SNS topic to notify when the stop action is taken.
	// Experimental.
	Topic awssns.ITopic `json:"topic"`
}

Construction properties for a stop action. Experimental.