Record Class MailpitSendRequest

java.lang.Object

java.lang.Record

io.micronaut.email.mailpit.client.model.MailpitSendRequest

Record Components:

from - From address.

to - To recipients.

cc - Cc recipients.

bcc - Bcc email addresses.

replyTo - Reply-To recipients.

subject - Subject.

text - Text body.

html - HTML body.

attachments - Attachments.

tags - Tags.

headers - Custom headers.

public record MailpitSendRequest(MailpitSendAddress from, @Nullable List<MailpitSendAddress> to, @Nullable List<MailpitSendAddress> cc, @Nullable List<String> bcc, @Nullable List<MailpitSendAddress> replyTo, @Nullable String subject, @Nullable String text, @Nullable String html, @Nullable List<MailpitSendAttachment> attachments, @Nullable List<String> tags, @Nullable Map<String,String> headers)
extends Record

Request for Mailpit's HTTP send API.

Since:

3.1.0

Constructor Summary

Constructors

Constructor	Description
MailpitSendRequest(MailpitSendAddress from, @Nullable List<MailpitSendAddress> to, @Nullable List<MailpitSendAddress> cc, @Nullable List<String> bcc, @Nullable List<MailpitSendAddress> replyTo, @Nullable String subject, @Nullable String text, @Nullable String html, @Nullable List<MailpitSendAttachment> attachments, @Nullable List<String> tags, @Nullable Map<String,String> headers)	Creates an instance of a MailpitSendRequest record class.

Method Summary

Modifier and Type	Method	Description
@Nullable List<MailpitSendAttachment>	attachments()	Returns the value of the attachments record component.
@Nullable List<String>	bcc()	Returns the value of the bcc record component.
@Nullable List<MailpitSendAddress>	cc()	Returns the value of the cc record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
MailpitSendAddress	from()	Returns the value of the from record component.
final int	hashCode()	Returns a hash code value for this object.
@Nullable Map<String,String>	headers()	Returns the value of the headers record component.
@Nullable String	html()	Returns the value of the html record component.
@Nullable List<MailpitSendAddress>	replyTo()	Returns the value of the replyTo record component.
@Nullable String	subject()	Returns the value of the subject record component.
@Nullable List<String>	tags()	Returns the value of the tags record component.
@Nullable String	text()	Returns the value of the text record component.
@Nullable List<MailpitSendAddress>	to()	Returns the value of the to record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

MailpitSendRequest

public MailpitSendRequest(MailpitSendAddress from,
 @Nullable List<MailpitSendAddress> to,
 @Nullable List<MailpitSendAddress> cc,
 @Nullable List<String> bcc,
 @Nullable List<MailpitSendAddress> replyTo,
 @Nullable String subject,
 @Nullable String text,
 @Nullable String html,
 @Nullable List<MailpitSendAttachment> attachments,
 @Nullable List<String> tags,
 @Nullable Map<String,String> headers)

Creates an instance of a MailpitSendRequest record class.

Parameters:

from - the value for the from record component

to - the value for the to record component

cc - the value for the cc record component

bcc - the value for the bcc record component

replyTo - the value for the replyTo record component

subject - the value for the subject record component

text - the value for the text record component

html - the value for the html record component

attachments - the value for the attachments record component

tags - the value for the tags record component

headers - the value for the headers record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

from

public MailpitSendAddress from()

Returns the value of the from record component.

Returns:

the value of the from record component

to

public @Nullable List<MailpitSendAddress> to()

Returns the value of the to record component.

Returns:

the value of the to record component

cc

public @Nullable List<MailpitSendAddress> cc()

Returns the value of the cc record component.

Returns:

the value of the cc record component

bcc

public @Nullable List<String> bcc()

Returns the value of the bcc record component.

Returns:

the value of the bcc record component

replyTo

public @Nullable List<MailpitSendAddress> replyTo()

Returns the value of the replyTo record component.

Returns:

the value of the replyTo record component

subject

public @Nullable String subject()

Returns the value of the subject record component.

Returns:

the value of the subject record component

text

public @Nullable String text()

Returns the value of the text record component.

Returns:

the value of the text record component

html

public @Nullable String html()

Returns the value of the html record component.

Returns:

the value of the html record component

attachments

public @Nullable List<MailpitSendAttachment> attachments()

Returns the value of the attachments record component.

Returns:

the value of the attachments record component

tags

public @Nullable List<String> tags()

Returns the value of the tags record component.

Returns:

the value of the tags record component

headers

public @Nullable Map<String,String> headers()

Returns the value of the headers record component.

Returns:

the value of the headers record component