@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class MessageInsightsFilters extends Object implements Serializable, Cloneable, StructuredPojo
An object containing Message Insights filters.
If you specify multiple filters, the filters are joined by AND.
If you specify multiple values for a filter, the values are joined by OR. Filter values are case-sensitive.
FromEmailAddress
, Destination
, and Subject
filters support partial match. A
partial match is performed by using the *
wildcard character placed at the beginning (suffix match), the
end (prefix match) or both ends of the string (contains match). In order to match the literal characters
*
or \
, they must be escaped using the \
character. If no wildcard character
is present, an exact match is performed.
Constructor and Description |
---|
MessageInsightsFilters() |
Modifier and Type | Method and Description |
---|---|
MessageInsightsFilters |
clone() |
boolean |
equals(Object obj) |
List<String> |
getDestination()
The recipient's email address.
|
List<String> |
getFromEmailAddress()
The from address used to send the message.
|
List<String> |
getIsp()
The recipient's ISP (e.g.,
Gmail , Yahoo , etc.). |
List<String> |
getLastDeliveryEvent()
The last delivery-related event for the email, where the ordering is as follows:
SEND <
BOUNCE < DELIVERY < COMPLAINT . |
List<String> |
getLastEngagementEvent()
The last engagement-related event for the email, where the ordering is as follows:
OPEN <
CLICK . |
List<String> |
getSubject()
The subject line of the message.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setDestination(Collection<String> destination)
The recipient's email address.
|
void |
setFromEmailAddress(Collection<String> fromEmailAddress)
The from address used to send the message.
|
void |
setIsp(Collection<String> isp)
The recipient's ISP (e.g.,
Gmail , Yahoo , etc.). |
void |
setLastDeliveryEvent(Collection<String> lastDeliveryEvent)
The last delivery-related event for the email, where the ordering is as follows:
SEND <
BOUNCE < DELIVERY < COMPLAINT . |
void |
setLastEngagementEvent(Collection<String> lastEngagementEvent)
The last engagement-related event for the email, where the ordering is as follows:
OPEN <
CLICK . |
void |
setSubject(Collection<String> subject)
The subject line of the message.
|
String |
toString()
Returns a string representation of this object.
|
MessageInsightsFilters |
withDestination(Collection<String> destination)
The recipient's email address.
|
MessageInsightsFilters |
withDestination(String... destination)
The recipient's email address.
|
MessageInsightsFilters |
withFromEmailAddress(Collection<String> fromEmailAddress)
The from address used to send the message.
|
MessageInsightsFilters |
withFromEmailAddress(String... fromEmailAddress)
The from address used to send the message.
|
MessageInsightsFilters |
withIsp(Collection<String> isp)
The recipient's ISP (e.g.,
Gmail , Yahoo , etc.). |
MessageInsightsFilters |
withIsp(String... isp)
The recipient's ISP (e.g.,
Gmail , Yahoo , etc.). |
MessageInsightsFilters |
withLastDeliveryEvent(Collection<String> lastDeliveryEvent)
The last delivery-related event for the email, where the ordering is as follows:
SEND <
BOUNCE < DELIVERY < COMPLAINT . |
MessageInsightsFilters |
withLastDeliveryEvent(DeliveryEventType... lastDeliveryEvent)
The last delivery-related event for the email, where the ordering is as follows:
SEND <
BOUNCE < DELIVERY < COMPLAINT . |
MessageInsightsFilters |
withLastDeliveryEvent(String... lastDeliveryEvent)
The last delivery-related event for the email, where the ordering is as follows:
SEND <
BOUNCE < DELIVERY < COMPLAINT . |
MessageInsightsFilters |
withLastEngagementEvent(Collection<String> lastEngagementEvent)
The last engagement-related event for the email, where the ordering is as follows:
OPEN <
CLICK . |
MessageInsightsFilters |
withLastEngagementEvent(EngagementEventType... lastEngagementEvent)
The last engagement-related event for the email, where the ordering is as follows:
OPEN <
CLICK . |
MessageInsightsFilters |
withLastEngagementEvent(String... lastEngagementEvent)
The last engagement-related event for the email, where the ordering is as follows:
OPEN <
CLICK . |
MessageInsightsFilters |
withSubject(Collection<String> subject)
The subject line of the message.
|
MessageInsightsFilters |
withSubject(String... subject)
The subject line of the message.
|
public List<String> getFromEmailAddress()
The from address used to send the message.
public void setFromEmailAddress(Collection<String> fromEmailAddress)
The from address used to send the message.
fromEmailAddress
- The from address used to send the message.public MessageInsightsFilters withFromEmailAddress(String... fromEmailAddress)
The from address used to send the message.
NOTE: This method appends the values to the existing list (if any). Use
setFromEmailAddress(java.util.Collection)
or withFromEmailAddress(java.util.Collection)
if you
want to override the existing values.
fromEmailAddress
- The from address used to send the message.public MessageInsightsFilters withFromEmailAddress(Collection<String> fromEmailAddress)
The from address used to send the message.
fromEmailAddress
- The from address used to send the message.public List<String> getDestination()
The recipient's email address.
public void setDestination(Collection<String> destination)
The recipient's email address.
destination
- The recipient's email address.public MessageInsightsFilters withDestination(String... destination)
The recipient's email address.
NOTE: This method appends the values to the existing list (if any). Use
setDestination(java.util.Collection)
or withDestination(java.util.Collection)
if you want to
override the existing values.
destination
- The recipient's email address.public MessageInsightsFilters withDestination(Collection<String> destination)
The recipient's email address.
destination
- The recipient's email address.public List<String> getSubject()
The subject line of the message.
public void setSubject(Collection<String> subject)
The subject line of the message.
subject
- The subject line of the message.public MessageInsightsFilters withSubject(String... subject)
The subject line of the message.
NOTE: This method appends the values to the existing list (if any). Use
setSubject(java.util.Collection)
or withSubject(java.util.Collection)
if you want to override
the existing values.
subject
- The subject line of the message.public MessageInsightsFilters withSubject(Collection<String> subject)
The subject line of the message.
subject
- The subject line of the message.public List<String> getIsp()
The recipient's ISP (e.g., Gmail
, Yahoo
, etc.).
Gmail
, Yahoo
, etc.).public void setIsp(Collection<String> isp)
The recipient's ISP (e.g., Gmail
, Yahoo
, etc.).
isp
- The recipient's ISP (e.g., Gmail
, Yahoo
, etc.).public MessageInsightsFilters withIsp(String... isp)
The recipient's ISP (e.g., Gmail
, Yahoo
, etc.).
NOTE: This method appends the values to the existing list (if any). Use
setIsp(java.util.Collection)
or withIsp(java.util.Collection)
if you want to override the
existing values.
isp
- The recipient's ISP (e.g., Gmail
, Yahoo
, etc.).public MessageInsightsFilters withIsp(Collection<String> isp)
The recipient's ISP (e.g., Gmail
, Yahoo
, etc.).
isp
- The recipient's ISP (e.g., Gmail
, Yahoo
, etc.).public List<String> getLastDeliveryEvent()
The last delivery-related event for the email, where the ordering is as follows: SEND
<
BOUNCE
< DELIVERY
< COMPLAINT
.
SEND
<
BOUNCE
< DELIVERY
< COMPLAINT
.DeliveryEventType
public void setLastDeliveryEvent(Collection<String> lastDeliveryEvent)
The last delivery-related event for the email, where the ordering is as follows: SEND
<
BOUNCE
< DELIVERY
< COMPLAINT
.
lastDeliveryEvent
- The last delivery-related event for the email, where the ordering is as follows: SEND
<
BOUNCE
< DELIVERY
< COMPLAINT
.DeliveryEventType
public MessageInsightsFilters withLastDeliveryEvent(String... lastDeliveryEvent)
The last delivery-related event for the email, where the ordering is as follows: SEND
<
BOUNCE
< DELIVERY
< COMPLAINT
.
NOTE: This method appends the values to the existing list (if any). Use
setLastDeliveryEvent(java.util.Collection)
or withLastDeliveryEvent(java.util.Collection)
if
you want to override the existing values.
lastDeliveryEvent
- The last delivery-related event for the email, where the ordering is as follows: SEND
<
BOUNCE
< DELIVERY
< COMPLAINT
.DeliveryEventType
public MessageInsightsFilters withLastDeliveryEvent(Collection<String> lastDeliveryEvent)
The last delivery-related event for the email, where the ordering is as follows: SEND
<
BOUNCE
< DELIVERY
< COMPLAINT
.
lastDeliveryEvent
- The last delivery-related event for the email, where the ordering is as follows: SEND
<
BOUNCE
< DELIVERY
< COMPLAINT
.DeliveryEventType
public MessageInsightsFilters withLastDeliveryEvent(DeliveryEventType... lastDeliveryEvent)
The last delivery-related event for the email, where the ordering is as follows: SEND
<
BOUNCE
< DELIVERY
< COMPLAINT
.
lastDeliveryEvent
- The last delivery-related event for the email, where the ordering is as follows: SEND
<
BOUNCE
< DELIVERY
< COMPLAINT
.DeliveryEventType
public List<String> getLastEngagementEvent()
The last engagement-related event for the email, where the ordering is as follows: OPEN
<
CLICK
.
Engagement events are only available if Engagement tracking is enabled.
OPEN
<
CLICK
.
Engagement events are only available if Engagement tracking is enabled.
EngagementEventType
public void setLastEngagementEvent(Collection<String> lastEngagementEvent)
The last engagement-related event for the email, where the ordering is as follows: OPEN
<
CLICK
.
Engagement events are only available if Engagement tracking is enabled.
lastEngagementEvent
- The last engagement-related event for the email, where the ordering is as follows: OPEN
<
CLICK
.
Engagement events are only available if Engagement tracking is enabled.
EngagementEventType
public MessageInsightsFilters withLastEngagementEvent(String... lastEngagementEvent)
The last engagement-related event for the email, where the ordering is as follows: OPEN
<
CLICK
.
Engagement events are only available if Engagement tracking is enabled.
NOTE: This method appends the values to the existing list (if any). Use
setLastEngagementEvent(java.util.Collection)
or withLastEngagementEvent(java.util.Collection)
if you want to override the existing values.
lastEngagementEvent
- The last engagement-related event for the email, where the ordering is as follows: OPEN
<
CLICK
.
Engagement events are only available if Engagement tracking is enabled.
EngagementEventType
public MessageInsightsFilters withLastEngagementEvent(Collection<String> lastEngagementEvent)
The last engagement-related event for the email, where the ordering is as follows: OPEN
<
CLICK
.
Engagement events are only available if Engagement tracking is enabled.
lastEngagementEvent
- The last engagement-related event for the email, where the ordering is as follows: OPEN
<
CLICK
.
Engagement events are only available if Engagement tracking is enabled.
EngagementEventType
public MessageInsightsFilters withLastEngagementEvent(EngagementEventType... lastEngagementEvent)
The last engagement-related event for the email, where the ordering is as follows: OPEN
<
CLICK
.
Engagement events are only available if Engagement tracking is enabled.
lastEngagementEvent
- The last engagement-related event for the email, where the ordering is as follows: OPEN
<
CLICK
.
Engagement events are only available if Engagement tracking is enabled.
EngagementEventType
public String toString()
toString
in class Object
Object.toString()
public MessageInsightsFilters clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.