Package software.amazon.awssdk.services.mailmanager.model

Class Envelope

java.lang.Object

software.amazon.awssdk.services.mailmanager.model.Envelope

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Envelope.Builder,Envelope>

@Generated("software.amazon.awssdk:codegen")
public final class Envelope
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Envelope.Builder,Envelope>

The SMTP envelope information of the email.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Envelope.Builder

Method Summary

Modifier and Type	Method	Description
static Envelope.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	from()	The RCPT FROM given by the host from which the email was received.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTo()	For responses, this returns true if the service returned a value for the To property.
String	helo()	The HELO used by the host from which the email was received.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Envelope.Builder>	serializableBuilderClass()
List<String>	to()	All SMTP TO entries given by the host from which the email was received.
Envelope.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

from

public final String from()

The RCPT FROM given by the host from which the email was received.

Returns:

The RCPT FROM given by the host from which the email was received.

helo

public final String helo()

The HELO used by the host from which the email was received.

Returns:

The HELO used by the host from which the email was received.

hasTo

public final boolean hasTo()

For responses, this returns true if the service returned a value for the To 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.

to

public final List<String> to()

All SMTP TO entries given by the host from which the email was received.

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 hasTo() method.

Returns:

All SMTP TO entries given by the host from which the email was received.

toBuilder

public Envelope.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Envelope.Builder,Envelope>

builder

public static Envelope.Builder builder()

serializableBuilderClass

public static Class<? extends Envelope.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo