Class: AWS.MailManager

var params = {
  AddonName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
mailmanager.createAddonSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AddonName — (String)

    The name of the Add On to subscribe to. You can only have one subscription for each Add On name.

  • ClientToken — (String)

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • Tags — (Array<map>)

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

    • Key — required — (String)

      The key of the key-value tag.

    • Value — required — (String)

      The value of the key-value tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AddonSubscriptionId — (String)

      The unique ID of the Add On subscription created by this API.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ArchiveName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  KmsKeyArn: 'STRING_VALUE',
  Retention: {
    RetentionPeriod: THREE_MONTHS | SIX_MONTHS | NINE_MONTHS | ONE_YEAR | EIGHTEEN_MONTHS | TWO_YEARS | THIRTY_MONTHS | THREE_YEARS | FOUR_YEARS | FIVE_YEARS | SIX_YEARS | SEVEN_YEARS | EIGHT_YEARS | NINE_YEARS | TEN_YEARS | PERMANENT
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
mailmanager.createArchive(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ArchiveName — (String)

    A unique name for the new archive.

  • ClientToken — (String)

    A unique token Amazon SES uses to recognize retries of this request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • KmsKeyArn — (String)

    The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.

  • Retention — (map)

    The period for retaining emails in the archive before automatic deletion.

    • RetentionPeriod — (String)

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

      Possible values include:
      • "THREE_MONTHS"
      • "SIX_MONTHS"
      • "NINE_MONTHS"
      • "ONE_YEAR"
      • "EIGHTEEN_MONTHS"
      • "TWO_YEARS"
      • "THIRTY_MONTHS"
      • "THREE_YEARS"
      • "FOUR_YEARS"
      • "FIVE_YEARS"
      • "SIX_YEARS"
      • "SEVEN_YEARS"
      • "EIGHT_YEARS"
      • "NINE_YEARS"
      • "TEN_YEARS"
      • "PERMANENT"
  • Tags — (Array<map>)

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

    • Key — required — (String)

      The key of the key-value tag.

    • Value — required — (String)

      The value of the key-value tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ArchiveId — (String)

      The unique identifier for the newly created archive.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IngressPointName: 'STRING_VALUE', /* required */
  RuleSetId: 'STRING_VALUE', /* required */
  TrafficPolicyId: 'STRING_VALUE', /* required */
  Type: OPEN | AUTH, /* required */
  ClientToken: 'STRING_VALUE',
  IngressPointConfiguration: {
    SecretArn: 'STRING_VALUE',
    SmtpPassword: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
mailmanager.createIngressPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientToken — (String)

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • IngressPointConfiguration — (map)

    If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.

    • SecretArn — (String)

      The SecretsManager::Secret ARN of the ingress endpoint resource.

    • SmtpPassword — (String)

      The password of the ingress endpoint resource.

  • IngressPointName — (String)

    A user friendly name for an ingress endpoint resource.

  • RuleSetId — (String)

    The identifier of an existing rule set that you attach to an ingress endpoint resource.

  • Tags — (Array<map>)

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

    • Key — required — (String)

      The key of the key-value tag.

    • Value — required — (String)

      The value of the key-value tag.

  • TrafficPolicyId — (String)

    The identifier of an existing traffic policy that you attach to an ingress endpoint resource.

  • Type — (String)

    The type of the ingress endpoint to create.

    Possible values include:
    • "OPEN"
    • "AUTH"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • IngressPointId — (String)

      The unique identifier for a previously created ingress endpoint.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Authentication: { /* required */
    NoAuthentication: {
    },
    SecretArn: 'STRING_VALUE'
  },
  RelayName: 'STRING_VALUE', /* required */
  ServerName: 'STRING_VALUE', /* required */
  ServerPort: 'NUMBER_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
mailmanager.createRelay(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Authentication — (map)

    Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.

    • NoAuthentication — (map)

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

    • SecretArn — (String)

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

  • ClientToken — (String)

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • RelayName — (String)

    The unique name of the relay resource.

  • ServerName — (String)

    The destination relay server address.

  • ServerPort — (Integer)

    The destination relay server port.

  • Tags — (Array<map>)

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

    • Key — required — (String)

      The key of the key-value tag.

    • Value — required — (String)

      The value of the key-value tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • RelayId — (String)

      A unique identifier of the created relay resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RuleSetName: 'STRING_VALUE', /* required */
  Rules: [ /* required */
    {
      Actions: [ /* required */
        {
          AddHeader: {
            HeaderName: 'STRING_VALUE', /* required */
            HeaderValue: 'STRING_VALUE' /* required */
          },
          Archive: {
            TargetArchive: 'STRING_VALUE', /* required */
            ActionFailurePolicy: CONTINUE | DROP
          },
          DeliverToMailbox: {
            MailboxArn: 'STRING_VALUE', /* required */
            RoleArn: 'STRING_VALUE', /* required */
            ActionFailurePolicy: CONTINUE | DROP
          },
          Drop: {
          },
          Relay: {
            Relay: 'STRING_VALUE', /* required */
            ActionFailurePolicy: CONTINUE | DROP,
            MailFrom: REPLACE | PRESERVE
          },
          ReplaceRecipient: {
            ReplaceWith: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          Send: {
            RoleArn: 'STRING_VALUE', /* required */
            ActionFailurePolicy: CONTINUE | DROP
          },
          WriteToS3: {
            RoleArn: 'STRING_VALUE', /* required */
            S3Bucket: 'STRING_VALUE', /* required */
            ActionFailurePolicy: CONTINUE | DROP,
            S3Prefix: 'STRING_VALUE',
            S3SseKmsKeyId: 'STRING_VALUE'
          }
        },
        /* more items */
      ],
      Conditions: [
        {
          BooleanExpression: {
            Evaluate: { /* required */
              Attribute: READ_RECEIPT_REQUESTED | TLS | TLS_WRAPPED
            },
            Operator: IS_TRUE | IS_FALSE /* required */
          },
          DmarcExpression: {
            Operator: EQUALS | NOT_EQUALS, /* required */
            Values: [ /* required */
              NONE | QUARANTINE | REJECT,
              /* more items */
            ]
          },
          IpExpression: {
            Evaluate: { /* required */
              Attribute: SOURCE_IP
            },
            Operator: CIDR_MATCHES | NOT_CIDR_MATCHES, /* required */
            Values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          NumberExpression: {
            Evaluate: { /* required */
              Attribute: MESSAGE_SIZE
            },
            Operator: EQUALS | NOT_EQUALS | LESS_THAN | GREATER_THAN | LESS_THAN_OR_EQUAL | GREATER_THAN_OR_EQUAL, /* required */
            Value: 'NUMBER_VALUE' /* required */
          },
          StringExpression: {
            Evaluate: { /* required */
              Attribute: MAIL_FROM | HELO | RECIPIENT | SENDER | FROM | SUBJECT | TO | CC
            },
            Operator: EQUALS | NOT_EQUALS | STARTS_WITH | ENDS_WITH | CONTAINS, /* required */
            Values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          VerdictExpression: {
            Evaluate: { /* required */
              Analysis: {
                Analyzer: 'STRING_VALUE', /* required */
                ResultField: 'STRING_VALUE' /* required */
              },
              Attribute: SPF | DKIM
            },
            Operator: EQUALS | NOT_EQUALS, /* required */
            Values: [ /* required */
              PASS | FAIL | GRAY | PROCESSING_FAILED,
              /* more items */
            ]
          }
        },
        /* more items */
      ],
      Name: 'STRING_VALUE',
      Unless: [
        {
          BooleanExpression: {
            Evaluate: { /* required */
              Attribute: READ_RECEIPT_REQUESTED | TLS | TLS_WRAPPED
            },
            Operator: IS_TRUE | IS_FALSE /* required */
          },
          DmarcExpression: {
            Operator: EQUALS | NOT_EQUALS, /* required */
            Values: [ /* required */
              NONE | QUARANTINE | REJECT,
              /* more items */
            ]
          },
          IpExpression: {
            Evaluate: { /* required */
              Attribute: SOURCE_IP
            },
            Operator: CIDR_MATCHES | NOT_CIDR_MATCHES, /* required */
            Values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          NumberExpression: {
            Evaluate: { /* required */
              Attribute: MESSAGE_SIZE
            },
            Operator: EQUALS | NOT_EQUALS | LESS_THAN | GREATER_THAN | LESS_THAN_OR_EQUAL | GREATER_THAN_OR_EQUAL, /* required */
            Value: 'NUMBER_VALUE' /* required */
          },
          StringExpression: {
            Evaluate: { /* required */
              Attribute: MAIL_FROM | HELO | RECIPIENT | SENDER | FROM | SUBJECT | TO | CC
            },
            Operator: EQUALS | NOT_EQUALS | STARTS_WITH | ENDS_WITH | CONTAINS, /* required */
            Values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          VerdictExpression: {
            Evaluate: { /* required */
              Analysis: {
                Analyzer: 'STRING_VALUE', /* required */
                ResultField: 'STRING_VALUE' /* required */
              },
              Attribute: SPF | DKIM
            },
            Operator: EQUALS | NOT_EQUALS, /* required */
            Values: [ /* required */
              PASS | FAIL | GRAY | PROCESSING_FAILED,
              /* more items */
            ]
          }
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  ClientToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
mailmanager.createRuleSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientToken — (String)

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • RuleSetName — (String)

    A user-friendly name for the rule set.

  • Rules — (Array<map>)

    Conditional rules that are evaluated for determining actions on email.

    • Actions — required — (Array<map>)

      The list of actions to execute when the conditions match the incoming email, and none of the "unless conditions" match.

      • AddHeader — (map)

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

        • HeaderName — required — (String)

          The name of the header to add to an email. The header must be prefixed with "X-". Headers are added regardless of whether the header name pre-existed in the email.

        • HeaderValue — required — (String)

          The value of the header to add to the email.

      • Archive — (map)

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

        • ActionFailurePolicy — (String)

          A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified archive has been deleted.

          Possible values include:
          • "CONTINUE"
          • "DROP"
        • TargetArchive — required — (String)

          The identifier of the archive to send the email to.

      • DeliverToMailbox — (map)

        This action delivers an email to a WorkMail mailbox.

        • ActionFailurePolicy — (String)

          A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid.

          Possible values include:
          • "CONTINUE"
          • "DROP"
        • MailboxArn — required — (String)

          The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to.

        • RoleArn — required — (String)

          The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to the workmail:DeliverToMailbox API.

      • Drop — (map)

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

      • Relay — (map)

        This action relays the email to another SMTP server.

        • ActionFailurePolicy — (String)

          A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified relay has been deleted.

          Possible values include:
          • "CONTINUE"
          • "DROP"
        • MailFrom — (String)

          This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server.

          Possible values include:
          • "REPLACE"
          • "PRESERVE"
        • Relay — required — (String)

          The identifier of the relay resource to be used when relaying an email.

      • ReplaceRecipient — (map)

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

        • ReplaceWith — (Array<String>)

          This action specifies the replacement recipient email addresses to insert.

      • Send — (map)

        This action sends the email to the internet.

        • ActionFailurePolicy — (String)

          A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the sendRawEmail API.

          Possible values include:
          • "CONTINUE"
          • "DROP"
        • RoleArn — required — (String)

          The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API.

      • WriteToS3 — (map)

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

        • ActionFailurePolicy — (String)

          A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.

          Possible values include:
          • "CONTINUE"
          • "DROP"
        • RoleArn — required — (String)

          The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.

        • S3Bucket — required — (String)

          The bucket name of the S3 bucket to write to.

        • S3Prefix — (String)

          The S3 prefix to use for the write to the s3 bucket.

        • S3SseKmsKeyId — (String)

          The KMS Key ID to use to encrypt the message in S3.

    • Conditions — (Array<map>)

      The conditions of this rule. All conditions must match the email for the actions to be executed. An empty list of conditions means that all emails match, but are still subject to any "unless conditions"

      • BooleanExpression — (map)

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

        • Evaluate — required — (map)

          The operand on which to perform a boolean condition operation.

          • Attribute — (String)

            The boolean type representing the allowed attribute types for an email.

            Possible values include:
            • "READ_RECEIPT_REQUESTED"
            • "TLS"
            • "TLS_WRAPPED"
        • Operator — required — (String)

          The matching operator for a boolean condition expression.

          Possible values include:
          • "IS_TRUE"
          • "IS_FALSE"
      • DmarcExpression — (map)

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

        • Operator — required — (String)

          The operator to apply to the DMARC policy of the incoming email.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • Values — required — (Array<String>)

          The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match.

      • IpExpression — (map)

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

        • Evaluate — required — (map)

          The IP address to evaluate in this condition.

          • Attribute — (String)

            The attribute of the email to evaluate.

            Possible values include:
            • "SOURCE_IP"
        • Operator — required — (String)

          The operator to evaluate the IP address.

          Possible values include:
          • "CIDR_MATCHES"
          • "NOT_CIDR_MATCHES"
        • Values — required — (Array<String>)

          The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges.

      • NumberExpression — (map)

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

        • Evaluate — required — (map)

          The number to evaluate in a numeric condition expression.

          • Attribute — (String)

            An email attribute that is used as the number to evaluate.

            Possible values include:
            • "MESSAGE_SIZE"
        • Operator — required — (String)

          The operator for a numeric condition expression.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
          • "LESS_THAN"
          • "GREATER_THAN"
          • "LESS_THAN_OR_EQUAL"
          • "GREATER_THAN_OR_EQUAL"
        • Value — required — (Float)

          The value to evaluate in a numeric condition expression.

      • StringExpression — (map)

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

        • Evaluate — required — (map)

          The string to evaluate in a string condition expression.

          • Attribute — (String)

            The email attribute to evaluate in a string condition expression.

            Possible values include:
            • "MAIL_FROM"
            • "HELO"
            • "RECIPIENT"
            • "SENDER"
            • "FROM"
            • "SUBJECT"
            • "TO"
            • "CC"
        • Operator — required — (String)

          The matching operator for a string condition expression.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
          • "STARTS_WITH"
          • "ENDS_WITH"
          • "CONTAINS"
        • Values — required — (Array<String>)

          The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string.

      • VerdictExpression — (map)

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

        • Evaluate — required — (map)

          The verdict to evaluate in a verdict condition expression.

          • Analysis — (map)

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

            • Analyzer — required — (String)

              The Amazon Resource Name (ARN) of an Add On.

            • ResultField — required — (String)

              The returned value from an Add On.

          • Attribute — (String)

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

            Possible values include:
            • "SPF"
            • "DKIM"
        • Operator — required — (String)

          The matching operator for a verdict condition expression.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • Values — required — (Array<String>)

          The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email.

    • Name — (String)

      The user-friendly name of the rule.

    • Unless — (Array<map>)

      The "unless conditions" of this rule. None of the conditions can match the email for the actions to be executed. If any of these conditions do match the email, then the actions are not executed.

      • BooleanExpression — (map)

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

        • Evaluate — required — (map)

          The operand on which to perform a boolean condition operation.

          • Attribute — (String)

            The boolean type representing the allowed attribute types for an email.

            Possible values include:
            • "READ_RECEIPT_REQUESTED"
            • "TLS"
            • "TLS_WRAPPED"
        • Operator — required — (String)

          The matching operator for a boolean condition expression.

          Possible values include:
          • "IS_TRUE"
          • "IS_FALSE"
      • DmarcExpression — (map)

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

        • Operator — required — (String)

          The operator to apply to the DMARC policy of the incoming email.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • Values — required — (Array<String>)

          The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match.

      • IpExpression — (map)

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

        • Evaluate — required — (map)

          The IP address to evaluate in this condition.

          • Attribute — (String)

            The attribute of the email to evaluate.

            Possible values include:
            • "SOURCE_IP"
        • Operator — required — (String)

          The operator to evaluate the IP address.

          Possible values include:
          • "CIDR_MATCHES"
          • "NOT_CIDR_MATCHES"
        • Values — required — (Array<String>)

          The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges.

      • NumberExpression — (map)

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

        • Evaluate — required — (map)

          The number to evaluate in a numeric condition expression.

          • Attribute — (String)

            An email attribute that is used as the number to evaluate.

            Possible values include:
            • "MESSAGE_SIZE"
        • Operator — required — (String)

          The operator for a numeric condition expression.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
          • "LESS_THAN"
          • "GREATER_THAN"
          • "LESS_THAN_OR_EQUAL"
          • "GREATER_THAN_OR_EQUAL"
        • Value — required — (Float)

          The value to evaluate in a numeric condition expression.

      • StringExpression — (map)

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

        • Evaluate — required — (map)

          The string to evaluate in a string condition expression.

          • Attribute — (String)

            The email attribute to evaluate in a string condition expression.

            Possible values include:
            • "MAIL_FROM"
            • "HELO"
            • "RECIPIENT"
            • "SENDER"
            • "FROM"
            • "SUBJECT"
            • "TO"
            • "CC"
        • Operator — required — (String)

          The matching operator for a string condition expression.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
          • "STARTS_WITH"
          • "ENDS_WITH"
          • "CONTAINS"
        • Values — required — (Array<String>)

          The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string.

      • VerdictExpression — (map)

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

        • Evaluate — required — (map)

          The verdict to evaluate in a verdict condition expression.

          • Analysis — (map)

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

            • Analyzer — required — (String)

              The Amazon Resource Name (ARN) of an Add On.

            • ResultField — required — (String)

              The returned value from an Add On.

          • Attribute — (String)

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

            Possible values include:
            • "SPF"
            • "DKIM"
        • Operator — required — (String)

          The matching operator for a verdict condition expression.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
        • Values — required — (Array<String>)

          The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email.

  • Tags — (Array<map>)

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

    • Key — required — (String)

      The key of the key-value tag.

    • Value — required — (String)

      The value of the key-value tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • RuleSetId — (String)

      The identifier of the created rule set.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DefaultAction: ALLOW | DENY, /* required */
  PolicyStatements: [ /* required */
    {
      Action: ALLOW | DENY, /* required */
      Conditions: [ /* required */
        {
          BooleanExpression: {
            Evaluate: { /* required */
              Analysis: {
                Analyzer: 'STRING_VALUE', /* required */
                ResultField: 'STRING_VALUE' /* required */
              }
            },
            Operator: IS_TRUE | IS_FALSE /* required */
          },
          IpExpression: {
            Evaluate: { /* required */
              Attribute: SENDER_IP
            },
            Operator: CIDR_MATCHES | NOT_CIDR_MATCHES, /* required */
            Values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          StringExpression: {
            Evaluate: { /* required */
              Attribute: RECIPIENT
            },
            Operator: EQUALS | NOT_EQUALS | STARTS_WITH | ENDS_WITH | CONTAINS, /* required */
            Values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          TlsExpression: {
            Evaluate: { /* required */
              Attribute: TLS_PROTOCOL
            },
            Operator: MINIMUM_TLS_VERSION | IS, /* required */
            Value: TLS1_2 | TLS1_3 /* required */
          }
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  TrafficPolicyName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  MaxMessageSizeBytes: 'NUMBER_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
mailmanager.createTrafficPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientToken — (String)

    A unique token that Amazon SES uses to recognize subsequent retries of the same request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • DefaultAction — (String)

    Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements

    Possible values include:
    • "ALLOW"
    • "DENY"
  • MaxMessageSizeBytes — (Integer)

    The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.

  • PolicyStatements — (Array<map>)

    Conditional statements for filtering email traffic.

    • Action — required — (String)

      The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.

      Possible values include:
      • "ALLOW"
      • "DENY"
    • Conditions — required — (Array<map>)

      The list of conditions to apply to incoming messages for filtering email traffic.

      • BooleanExpression — (map)

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

        • Evaluate — required — (map)

          The operand on which to perform a boolean condition operation.

          • Analysis — (map)

            The structure type for a boolean condition stating the Add On ARN and its returned value.

            • Analyzer — required — (String)

              The Amazon Resource Name (ARN) of an Add On.

            • ResultField — required — (String)

              The returned value from an Add On.

        • Operator — required — (String)

          The matching operator for a boolean condition expression.

          Possible values include:
          • "IS_TRUE"
          • "IS_FALSE"
      • IpExpression — (map)

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

        • Evaluate — required — (map)

          The left hand side argument of an IP condition expression.

          • Attribute — (String)

            An enum type representing the allowed attribute types for an IP condition.

            Possible values include:
            • "SENDER_IP"
        • Operator — required — (String)

          The matching operator for an IP condition expression.

          Possible values include:
          • "CIDR_MATCHES"
          • "NOT_CIDR_MATCHES"
        • Values — required — (Array<String>)

          The right hand side argument of an IP condition expression.

      • StringExpression — (map)

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

        • Evaluate — required — (map)

          The left hand side argument of a string condition expression.

          • Attribute — (String)

            The enum type representing the allowed attribute types for a string condition.

            Possible values include:
            • "RECIPIENT"
        • Operator — required — (String)

          The matching operator for a string condition expression.

          Possible values include:
          • "EQUALS"
          • "NOT_EQUALS"
          • "STARTS_WITH"
          • "ENDS_WITH"
          • "CONTAINS"
        • Values — required — (Array<String>)

          The right hand side argument of a string condition expression.

      • TlsExpression — (map)

        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'.

        • Evaluate — required — (map)

          The left hand side argument of a TLS condition expression.

          • Attribute — (String)

            The enum type representing the allowed attribute types for the TLS condition.

            Possible values include:
            • "TLS_PROTOCOL"
        • Operator — required — (String)

          The matching operator for a TLS condition expression.

          Possible values include:
          • "MINIMUM_TLS_VERSION"
          • "IS"
        • Value — required — (String)

          The right hand side argument of a TLS condition expression.

          Possible values include:
          • "TLS1_2"
          • "TLS1_3"
  • Tags — (Array<map>)

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

    • Key — required — (String)

      The key of the key-value tag.

    • Value — required — (String)

      The value of the key-value tag.

  • TrafficPolicyName — (String)

    A user-friendly name for the traffic policy resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TrafficPolicyId — (String)

      The identifier of the traffic policy resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AddonInstanceId: 'STRING_VALUE' /* required */
};
mailmanager.deleteAddonInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AddonInstanceId — (String)

    The Add On instance ID to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AddonSubscriptionId: 'STRING_VALUE' /* required */
};
mailmanager.deleteAddonSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AddonSubscriptionId — (String)

    The Add On subscription ID to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ArchiveId: 'STRING_VALUE' /* required */
};
mailmanager.deleteArchive(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ArchiveId — (String)

    The identifier of the archive to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IngressPointId: 'STRING_VALUE' /* required */
};
mailmanager.deleteIngressPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IngressPointId — (String)

    The identifier of the ingress endpoint resource that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RelayId: 'STRING_VALUE' /* required */
};
mailmanager.deleteRelay(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RelayId — (String)

    The unique relay identifier.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RuleSetId: 'STRING_VALUE' /* required */
};
mailmanager.deleteRuleSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RuleSetId — (String)

    The identifier of an existing rule set resource to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  TrafficPolicyId: 'STRING_VALUE' /* required */
};
mailmanager.deleteTrafficPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TrafficPolicyId — (String)

    The identifier of the traffic policy that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AddonInstanceId: 'STRING_VALUE' /* required */
};
mailmanager.getAddonInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AddonInstanceId — (String)

    The Add On instance ID to retrieve information for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AddonInstanceArn — (String)

      The Amazon Resource Name (ARN) of the Add On instance.

    • AddonName — (String)

      The name of the Add On provider associated to the subscription of the instance.

    • AddonSubscriptionId — (String)

      The subscription ID associated to the instance.

    • CreatedTimestamp — (Date)

      The timestamp of when the Add On instance was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AddonSubscriptionId: 'STRING_VALUE' /* required */
};
mailmanager.getAddonSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AddonSubscriptionId — (String)

    The Add On subscription ID to retrieve information for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AddonName — (String)

      The name of the Add On for the subscription.

    • AddonSubscriptionArn — (String)

      Amazon Resource Name (ARN) for the subscription.

    • CreatedTimestamp — (Date)

      The timestamp of when the Add On subscription was created.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ArchiveId: 'STRING_VALUE' /* required */
};
mailmanager.getArchive(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ArchiveId — (String)

    The identifier of the archive to retrieve.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ArchiveArn — (String)

      The Amazon Resource Name (ARN) of the archive.

    • ArchiveId — (String)

      The unique identifier of the archive.

    • ArchiveName — (String)

      The unique name assigned to the archive.

    • ArchiveState — (String)

      The current state of the archive:

      • ACTIVE – The archive is ready and available for use.

      • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

      Possible values include:
      • "ACTIVE"
      • "PENDING_DELETION"
    • CreatedTimestamp — (Date)

      The timestamp of when the archive was created.

    • KmsKeyArn — (String)

      The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.

    • LastUpdatedTimestamp — (Date)

      The timestamp of when the archive was modified.

    • Retention — (map)

      The retention period for emails in this archive.

      • RetentionPeriod — (String)

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

        Possible values include:
        • "THREE_MONTHS"
        • "SIX_MONTHS"
        • "NINE_MONTHS"
        • "ONE_YEAR"
        • "EIGHTEEN_MONTHS"
        • "TWO_YEARS"
        • "THIRTY_MONTHS"
        • "THREE_YEARS"
        • "FOUR_YEARS"
        • "FIVE_YEARS"
        • "SIX_YEARS"
        • "SEVEN_YEARS"
        • "EIGHT_YEARS"
        • "NINE_YEARS"
        • "TEN_YEARS"
        • "PERMANENT"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ExportId: 'STRING_VALUE' /* required */
};
mailmanager.getArchiveExport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ExportId — (String)

    The identifier of the export job to get details for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ArchiveId — (String)

      The identifier of the archive the email export was performed from.

    • ExportDestinationConfiguration — (map)

      Where the exported emails are being delivered.

      • S3 — (map)

        Configuration for delivering to an Amazon S3 bucket.

        • S3Location — (String)

          The S3 location to deliver the exported email data.

    • Filters — (map)

      The criteria used to filter emails included in the export.

      • Include — (Array<map>)

        The filter conditions for emails to include.

        • BooleanExpression — (map)

          A boolean expression to evaluate against email attributes.

          • Evaluate — required — (map)

            The email attribute value to evaluate.

            • Attribute — (String)

              The name of the email attribute to evaluate.

              Possible values include:
              • "HAS_ATTACHMENTS"
          • Operator — required — (String)

            The boolean operator to use for evaluation.

            Possible values include:
            • "IS_TRUE"
            • "IS_FALSE"
        • StringExpression — (map)

          A string expression to evaluate against email attributes.

          • Evaluate — required — (map)

            The attribute of the email to evaluate.

            • Attribute — (String)

              The name of the email attribute to evaluate.

              Possible values include:
              • "TO"
              • "FROM"
              • "CC"
              • "SUBJECT"
          • Operator — required — (String)

            The operator to use when evaluating the string values.

            Possible values include:
            • "CONTAINS"
          • Values — required — (Array<String>)

            The list of string values to evaluate the email attribute against.

      • Unless — (Array<map>)

        The filter conditions for emails to exclude.

        • BooleanExpression — (map)

          A boolean expression to evaluate against email attributes.

          • Evaluate — required — (map)

            The email attribute value to evaluate.

            • Attribute — (String)

              The name of the email attribute to evaluate.

              Possible values include:
              • "HAS_ATTACHMENTS"
          • Operator — required — (String)

            The boolean operator to use for evaluation.

            Possible values include:
            • "IS_TRUE"
            • "IS_FALSE"
        • StringExpression — (map)

          A string expression to evaluate against email attributes.

          • Evaluate — required — (map)

            The attribute of the email to evaluate.

            • Attribute — (String)

              The name of the email attribute to evaluate.

              Possible values include:
              • "TO"
              • "FROM"
              • "CC"
              • "SUBJECT"
          • Operator — required — (String)

            The operator to use when evaluating the string values.

            Possible values include:
            • "CONTAINS"
          • Values — required — (Array<String>)

            The list of string values to evaluate the email attribute against.

    • FromTimestamp — (Date)

      The start of the timestamp range the exported emails cover.

    • MaxResults — (Integer)

      The maximum number of email items included in the export.

    • Status — (map)

      The current status of the export job.

      • CompletionTimestamp — (Date)

        The timestamp of when the export job completed (if finished).

      • ErrorMessage — (String)

        An error message if the export job failed.

      • State — (String)

        The current state of the export job.

        Possible values include:
        • "QUEUED"
        • "PREPROCESSING"
        • "PROCESSING"
        • "COMPLETED"
        • "FAILED"
        • "CANCELLED"
      • SubmissionTimestamp — (Date)

        The timestamp of when the export job was submitted.

    • ToTimestamp — (Date)

      The end of the date range the exported emails cover.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ArchivedMessageId: 'STRING_VALUE' /* required */
};
mailmanager.getArchiveMessage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ArchivedMessageId — (String)

    The unique identifier of the archived email message.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MessageDownloadLink — (String)

      A pre-signed URL to temporarily download the full message content.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ArchivedMessageId: 'STRING_VALUE' /* required */
};
mailmanager.getArchiveMessageContent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ArchivedMessageId — (String)

    The unique identifier of the archived email message.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Body — (map)

      The textual body content of the email message.

      • Html — (String)

        The HTML body content of the message.

      • MessageMalformed — (Boolean)

        A flag indicating if the email was malformed.

      • Text — (String)

        The plain text body content of the message.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  SearchId: 'STRING_VALUE' /* required */
};
mailmanager.getArchiveSearch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SearchId — (String)

    The identifier of the search job to get details for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ArchiveId — (String)

      The identifier of the archive the email search was performed in.

    • Filters — (map)

      The criteria used to filter emails included in the search.

      • Include — (Array<map>)

        The filter conditions for emails to include.

        • BooleanExpression — (map)

          A boolean expression to evaluate against email attributes.

          • Evaluate — required — (map)

            The email attribute value to evaluate.

            • Attribute — (String)

              The name of the email attribute to evaluate.

              Possible values include:
              • "HAS_ATTACHMENTS"
          • Operator — required — (String)

            The boolean operator to use for evaluation.

            Possible values include:
            • "IS_TRUE"
            • "IS_FALSE"
        • StringExpression — (map)

          A string expression to evaluate against email attributes.

          • Evaluate — required — (map)

            The attribute of the email to evaluate.

            • Attribute — (String)

              The name of the email attribute to evaluate.

              Possible values include:
              • "TO"
              • "FROM"
              • "CC"
              • "SUBJECT"
          • Operator — required — (String)

            The operator to use when evaluating the string values.

            Possible values include:
            • "CONTAINS"
          • Values — required — (Array<String>)

            The list of string values to evaluate the email attribute against.

      • Unless — (Array<map>)

        The filter conditions for emails to exclude.

        • BooleanExpression — (map)

          A boolean expression to evaluate against email attributes.

          • Evaluate — required — (map)

            The email attribute value to evaluate.

            • Attribute — (String)

              The name of the email attribute to evaluate.

              Possible values include:
              • "HAS_ATTACHMENTS"
          • Operator — required — (String)

            The boolean operator to use for evaluation.

            Possible values include:
            • "IS_TRUE"
            • "IS_FALSE"
        • StringExpression — (map)

          A string expression to evaluate against email attributes.

          • Evaluate — required — (map)

            The attribute of the email to evaluate.

            • Attribute — (String)

              The name of the email attribute to evaluate.

              Possible values include:
              • "TO"
              • "FROM"
              • "CC"
              • "SUBJECT"
          • Operator — required — (String)

            The operator to use when evaluating the string values.

            Possible values include:
            • "CONTAINS"
          • Values — required — (Array<String>)

            The list of string values to evaluate the email attribute against.

    • FromTimestamp — (Date)

      The start timestamp of the range the searched emails cover.

    • MaxResults — (Integer)

      The maximum number of search results to return.

    • Status — (map)

      The current status of the search job.

      • CompletionTimestamp — (Date)

        The timestamp of when the search completed (if finished).

      • ErrorMessage — (String)

        An error message if the search failed.

      • State — (String)

        The current state of the search job.

        Possible values include:
        • "QUEUED"
        • "RUNNING"
        • "COMPLETED"
        • "FAILED"
        • "CANCELLED"
      • SubmissionTimestamp — (Date)

        The timestamp of when the search was submitted.

    • ToTimestamp — (Date)

      The end timestamp of the range the searched emails cover.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  SearchId: 'STRING_VALUE' /* required */
};
mailmanager.getArchiveSearchResults(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SearchId — (String)

    The identifier of the completed search job.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Rows — (Array<map>)

      The list of email result objects matching the search criteria.

      • ArchivedMessageId — (String)

        The unique identifier of the archived message.

      • Cc — (String)

        The email addresses in the CC header.

      • Date — (String)

        The date the email was sent.

      • From — (String)

        The email address of the sender.

      • HasAttachments — (Boolean)

        A flag indicating if the email has attachments.

      • InReplyTo — (String)

        The email message ID this is a reply to.

      • MessageId — (String)

        The unique message ID of the email.

      • ReceivedHeaders — (Array<String>)

        The received headers from the email delivery path.

      • ReceivedTimestamp — (Date)

        The timestamp of when the email was received.

      • Subject — (String)

        The subject header value of the email.

      • To — (String)

        The email addresses in the To header.

      • XMailer — (String)

        The user agent that sent the email.

      • XOriginalMailer — (String)

        The original user agent that sent the email.

      • XPriority — (String)

        The priority level of the email.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IngressPointId: 'STRING_VALUE' /* required */
};
mailmanager.getIngressPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • IngressPointId — (String)

    The identifier of an ingress endpoint.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ARecord — (String)

      The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.

    • CreatedTimestamp — (Date)

      The timestamp of when the ingress endpoint was created.

    • IngressPointArn — (String)

      The Amazon Resource Name (ARN) of the ingress endpoint resource.

    • IngressPointAuthConfiguration — (map)

      The authentication configuration of the ingress endpoint resource.

      • IngressPointPasswordConfiguration — (map)

        The ingress endpoint password configuration for the ingress endpoint resource.

        • PreviousSmtpPasswordExpiryTimestamp — (Date)

          The previous password expiry timestamp of the ingress endpoint resource.

        • PreviousSmtpPasswordVersion — (String)

          The previous password version of the ingress endpoint resource.

        • SmtpPasswordVersion — (String)

          The current password expiry timestamp of the ingress endpoint resource.

      • SecretArn — (String)

        The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint resource.

    • IngressPointId — (String)

      The identifier of an ingress endpoint resource.

    • IngressPointName — (String)

      A user friendly name for the ingress endpoint.

    • LastUpdatedTimestamp — (Date)

      The timestamp of when the ingress endpoint was last updated.

    • RuleSetId — (String)

      The identifier of a rule set resource associated with the ingress endpoint.

    • Status — (String)

      The status of the ingress endpoint resource.

      Possible values include:
      • "PROVISIONING"
      • "DEPROVISIONING"
      • "UPDATING"
      • "ACTIVE"
      • "CLOSED"
      • "FAILED"
    • TrafficPolicyId — (String)

      The identifier of the traffic policy resource associated with the ingress endpoint.

    • Type — (String)

      The type of ingress endpoint.

      Possible values include:
      • "OPEN"
      • "AUTH"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RelayId: 'STRING_VALUE' /* required */
};
mailmanager.getRelay(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RelayId — (String)

    A unique relay identifier.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Authentication — (map)

      The authentication attribute—contains the secret ARN where the customer relay server credentials are stored.

      • NoAuthentication — (map)

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

      • SecretArn — (String)

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

    • CreatedTimestamp — (Date)

      The timestamp of when the relay was created.

    • LastModifiedTimestamp — (Date)

      The timestamp of when relay was last updated.

    • RelayArn — (String)

      The Amazon Resource Name (ARN) of the relay.

    • RelayId — (String)

      The unique relay identifier.

    • RelayName — (String)

      The unique name of the relay.

    • ServerName — (String)

      The destination relay server address.

    • ServerPort — (Integer)

      The destination relay server port.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  RuleSetId: 'STRING_VALUE' /* required */
};
mailmanager.getRuleSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RuleSetId — (String)

    The identifier of an existing rule set to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CreatedDate — (Date)

      The date of when then rule set was created.

    • LastModificationDate — (Date)

      The date of when the rule set was last modified.

    • RuleSetArn — (String)

      The Amazon Resource Name (ARN) of the rule set resource.

    • RuleSetId — (String)

      The identifier of the rule set resource.

    • RuleSetName — (String)

      A user-friendly name for the rule set resource.

    • Rules — (Array<map>)

      The rules contained in the rule set.

      • Actions — required — (Array<map>)

        The list of actions to execute when the conditions match the incoming email, and none of the "unless conditions" match.

        • AddHeader — (map)

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

          • HeaderName — required — (String)

            The name of the header to add to an email. The header must be prefixed with "X-". Headers are added regardless of whether the header name pre-existed in the email.

          • HeaderValue — required — (String)

            The value of the header to add to the email.

        • Archive — (map)

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

          • ActionFailurePolicy — (String)

            A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified archive has been deleted.

            Possible values include:
            • "CONTINUE"
            • "DROP"
          • TargetArchive — required — (String)

            The identifier of the archive to send the email to.

        • DeliverToMailbox — (map)

          This action delivers an email to a WorkMail mailbox.

          • ActionFailurePolicy — (String)

            A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid.

            Possible values include:
            • "CONTINUE"
            • "DROP"
          • MailboxArn — required — (String)

            The Amazon Resource Name (ARN) of a WorkMail organization to deliver the email to.

          • RoleArn — required — (String)

            The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to the workmail:DeliverToMailbox API.

        • Drop — (map)

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

        • Relay — (map)

          This action relays the email to another SMTP server.

          • ActionFailurePolicy — (String)

            A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified relay has been deleted.

            Possible values include:
            • "CONTINUE"
            • "DROP"
          • MailFrom — (String)

            This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server.

            Possible values include:
            • "REPLACE"
            • "PRESERVE"
          • Relay — required — (String)

            The identifier of the relay resource to be used when relaying an email.

        • ReplaceRecipient — (map)

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

          • ReplaceWith — (Array<String>)

            This action specifies the replacement recipient email addresses to insert.

        • Send — (map)

          This action sends the email to the internet.

          • ActionFailurePolicy — (String)

            A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the sendRawEmail API.

            Possible values include:
            • "CONTINUE"
            • "DROP"
          • RoleArn — required — (String)

            The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API.

        • WriteToS3 — (map)

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

          • ActionFailurePolicy — (String)

            A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.

            Possible values include:
            • "CONTINUE"
            • "DROP"
          • RoleArn — required — (String)

            The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.

          • S3Bucket — required — (String)

            The bucket name of the S3 bucket to write to.

          • S3Prefix — (String)

            The S3 prefix to use for the write to the s3 bucket.

          • S3SseKmsKeyId — (String)

            The KMS Key ID to use to encrypt the message in S3.

      • Conditions — (Array<map>)

        The conditions of this rule. All conditions must match the email for the actions to be executed. An empty list of conditions means that all emails match, but are still subject to any "unless conditions"

        • BooleanExpression — (map)

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

          • Evaluate — required — (map)

            The operand on which to perform a boolean condition operation.

            • Attribute — (String)

              The boolean type representing the allowed attribute types for an email.

              Possible values include:
              • "READ_RECEIPT_REQUESTED"
              • "TLS"
              • "TLS_WRAPPED"
          • Operator — required — (String)

            The matching operator for a boolean condition expression.

            Possible values include:
            • "IS_TRUE"
            • "IS_FALSE"
        • DmarcExpression — (map)

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

          • Operator — required — (String)

            The operator to apply to the DMARC policy of the incoming email.

            Possible values include:
            • "EQUALS"
            • "NOT_EQUALS"
          • Values — required — (Array<String>)

            The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match.

        • IpExpression — (map)

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

          • Evaluate — required — (map)

            The IP address to evaluate in this condition.

            • Attribute — (String)

              The attribute of the email to evaluate.

              Possible values include:
              • "SOURCE_IP"
          • Operator — required — (String)

            The operator to evaluate the IP address.

            Possible values include:
            • "CIDR_MATCHES"
            • "NOT_CIDR_MATCHES"
          • Values — required — (Array<String>)

            The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges.

        • NumberExpression — (map)

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

          • Evaluate — required — (map)

            The number to evaluate in a numeric condition expression.

            • Attribute — (String)

              An email attribute that is used as the number to evaluate.

              Possible values include:
              • "MESSAGE_SIZE"
          • Operator — required — (String)

            The operator for a numeric condition expression.

            Possible values include:
            • "EQUALS"
            • "NOT_EQUALS"
            • "LESS_THAN"
            • "GREATER_THAN"
            • "LESS_THAN_OR_EQUAL"
            • "GREATER_THAN_OR_EQUAL"
          • Value — required — (Float)

            The value to evaluate in a numeric condition expression.

        • StringExpression — (map)

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

          • Evaluate — required — (map)

            The string to evaluate in a string condition expression.

            • Attribute — (String)

              The email attribute to evaluate in a string condition expression.

              Possible values include:
              • "MAIL_FROM"
              • "HELO"
              • "RECIPIENT"
              • "SENDER"
              • "FROM"
              • "SUBJECT"
              • "TO"
              • "CC"
          • Operator — required — (String)

            The matching operator for a string condition expression.

            Possible values include:
            • "EQUALS"
            • "NOT_EQUALS"
            • "STARTS_WITH"
            • "ENDS_WITH"
            • "CONTAINS"
          • Values — required — (Array<String>)

            The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string.

        • VerdictExpression — (map)

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

          • Evaluate — required — (map)

            The verdict to evaluate in a verdict condition expression.

            • Analysis — (map)

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

              • Analyzer — required — (String)

                The Amazon Resource Name (ARN) of an Add On.

              • ResultField — required — (String)

                The returned value from an Add On.

            • Attribute — (String)

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

              Possible values include:
              • "SPF"
              • "DKIM"
          • Operator — required — (String)

            The matching operator for a verdict condition expression.

            Possible values include:
            • "EQUALS"
            • "NOT_EQUALS"
          • Values — required — (Array<String>)

            The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email.

      • Name — (String)

        The user-friendly name of the rule.

      • Unless — (Array<map>)

        The "unless conditions" of this rule. None of the conditions can match the email for the actions to be executed. If any of these conditions do match the email, then the actions are not executed.

        • BooleanExpression — (map)

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

          • Evaluate — required — (map)

            The operand on which to perform a boolean condition operation.

            • Attribute — (String)

              The boolean type representing the allowed attribute types for an email.

              Possible values include:
              • "READ_RECEIPT_REQUESTED"
              • "TLS"
              • "TLS_WRAPPED"
          • Operator — required — (String)

            The matching operator for a boolean condition expression.

            Possible values include:
            • "IS_TRUE"
            • "IS_FALSE"
        • DmarcExpression — (map)

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

          • Operator — required — (String)

            The operator to apply to the DMARC policy of the incoming email.

            Possible values include:
            • "EQUALS"
            • "NOT_EQUALS"
          • Values — required — (Array<String>)

            The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match.

        • IpExpression — (map)

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

          • Evaluate — required — (map)

            The IP address to evaluate in this condition.

            • Attribute — (String)

              The attribute of the email to evaluate.

              Possible values include:
              • "SOURCE_IP"
          • Operator — required — (String)

            The operator to evaluate the IP address.

            Possible values include:
            • "CIDR_MATCHES"
            • "NOT_CIDR_MATCHES"
          • Values — required — (Array<String>)

            The IP CIDR blocks in format "x.y.z.w/n" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges.

        • NumberExpression — (map)

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

          • Evaluate — required — (map)

            The number to evaluate in a numeric condition expression.

            • Attribute — (String)

              An email attribute that is used as the number to evaluate.

              Possible values include:
              • "MESSAGE_SIZE"
          • Operator — required — (String)

            The operator for a numeric condition expression.

            Possible values include:
            • "EQUALS"
            • "NOT_EQUALS"
            • "LESS_THAN"
            • "GREATER_THAN"
            • "LESS_THAN_OR_EQUAL"
            • "GREATER_THAN_OR_EQUAL"
          • Value — required — (Float)

            The value to evaluate in a numeric condition expression.

        • StringExpression — (map)

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

          • Evaluate — required — (map)

            The string to evaluate in a string condition expression.

            • Attribute — (String)

              The email attribute to evaluate in a string condition expression.

              Possible values include:
              • "MAIL_FROM"
              • "HELO"
              • "RECIPIENT"
              • "SENDER"
              • "FROM"
              • "SUBJECT"
              • "TO"
              • "CC"
          • Operator — required — (String)

            The matching operator for a string condition expression.

            Possible values include:
            • "EQUALS"
            • "NOT_EQUALS"
            • "STARTS_WITH"
            • "ENDS_WITH"
            • "CONTAINS"
          • Values — required — (Array<String>)

            The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string.

        • VerdictExpression — (map)

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

          • Evaluate — required — (map)

            The verdict to evaluate in a verdict condition expression.

            • Analysis — (map)

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

              • Analyzer — required — (String)

                The Amazon Resource Name (ARN) of an Add On.

              • ResultField — required — (String)

                The returned value from an Add On.

            • Attribute — (String)

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

              Possible values include:
              • "SPF"
              • "DKIM"
          • Operator — required — (String)

            The matching operator for a verdict condition expression.

            Possible values include:
            • "EQUALS"
            • "NOT_EQUALS"
          • Values — required — (Array<String>)

            The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  TrafficPolicyId: 'STRING_VALUE' /* required */
};
mailmanager.getTrafficPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TrafficPolicyId — (String)

    The identifier of the traffic policy resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CreatedTimestamp — (Date)

      The timestamp of when the traffic policy was created.

    • DefaultAction — (String)

      The default action of the traffic policy.

      Possible values include:
      • "ALLOW"
      • "DENY"
    • LastUpdatedTimestamp — (Date)

      The timestamp of when the traffic policy was last updated.

    • MaxMessageSizeBytes — (Integer)

      The maximum message size in bytes of email which is allowed in by this traffic policy—anything larger will be blocked.

    • PolicyStatements — (Array<map>)

      The list of conditions which are in the traffic policy resource.

      • Action — required — (String)

        The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.

        Possible values include:
        • "ALLOW"
        • "DENY"
      • Conditions — required — (Array<map>)

        The list of conditions to apply to incoming messages for filtering email traffic.

        • BooleanExpression — (map)

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

          • Evaluate — required — (map)

            The operand on which to perform a boolean condition operation.

            • Analysis — (map)

              The structure type for a boolean condition stating the Add On ARN and its returned value.

              • Analyzer — required — (String)

                The Amazon Resource Name (ARN) of an Add On.

              • ResultField — required — (String)

                The returned value from an Add On.

          • Operator — required — (String)

            The matching operator for a boolean condition expression.

            Possible values include:
            • "IS_TRUE"
            • "IS_FALSE"
        • IpExpression — (map)

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

          • Evaluate — required — (map)

            The left hand side argument of an IP condition expression.

            • Attribute — (String)

              An enum type representing the allowed attribute types for an IP condition.

              Possible values include:
              • "SENDER_IP"
          • Operator — required — (String)

            The matching operator for an IP condition expression.

            Possible values include:
            • "CIDR_MATCHES"
            • "NOT_CIDR_MATCHES"
          • Values — required — (Array<String>)

            The right hand side argument of an IP condition expression.

        • StringExpression — (map)

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

          • Evaluate — required — (map)

            The left hand side argument of a string condition expression.

            • Attribute — (String)

              The enum type representing the allowed attribute types for a string condition.

              Possible values include:
              • "RECIPIENT"
          • Operator — required — (String)

            The matching operator for a string condition expression.

            Possible values include:
            • "EQUALS"
            • "NOT_EQUALS"
            • "STARTS_WITH"
            • "ENDS_WITH"
            • "CONTAINS"
          • Values — required — (Array<String>)

            The right hand side argument of a string condition expression.

        • TlsExpression — (map)

          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'.

          • Evaluate — required — (map)

            The left hand side argument of a TLS condition expression.

            • Attribute — (String)

              The enum type representing the allowed attribute types for the TLS condition.

              Possible values include:
              • "TLS_PROTOCOL"
          • Operator — required — (String)

            The matching operator for a TLS condition expression.

            Possible values include:
            • "MINIMUM_TLS_VERSION"
            • "IS"
          • Value — required — (String)

            The right hand side argument of a TLS condition expression.

            Possible values include:
            • "TLS1_2"
            • "TLS1_3"
    • TrafficPolicyArn — (String)

      The Amazon Resource Name (ARN) of the traffic policy resource.

    • TrafficPolicyId — (String)

      The identifier of the traffic policy resource.

    • TrafficPolicyName — (String)

      A user-friendly name for the traffic policy resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
mailmanager.listAddonInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • PageSize — (Integer)

    The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AddonInstances — (Array<map>)

      The list of ingress endpoints.

      • AddonInstanceArn — (String)

        The Amazon Resource Name (ARN) of the Add On instance.

      • AddonInstanceId — (String)

        The unique ID of the Add On instance.

      • AddonName — (String)

        The name of the Add On for the instance.

      • AddonSubscriptionId — (String)

        The subscription ID for the instance.

      • CreatedTimestamp — (Date)

        The timestamp of when the Add On instance was created.

    • NextToken — (String)

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
mailmanager.listAddonSubscriptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • PageSize — (Integer)

    The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AddonSubscriptions — (Array<map>)

      The list of ingress endpoints.

      • AddonName — (String)

        The name of the Add On.

      • AddonSubscriptionArn — (String)

        The Amazon Resource Name (ARN) of the Add On subscription.

      • AddonSubscriptionId — (String)

        The unique ID of the Add On subscription.

      • CreatedTimestamp — (Date)

        The timestamp of when the Add On subscription was created.

    • NextToken — (String)

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ArchiveId: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
mailmanager.listArchiveExports(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ArchiveId — (String)

    The identifier of the archive.

  • NextToken — (String)

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • PageSize — (Integer)

    The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain further pages of archives.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Exports — (Array<map>)

      The list of export job identifiers and statuses.

      • ExportId — (String)

        The unique identifier of the export job.

      • Status — (map)

        The current status of the export job.

        • CompletionTimestamp — (Date)

          The timestamp of when the export job completed (if finished).

        • ErrorMessage — (String)

          An error message if the export job failed.

        • State — (String)

          The current state of the export job.

          Possible values include:
          • "QUEUED"
          • "PREPROCESSING"
          • "PROCESSING"
          • "COMPLETED"
          • "FAILED"
          • "CANCELLED"
        • SubmissionTimestamp — (Date)

          The timestamp of when the export job was submitted.

    • NextToken — (String)

      If present, use to retrieve the next page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
mailmanager.listArchives(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • PageSize — (Integer)

    The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Archives — (Array<map>)

      The list of archive details.

      • ArchiveId — required — (String)

        The unique identifier of the archive.

      • ArchiveName — (String)

        The unique name assigned to the archive.

      • ArchiveState — (String)

        The current state of the archive:

        • ACTIVE – The archive is ready and available for use.

        • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

        Possible values include:
        • "ACTIVE"
        • "PENDING_DELETION"
      • LastUpdatedTimestamp — (Date)

        The timestamp of when the archive was last updated.

    • NextToken — (String)

      If present, use to retrieve the next page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ArchiveId: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
mailmanager.listArchiveSearches(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ArchiveId — (String)

    The identifier of the archive.

  • NextToken — (String)

    If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • PageSize — (Integer)

    The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      If present, use to retrieve the next page of results.

    • Searches — (Array<map>)

      The list of search job identifiers and statuses.

      • SearchId — (String)

        The unique identifier of the search job.

      • Status — (map)

        The current status of the search job.

        • CompletionTimestamp — (Date)

          The timestamp of when the search completed (if finished).

        • ErrorMessage — (String)

          An error message if the search failed.

        • State — (String)

          The current state of the search job.

          Possible values include:
          • "QUEUED"
          • "RUNNING"
          • "COMPLETED"
          • "FAILED"
          • "CANCELLED"
        • SubmissionTimestamp — (Date)

          The timestamp of when the search was submitted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
mailmanager.listIngressPoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • PageSize — (Integer)

    The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • IngressPoints — (Array<map>)

      The list of ingress endpoints.

      • ARecord — (String)

        The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.

      • IngressPointId — required — (String)

        The identifier of the ingress endpoint resource.

      • IngressPointName — required — (String)

        A user friendly name for the ingress endpoint resource.

      • Status — required — (String)

        The status of the ingress endpoint resource.

        Possible values include:
        • "PROVISIONING"
        • "DEPROVISIONING"
        • "UPDATING"
        • "ACTIVE"
        • "CLOSED"
        • "FAILED"
      • Type — required — (String)

        The type of ingress endpoint resource.

        Possible values include:
        • "OPEN"
        • "AUTH"
    • NextToken — (String)

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
mailmanager.listRelays(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • PageSize — (Integer)

    The number of relays to be returned in one request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    • Relays — (Array<map>)

      The list of returned relays.

      • LastModifiedTimestamp — (Date)

        The timestamp of when the relay was last modified.

      • RelayId — (String)

        The unique relay identifier.

      • RelayName — (String)

        The unique relay name.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
mailmanager.listRuleSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • PageSize — (Integer)

    The maximum number of rule set resources that are returned per call. You can use NextToken to obtain further rule sets.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    • RuleSets — (Array<map>)

      The list of rule sets.

      • LastModificationDate — (Date)

        The last modification date of the rule set.

      • RuleSetId — (String)

        The identifier of the rule set.

      • RuleSetName — (String)

        A user-friendly name for the rule set.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
mailmanager.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the resource to retrieve tags from.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (Array<map>)

      The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

      • Key — required — (String)

        The key of the key-value tag.

      • Value — required — (String)

        The value of the key-value tag.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
mailmanager.listTrafficPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

  • PageSize — (Integer)

    The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    • TrafficPolicies — (Array<map>)

      The list of traffic policies.

      • DefaultAction — required — (String)

        Default action instructs the traffic policy to either Allow or Deny (block) messages that fall outside of (or not addressed by) the conditions of your policy statements

        Possible values include:
        • "ALLOW"
        • "DENY"
      • TrafficPolicyId — required — (String)

        The identifier of the traffic policy resource.

      • TrafficPolicyName — required — (String)

        A user-friendly name of the traffic policy resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ArchiveId: 'STRING_VALUE', /* required */
  ExportDestinationConfiguration: { /* required */
    S3: {
      S3Location: 'STRING_VALUE'
    }
  },
  FromTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  ToTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  Filters: {
    Include: [
      {
        BooleanExpression: {
          Evaluate: { /* required */
            Attribute: HAS_ATTACHMENTS
          },
          Operator: IS_TRUE | IS_FALSE /* required */
        },
        StringExpression: {
          Evaluate: { /* required */
            Attribute: TO | FROM | CC | SUBJECT
          },
          Operator: CONTAINS, /* required */
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      /* more items */
    ],
    Unless: [
      {
        BooleanExpression: {
          Evaluate: { /* required */
            Attribute: HAS_ATTACHMENTS
          },
          Operator: IS_TRUE | IS_FALSE /* required */
        },
        StringExpression: {
          Evaluate: { /* required */
            Attribute: TO | FROM | CC | SUBJECT
          },
          Operator: CONTAINS, /* required */
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      /* more items */
    ]
  },
  MaxResults: 'NUMBER_VALUE'
};
mailmanager.startArchiveExport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ArchiveId — (String)

    The identifier of the archive to export emails from.

  • ExportDestinationConfiguration — (map)

    Details on where to deliver the exported email data.

    • S3 — (map)

      Configuration for delivering to an Amazon S3 bucket.

      • S3Location — (String)

        The S3 location to deliver the exported email data.

  • Filters — (map)

    Criteria to filter which emails are included in the export.

    • Include — (Array<map>)

      The filter conditions for emails to include.

      • BooleanExpression — (map)

        A boolean expression to evaluate against email attributes.

        • Evaluate — required — (map)

          The email attribute value to evaluate.

          • Attribute — (String)

            The name of the email attribute to evaluate.

            Possible values include:
            • "HAS_ATTACHMENTS"
        • Operator — required — (String)

          The boolean operator to use for evaluation.

          Possible values include:
          • "IS_TRUE"
          • "IS_FALSE"
      • StringExpression — (map)

        A string expression to evaluate against email attributes.

        • Evaluate — required — (map)

          The attribute of the email to evaluate.

          • Attribute — (String)

            The name of the email attribute to evaluate.

            Possible values include:
            • "TO"
            • "FROM"
            • "CC"
            • "SUBJECT"
        • Operator — required — (String)

          The operator to use when evaluating the string values.

          Possible values include:
          • "CONTAINS"
        • Values — required — (Array<String>)

          The list of string values to evaluate the email attribute against.

    • Unless — (Array<map>)

      The filter conditions for emails to exclude.

      • BooleanExpression — (map)

        A boolean expression to evaluate against email attributes.

        • Evaluate — required — (map)

          The email attribute value to evaluate.

          • Attribute — (String)

            The name of the email attribute to evaluate.

            Possible values include:
            • "HAS_ATTACHMENTS"
        • Operator — required — (String)

          The boolean operator to use for evaluation.

          Possible values include:
          • "IS_TRUE"
          • "IS_FALSE"
      • StringExpression — (map)

        A string expression to evaluate against email attributes.

        • Evaluate — required — (map)

          The attribute of the email to evaluate.

          • Attribute — (String)

            The name of the email attribute to evaluate.

            Possible values include:
            • "TO"
            • "FROM"
            • "CC"
            • "SUBJECT"
        • Operator — required — (String)

          The operator to use when evaluating the string values.

          Possible values include:
          • "CONTAINS"
        • Values — required — (Array<String>)

          The list of string values to evaluate the email attribute against.

  • FromTimestamp — (Date)

    The start of the timestamp range to include emails from.

  • MaxResults — (Integer)

    The maximum number of email items to include in the export.

  • ToTimestamp — (Date)

    The end of the timestamp range to include emails from.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ExportId — (String)

      The unique identifier for the initiated export job.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ArchiveId: 'STRING_VALUE', /* required */
  FromTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  MaxResults: 'NUMBER_VALUE', /* required */
  ToTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  Filters: {
    Include: [
      {
        BooleanExpression: {
          Evaluate: { /* required */
            Attribute: HAS_ATTACHMENTS
          },
          Operator: IS_TRUE | IS_FALSE /* required */
        },
        StringExpression: {
          Evaluate: { /* required */
            Attribute: TO | FROM | CC | SUBJECT
          },
          Operator: CONTAINS, /* required */
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      /* more items */
    ],
    Unless: [
      {
        BooleanExpression: {
          Evaluate: { /* required */
            Attribute: HAS_ATTACHMENTS
          },
          Operator: IS_TRUE | IS_FALSE /* required */
        },
        StringExpression: {
          Evaluate: { /* required */
            Attribute: TO | FROM | CC | SUBJECT
          },
          Operator: CONTAINS, /* required */
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      /* more items */
    ]
  }
};
mailmanager.startArchiveSearch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ArchiveId — (String)

    The identifier of the archive to search emails in.

  • Filters — (map)

    Criteria to filter which emails are included in the search results.

    • Include — (Array<map>)

      The filter conditions for emails to include.

      • BooleanExpression — (map)

        A boolean expression to evaluate against email attributes.

        • Evaluate — required — (map)

          The email attribute value to evaluate.

          • Attribute — (String)

            The name of the email attribute to evaluate.

            Possible values include:
            • "HAS_ATTACHMENTS"
        • Operator — required — (String)

          The boolean operator to use for evaluation.

          Possible values include:
          • "IS_TRUE"
          • "IS_FALSE"
      • StringExpression — (map)

        A string expression to evaluate against email attributes.

        • Evaluate — required — (map)

          The attribute of the email to evaluate.

          • Attribute — (String)

            The name of the email attribute to evaluate.

            Possible values include:
            • "TO"
            • "FROM"
            • "CC"
            • "SUBJECT"
        • Operator — required — (String)

          The operator to use when evaluating the string values.

          Possible values include:
          • "CONTAINS"
        • Values — required — (Array<String>)

          The list of string values to evaluate the email attribute against.

    • Unless — (Array<map>)

      The filter conditions for emails to exclude.

      • BooleanExpression — (map)

        A boolean expression to evaluate against email attributes.

        • Evaluate — required — (map)

          The email attribute value to evaluate.

          • Attribute — (String)

            The name of the email attribute to evaluate.

            Possible values include:
            • "HAS_ATTACHMENTS"
        • Operator — required — (String)

          The boolean operator to use for evaluation.

          Possible values include:
          • "IS_TRUE"
          • "IS_FALSE"
      • StringExpression — (map)

        A string expression to evaluate against email attributes.

        • Evaluate — required — (map)

          The attribute of the email to evaluate.

          • Attribute — (String)

            The name of the email attribute to evaluate.

            Possible values include:
            • "TO"
            • "FROM"
            • "CC"
            • "SUBJECT"
        • Operator — required — (String)

          The operator to use when evaluating the string values.

          Possible values include:
          • "CONTAINS"
        • Values — required — (Array<String>)

          The list of string values to evaluate the email attribute against.

  • FromTimestamp — (Date)

    The start timestamp of the range to search emails from.

  • MaxResults — (Integer)

    The maximum number of search results to return.

  • ToTimestamp — (Date)

    The end timestamp of the range to search emails from.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SearchId — (String)

      The unique identifier for the initiated search job.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ExportId: 'STRING_VALUE' /* required */
};
mailmanager.stopArchiveExport(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ExportId — (String)

    The identifier of the export job to stop.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  SearchId: 'STRING_VALUE' /* required */
};
mailmanager.stopArchiveSearch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SearchId — (String)

    The identifier of the search job to stop.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
mailmanager.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the resource that you want to tag.

  • Tags — (Array<map>)

    The tags used to organize, track, or control access for the resource. For example, { "tags": "key2":"value2" }.

    • Key — required — (String)

      The key of the key-value tag.

    • Value — required — (String)

      The value of the key-value tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.