Class: AWSCDK::SESActions::BounceTemplateProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ses_actions/bounce_template_props.rb

Overview

Construction properties for a BounceTemplate.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message:, smtp_reply_code:, status_code: nil) ⇒ BounceTemplateProps

Returns a new instance of BounceTemplateProps.

Parameters:

  • message (String)

    Human-readable text to include in the bounce message.

  • smtp_reply_code (String)

    The SMTP reply code, as defined by RFC 5321.

  • status_code (String, nil) (defaults to: nil)

    The SMTP enhanced status code, as defined by RFC 3463.



10
11
12
13
14
15
16
17
# File 'ses_actions/bounce_template_props.rb', line 10

def initialize(message:, smtp_reply_code:, status_code: nil)
  @message = message
  Jsii::Type.check_type(@message, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "message")
  @smtp_reply_code = smtp_reply_code
  Jsii::Type.check_type(@smtp_reply_code, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "smtpReplyCode")
  @status_code = status_code
  Jsii::Type.check_type(@status_code, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "statusCode") unless @status_code.nil?
end

Instance Attribute Details

#messageString (readonly)

Human-readable text to include in the bounce message.

Returns:

  • (String)


22
23
24
# File 'ses_actions/bounce_template_props.rb', line 22

def message
  @message
end

#smtp_reply_codeString (readonly)

The SMTP reply code, as defined by RFC 5321.

Returns:

  • (String)

See Also:



27
28
29
# File 'ses_actions/bounce_template_props.rb', line 27

def smtp_reply_code
  @smtp_reply_code
end

#status_codeString? (readonly)

The SMTP enhanced status code, as defined by RFC 3463.

Returns:

  • (String, nil)

See Also:



32
33
34
# File 'ses_actions/bounce_template_props.rb', line 32

def status_code
  @status_code
end

Class Method Details

.jsii_propertiesObject



34
35
36
37
38
39
40
# File 'ses_actions/bounce_template_props.rb', line 34

def self.jsii_properties
  {
    :message => "message",
    :smtp_reply_code => "smtpReplyCode",
    :status_code => "statusCode",
  }
end

Instance Method Details

#to_jsiiObject



42
43
44
45
46
47
48
49
50
# File 'ses_actions/bounce_template_props.rb', line 42

def to_jsii
  result = {}
  result.merge!({
    "message" => @message,
    "smtpReplyCode" => @smtp_reply_code,
    "statusCode" => @status_code,
  })
  result.compact
end