Class GetDeliverabilityTestReportResponse

    • Method Detail

      • deliverabilityTestReport

        public final DeliverabilityTestReport deliverabilityTestReport()

        An object that contains the results of the predictive inbox placement test.

        Returns:
        An object that contains the results of the predictive inbox placement test.
      • overallPlacement

        public final PlacementStatistics overallPlacement()

        An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.

        Returns:
        An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.
      • hasIspPlacements

        public final boolean hasIspPlacements()
        For responses, this returns true if the service returned a value for the IspPlacements property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • ispPlacements

        public final List<IspPlacement> ispPlacements()

        An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIspPlacements() method.

        Returns:
        An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.
      • message

        public final String message()

        An object that contains the message that you sent when you performed this predictive inbox placement test.

        Returns:
        An object that contains the message that you sent when you performed this predictive inbox placement test.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • tags

        public final List<Tag> tags()

        An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object