Class: Aws::MailManager::Types::RuleAction

Inherits:

Struct

• Object
• Struct
• Aws::MailManager::Types::RuleAction

Defined in:

gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb

Overview

Note:

RuleAction is a union - when making an API calls you must set exactly one of the members.

Note:

RuleAction is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RuleAction corresponding to the set member.

The action for a rule to take. Only one of the contained actions can be set.

See Also:

• AWS API Documentation

Direct Known Subclasses

AddHeader, Archive, DeliverToMailbox, Drop, Relay, ReplaceRecipient, Send, Unknown, WriteToS3

Defined Under Namespace

Classes: AddHeader, Archive, DeliverToMailbox, Drop, Relay, ReplaceRecipient, Send, Unknown, WriteToS3

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #add_header ⇒ Types::AddHeaderAction

  This action adds a header.

• #archive ⇒ Types::ArchiveAction

  This action archives the email.

• #deliver_to_mailbox ⇒ Types::DeliverToMailboxAction

  This action delivers an email to a WorkMail mailbox.

• #drop ⇒ Types::DropAction

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

• #relay ⇒ Types::RelayAction

  This action relays the email to another SMTP server.

• #replace_recipient ⇒ Types::ReplaceRecipientAction

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

• #send ⇒ Types::SendAction

  This action sends the email to the internet.

• #unknown ⇒ Object

  Returns the value of attribute unknown.

• #write_to_s3 ⇒ Types::S3Action

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

Instance Attribute Details

#add_header ⇒ Types::AddHeaderAction

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

Returns:

• (Types::AddHeaderAction)

# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2763

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

#archive ⇒ Types::ArchiveAction

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

Returns:

• (Types::ArchiveAction)

# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2763

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

#deliver_to_mailbox ⇒ Types::DeliverToMailboxAction

This action delivers an email to a WorkMail mailbox.

Returns:

• (Types::DeliverToMailboxAction)

# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2763

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

#drop ⇒ Types::DropAction

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

Returns:

• (Types::DropAction)

# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2763

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

#relay ⇒ Types::RelayAction

This action relays the email to another SMTP server.

Returns:

• (Types::RelayAction)

# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2763

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:

• (Types::ReplaceRecipientAction)

# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2763

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

#send ⇒ Types::SendAction

This action sends the email to the internet.

Returns:

• (Types::SendAction)

# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2763

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

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

• (Object) —

  the current value of unknown

# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2763

def unknown
  @unknown
end

#write_to_s3 ⇒ Types::S3Action

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

Returns:

• (Types::S3Action)

# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2763

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