Module: Aws::MailManager::Types

Defined in:
gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb

Defined Under Namespace

Classes: AccessDeniedException, AddHeaderAction, AddonInstance, AddonSubscription, Analysis, Archive, ArchiveAction, ArchiveBooleanExpression, ArchiveBooleanToEvaluate, ArchiveFilterCondition, ArchiveFilters, ArchiveRetention, ArchiveStringExpression, ArchiveStringToEvaluate, ConflictException, CreateAddonInstanceRequest, CreateAddonInstanceResponse, CreateAddonSubscriptionRequest, CreateAddonSubscriptionResponse, CreateArchiveRequest, CreateArchiveResponse, CreateIngressPointRequest, CreateIngressPointResponse, CreateRelayRequest, CreateRelayResponse, CreateRuleSetRequest, CreateRuleSetResponse, CreateTrafficPolicyRequest, CreateTrafficPolicyResponse, DeleteAddonInstanceRequest, DeleteAddonInstanceResponse, DeleteAddonSubscriptionRequest, DeleteAddonSubscriptionResponse, DeleteArchiveRequest, DeleteArchiveResponse, DeleteIngressPointRequest, DeleteIngressPointResponse, DeleteRelayRequest, DeleteRelayResponse, DeleteRuleSetRequest, DeleteRuleSetResponse, DeleteTrafficPolicyRequest, DeleteTrafficPolicyResponse, DeliverToMailboxAction, ExportDestinationConfiguration, ExportStatus, ExportSummary, GetAddonInstanceRequest, GetAddonInstanceResponse, GetAddonSubscriptionRequest, GetAddonSubscriptionResponse, GetArchiveExportRequest, GetArchiveExportResponse, GetArchiveMessageContentRequest, GetArchiveMessageContentResponse, GetArchiveMessageRequest, GetArchiveMessageResponse, GetArchiveRequest, GetArchiveResponse, GetArchiveSearchRequest, GetArchiveSearchResponse, GetArchiveSearchResultsRequest, GetArchiveSearchResultsResponse, GetIngressPointRequest, GetIngressPointResponse, GetRelayRequest, GetRelayResponse, GetRuleSetRequest, GetRuleSetResponse, GetTrafficPolicyRequest, GetTrafficPolicyResponse, IngressAnalysis, IngressBooleanExpression, IngressBooleanToEvaluate, IngressIpToEvaluate, IngressIpv4Expression, IngressPoint, IngressPointAuthConfiguration, IngressPointConfiguration, IngressPointPasswordConfiguration, IngressStringExpression, IngressStringToEvaluate, IngressTlsProtocolExpression, IngressTlsProtocolToEvaluate, ListAddonInstancesRequest, ListAddonInstancesResponse, ListAddonSubscriptionsRequest, ListAddonSubscriptionsResponse, ListArchiveExportsRequest, ListArchiveExportsResponse, ListArchiveSearchesRequest, ListArchiveSearchesResponse, ListArchivesRequest, ListArchivesResponse, ListIngressPointsRequest, ListIngressPointsResponse, ListRelaysRequest, ListRelaysResponse, ListRuleSetsRequest, ListRuleSetsResponse, ListTagsForResourceRequest, ListTagsForResourceResponse, ListTrafficPoliciesRequest, ListTrafficPoliciesResponse, MessageBody, PolicyCondition, PolicyStatement, Relay, RelayAction, RelayAuthentication, ReplaceRecipientAction, ResourceNotFoundException, Row, Rule, RuleAction, RuleBooleanExpression, RuleBooleanToEvaluate, RuleCondition, RuleDmarcExpression, RuleIpExpression, RuleIpToEvaluate, RuleNumberExpression, RuleNumberToEvaluate, RuleSet, RuleStringExpression, RuleStringToEvaluate, RuleVerdictExpression, RuleVerdictToEvaluate, S3Action, S3ExportDestinationConfiguration, SearchStatus, SearchSummary, SendAction, ServiceQuotaExceededException, StartArchiveExportRequest, StartArchiveExportResponse, StartArchiveSearchRequest, StartArchiveSearchResponse, StopArchiveExportRequest, StopArchiveExportResponse, StopArchiveSearchRequest, StopArchiveSearchResponse, Tag, TagResourceRequest, TagResourceResponse, ThrottlingException, TrafficPolicy, UntagResourceRequest, UntagResourceResponse, UpdateArchiveRequest, UpdateArchiveResponse, UpdateIngressPointRequest, UpdateIngressPointResponse, UpdateRelayRequest, UpdateRelayResponse, UpdateRuleSetRequest, UpdateRuleSetResponse, UpdateTrafficPolicyRequest, UpdateTrafficPolicyResponse, ValidationException

