Class CampaignInboundEmailFilterRequest

java.lang.Object
altitude.integrationServer.types.CampaignInboundEmailFilterRequest
public class CampaignInboundEmailFilterRequest extends Object
Campaign inbound email filter request.

  • Constructor Details

    • CampaignInboundEmailFilterRequest

      public CampaignInboundEmailFilterRequest()

  • Method Details

    • getId

      public int getId()
      Identifier of the filter to update or delete.

    • setId

      public void setId(int value)
      Identifier of the filter to update or delete.

    • getName

      public FieldRequest<String> getName()
      Name of the filter. Mandatory on an insert request.

    • setName

      public void setName(FieldRequest<String> value)
      Name of the filter. Mandatory on an insert request.

    • getFilterType

      public FieldRequest<CampaignInboundEmailFilterType> getFilterType()
      Type of the filter. Mandatory and can only be specified on an insert request. An ISException is thrown if specified on an update request.

    • setFilterType

      public void setFilterType(FieldRequest<CampaignInboundEmailFilterType> value)
      Type of the filter. Mandatory and can only be specified on an insert request. An ISException is thrown if specified on an update request.

    • getAction

      public FieldRequest<CampaignInboundEmailFilterAction> getAction()
      Action to perform on the email filter. Used on a filter with type different than CampaignInboundEmailFilterType.Duplicate. The default value is CampaignInboundEmailFilterAction.Discard.

    • setAction

      public void setAction(FieldRequest<CampaignInboundEmailFilterAction> value)
      Action to perform on the email filter. Used on a filter with type different than CampaignInboundEmailFilterType.Duplicate. The default value is CampaignInboundEmailFilterAction.Discard.

    • getRecoveryCampaignName

      public FieldRequest<String> getRecoveryCampaignName()
      Name of the campaign to forward the email in case of an overflow. Used when the action is CampaignInboundEmailFilterAction.Overflow, and on a filter with type different than CampaignInboundEmailFilterType.Duplicate.

    • setRecoveryCampaignName

      public void setRecoveryCampaignName(FieldRequest<String> value)
      Name of the campaign to forward the email in case of an overflow. Used when the action is CampaignInboundEmailFilterAction.Overflow, and on a filter with type different than CampaignInboundEmailFilterType.Duplicate.

    • getRecoveryAddress

      public FieldRequest<String> getRecoveryAddress()
      Address of to forward the email in case of an overflow. Used when the action is CampaignInboundEmailFilterAction.Overflow, and on a filter with type different than CampaignInboundEmailFilterType.Duplicate.

    • setRecoveryAddress

      public void setRecoveryAddress(FieldRequest<String> value)
      Address of to forward the email in case of an overflow. Used when the action is CampaignInboundEmailFilterAction.Overflow, and on a filter with type different than CampaignInboundEmailFilterType.Duplicate.

    • getValidityTime

      public FieldRequest<Duration> getValidityTime()
      Filter if a duplicate email is received within the specified period of time. Used on a filter with type CampaignInboundEmailFilterType.Duplicate.

    • setValidityTime

      public void setValidityTime(FieldRequest<Duration> value)
      Filter if a duplicate email is received within the specified period of time. Used on a filter with type CampaignInboundEmailFilterType.Duplicate.

    • getSearchForCommonMessages

      public FieldRequest<Boolean> getSearchForCommonMessages()
      Search for common messages. Used on a filter with type CampaignInboundEmailFilterType.Bouncing or CampaignInboundEmailFilterType.DeliveryFailure. The default value is true.

    • setSearchForCommonMessages

      public void setSearchForCommonMessages(FieldRequest<Boolean> value)
      Search for common messages. Used on a filter with type CampaignInboundEmailFilterType.Bouncing or CampaignInboundEmailFilterType.DeliveryFailure. The default value is true.

    • getMessageSize

      public FieldRequest<Integer> getMessageSize()
      Message size (KB). Used on a filter with type CampaignInboundEmailFilterType.Oversized

    • setMessageSize

      public void setMessageSize(FieldRequest<Integer> value)
      Message size (KB). Used on a filter with type CampaignInboundEmailFilterType.Oversized

    • getNotificationEmailId

      public FieldRequest<Integer> getNotificationEmailId()
      Identifier of the email that notifies the email was discarded. Used when the action is CampaignInboundEmailFilterAction.Discard, and on a filter with type CampaignInboundEmailFilterType.Oversized.

    • setNotificationEmailId

      public void setNotificationEmailId(FieldRequest<Integer> value)
      Identifier of the email that notifies the email was discarded. Used when the action is CampaignInboundEmailFilterAction.Discard, and on a filter with type CampaignInboundEmailFilterType.Oversized.

    • getFilterGlobalStringRequests

      public EntityRequest<CampaignInboundEmailFilterGlobalStringRequest>[] getFilterGlobalStringRequests()
      Requests with the strings to global filter. Used on a filter with type CampaignInboundEmailFilterType.Bouncing or CampaignInboundEmailFilterType.DeliveryFailure.

    • setFilterGlobalStringRequests

      public void setFilterGlobalStringRequests(EntityRequest<CampaignInboundEmailFilterGlobalStringRequest>[] value)
      Requests with the strings to global filter. Used on a filter with type CampaignInboundEmailFilterType.Bouncing or CampaignInboundEmailFilterType.DeliveryFailure.

    • getFilterFieldRequests

      public EntityRequest<CampaignInboundEmailFilterFieldRequest>[] getFilterFieldRequests()
      Requests with the strings to filter in fields. Used on a filter with type CampaignInboundEmailFilterType.Field.

    • setFilterFieldRequests

      public void setFilterFieldRequests(EntityRequest<CampaignInboundEmailFilterFieldRequest>[] value)
      Requests with the strings to filter in fields. Used on a filter with type CampaignInboundEmailFilterType.Field.