Instance Attribute Summary collapse

Instance Attribute Details

#add_header ⇒ Types::AddHeaderAction

This action adds a header. This can be used to add arbitrary email headers.

Returns:



2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2656

class RuleAction < Struct.new(
  :add_header,
  :archive,
  :deliver_to_mailbox,
  :drop,
  :relay,
  :replace_recipient,
  :send,
  :write_to_s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AddHeader < RuleAction; end
  class Archive < RuleAction; end
  class DeliverToMailbox < RuleAction; end
  class Drop < RuleAction; end
  class Relay < RuleAction; end
  class ReplaceRecipient < RuleAction; end
  class Send < RuleAction; end
  class WriteToS3 < RuleAction; end
  class Unknown < RuleAction; end
end

#analysis ⇒ Types::Analysis

The Add On ARN and its returned value to evaluate in a verdict condition expression.

Returns:



1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1604

class IngressBooleanToEvaluate < Struct.new(
  :analysis,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Analysis < IngressBooleanToEvaluate; end
  class Unknown < IngressBooleanToEvaluate; end
end

#archive ⇒ Types::ArchiveAction

This action archives the email. This can be used to deliver an email to an archive.

Returns:



2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2656

class RuleAction < Struct.new(
  :add_header,
  :archive,
  :deliver_to_mailbox,
  :drop,
  :relay,
  :replace_recipient,
  :send,
  :write_to_s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AddHeader < RuleAction; end
  class Archive < RuleAction; end
  class DeliverToMailbox < RuleAction; end
  class Drop < RuleAction; end
  class Relay < RuleAction; end
  class ReplaceRecipient < RuleAction; end
  class Send < RuleAction; end
  class WriteToS3 < RuleAction; end
  class Unknown < RuleAction; end
end

#attribute ⇒ String

The email verdict attribute to evaluate in a string verdict expression.

Returns:

  • (String) 


221
222
223
224
225
226
227
228
229
230
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 221

class ArchiveBooleanToEvaluate < Struct.new(
  :attribute,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Attribute < ArchiveBooleanToEvaluate; end
  class Unknown < ArchiveBooleanToEvaluate; end
end

#boolean_expression ⇒ Types::RuleBooleanExpression

The condition applies to a boolean expression passed in this field.

Returns:



249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 249

class ArchiveFilterCondition < Struct.new(
  :boolean_expression,
  :string_expression,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BooleanExpression < ArchiveFilterCondition; end
  class StringExpression < ArchiveFilterCondition; end
  class Unknown < ArchiveFilterCondition; end
end

#deliver_to_mailbox ⇒ Types::DeliverToMailboxAction

This action delivers an email to a WorkMail mailbox.

Returns:



2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2656

class RuleAction < Struct.new(
  :add_header,
  :archive,
  :deliver_to_mailbox,
  :drop,
  :relay,
  :replace_recipient,
  :send,
  :write_to_s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AddHeader < RuleAction; end
  class Archive < RuleAction; end
  class DeliverToMailbox < RuleAction; end
  class Drop < RuleAction; end
  class Relay < RuleAction; end
  class ReplaceRecipient < RuleAction; end
  class Send < RuleAction; end
  class WriteToS3 < RuleAction; end
  class Unknown < RuleAction; end
end

#dmarc_expression ⇒ Types::RuleDmarcExpression

The condition applies to a DMARC policy expression passed in this field.

Returns:



2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2760

class RuleCondition < Struct.new(
  :boolean_expression,
  :dmarc_expression,
  :ip_expression,
  :number_expression,
  :string_expression,
  :verdict_expression,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BooleanExpression < RuleCondition; end
  class DmarcExpression < RuleCondition; end
  class IpExpression < RuleCondition; end
  class NumberExpression < RuleCondition; end
  class StringExpression < RuleCondition; end
  class VerdictExpression < RuleCondition; end
  class Unknown < RuleCondition; end
end

#drop ⇒ Types::DropAction

This action terminates the evaluation of rules in the rule set.

Returns:

  • (Types::DropAction) 


2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2656

class RuleAction < Struct.new(
  :add_header,
  :archive,
  :deliver_to_mailbox,
  :drop,
  :relay,
  :replace_recipient,
  :send,
  :write_to_s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AddHeader < RuleAction; end
  class Archive < RuleAction; end
  class DeliverToMailbox < RuleAction; end
  class Drop < RuleAction; end
  class Relay < RuleAction; end
  class ReplaceRecipient < RuleAction; end
  class Send < RuleAction; end
  class WriteToS3 < RuleAction; end
  class Unknown < RuleAction; end
end

#ip_expression ⇒ Types::RuleIpExpression

The condition applies to an IP address expression passed in this field.

Returns:



2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2335

class PolicyCondition < Struct.new(
  :boolean_expression,
  :ip_expression,
  :string_expression,
  :tls_expression,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BooleanExpression < PolicyCondition; end
  class IpExpression < PolicyCondition; end
  class StringExpression < PolicyCondition; end
  class TlsExpression < PolicyCondition; end
  class Unknown < PolicyCondition; end
end

#no_authentication ⇒ Types::NoAuthentication

Keep an empty structure if the relay destination server does not require SMTP credential authentication.

Returns:

  • (Types::NoAuthentication) 


2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2447

class RelayAuthentication < Struct.new(
  :no_authentication,
  :secret_arn,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NoAuthentication < RelayAuthentication; end
  class SecretArn < RelayAuthentication; end
  class Unknown < RelayAuthentication; end
end

#number_expression ⇒ Types::RuleNumberExpression

The condition applies to a number expression passed in this field.

Returns:



2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2760

class RuleCondition < Struct.new(
  :boolean_expression,
  :dmarc_expression,
  :ip_expression,
  :number_expression,
  :string_expression,
  :verdict_expression,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BooleanExpression < RuleCondition; end
  class DmarcExpression < RuleCondition; end
  class IpExpression < RuleCondition; end
  class NumberExpression < RuleCondition; end
  class StringExpression < RuleCondition; end
  class VerdictExpression < RuleCondition; end
  class Unknown < RuleCondition; end
end

#relay ⇒ Types::RelayAction

This action relays the email to another SMTP server.

Returns:



2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2656

class RuleAction < Struct.new(
  :add_header,
  :archive,
  :deliver_to_mailbox,
  :drop,
  :relay,
  :replace_recipient,
  :send,
  :write_to_s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AddHeader < RuleAction; end
  class Archive < RuleAction; end
  class DeliverToMailbox < RuleAction; end
  class Drop < RuleAction; end
  class Relay < RuleAction; end
  class ReplaceRecipient < RuleAction; end
  class Send < RuleAction; end
  class WriteToS3 < RuleAction; end
  class Unknown < RuleAction; end
end

#replace_recipient ⇒ Types::ReplaceRecipientAction

The action replaces certain or all recipients with a different set of recipients.

Returns:



2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2656

class RuleAction < Struct.new(
  :add_header,
  :archive,
  :deliver_to_mailbox,
  :drop,
  :relay,
  :replace_recipient,
  :send,
  :write_to_s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AddHeader < RuleAction; end
  class Archive < RuleAction; end
  class DeliverToMailbox < RuleAction; end
  class Drop < RuleAction; end
  class Relay < RuleAction; end
  class ReplaceRecipient < RuleAction; end
  class Send < RuleAction; end
  class WriteToS3 < RuleAction; end
  class Unknown < RuleAction; end
end

#retention_period ⇒ String

The enum value sets the period for retaining emails in an archive.

Returns:

  • (String) 


294
295
296
297
298
299
300
301
302
303
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 294

class ArchiveRetention < Struct.new(
  :retention_period,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class RetentionPeriod < ArchiveRetention; end
  class Unknown < ArchiveRetention; end
end

#s3 ⇒ Types::S3ExportDestinationConfiguration

Configuration for delivering to an Amazon S3 bucket.

Returns:



900
901
902
903
904
905
906
907
908
909
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 900

class ExportDestinationConfiguration < Struct.new(
  :s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class S3 < ExportDestinationConfiguration; end
  class Unknown < ExportDestinationConfiguration; end
end

#secret_arn ⇒ String

The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.

Returns:

  • (String) 


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1735

class IngressPointConfiguration < Struct.new(
  :secret_arn,
  :smtp_password,
  :unknown)
  SENSITIVE = [:smtp_password]
  include Aws::Structure
  include Aws::Structure::Union

  class SecretArn < IngressPointConfiguration; end
  class SmtpPassword < IngressPointConfiguration; end
  class Unknown < IngressPointConfiguration; end
end

#send ⇒ Types::SendAction

This action sends the email to the internet.

Returns:



2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2656

class RuleAction < Struct.new(
  :add_header,
  :archive,
  :deliver_to_mailbox,
  :drop,
  :relay,
  :replace_recipient,
  :send,
  :write_to_s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AddHeader < RuleAction; end
  class Archive < RuleAction; end
  class DeliverToMailbox < RuleAction; end
  class Drop < RuleAction; end
  class Relay < RuleAction; end
  class ReplaceRecipient < RuleAction; end
  class Send < RuleAction; end
  class WriteToS3 < RuleAction; end
  class Unknown < RuleAction; end
end

#smtp_password ⇒ String

The password of the ingress endpoint resource.

Returns:

  • (String) 


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 1735

class IngressPointConfiguration < Struct.new(
  :secret_arn,
  :smtp_password,
  :unknown)
  SENSITIVE = [:smtp_password]
  include Aws::Structure
  include Aws::Structure::Union

  class SecretArn < IngressPointConfiguration; end
  class SmtpPassword < IngressPointConfiguration; end
  class Unknown < IngressPointConfiguration; end
end

#string_expression ⇒ Types::RuleStringExpression

The condition applies to a string expression passed in this field.

Returns:



249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 249

class ArchiveFilterCondition < Struct.new(
  :boolean_expression,
  :string_expression,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BooleanExpression < ArchiveFilterCondition; end
  class StringExpression < ArchiveFilterCondition; end
  class Unknown < ArchiveFilterCondition; end
end

#tls_expression ⇒ Types::IngressTlsProtocolExpression

This represents a TLS based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.

Returns:



2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2335

class PolicyCondition < Struct.new(
  :boolean_expression,
  :ip_expression,
  :string_expression,
  :tls_expression,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BooleanExpression < PolicyCondition; end
  class IpExpression < PolicyCondition; end
  class StringExpression < PolicyCondition; end
  class TlsExpression < PolicyCondition; end
  class Unknown < PolicyCondition; end
end

#verdict_expression ⇒ Types::RuleVerdictExpression

The condition applies to a verdict expression passed in this field.

Returns:



2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2760

class RuleCondition < Struct.new(
  :boolean_expression,
  :dmarc_expression,
  :ip_expression,
  :number_expression,
  :string_expression,
  :verdict_expression,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BooleanExpression < RuleCondition; end
  class DmarcExpression < RuleCondition; end
  class IpExpression < RuleCondition; end
  class NumberExpression < RuleCondition; end
  class StringExpression < RuleCondition; end
  class VerdictExpression < RuleCondition; end
  class Unknown < RuleCondition; end
end

#write_to_s3 ⇒ Types::S3Action

This action writes the MIME content of the email to an S3 bucket.

Returns:



2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2656

class RuleAction < Struct.new(
  :add_header,
  :archive,
  :deliver_to_mailbox,
  :drop,
  :relay,
  :replace_recipient,
  :send,
  :write_to_s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AddHeader < RuleAction; end
  class Archive < RuleAction; end
  class DeliverToMailbox < RuleAction; end
  class Drop < RuleAction; end
  class Relay < RuleAction; end
  class ReplaceRecipient < RuleAction; end
  class Send < RuleAction; end
  class WriteToS3 < RuleAction; end
  class Unknown < RuleAction; end
end