org.simplejavamail.api.email

Class Email

java.lang.Object

org.simplejavamail.api.email.Email

All Implemented Interfaces:

Serializable

public class Email
extends Object
implements Serializable

Email message with all necessary data for an effective mailing action, including attachments etc. Exclusively created using EmailBuilder.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Email(@NotNull EmailPopulatingBuilder builder) Simply transfers everything from EmailPopulatingBuilder to this Email instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(@Nullable Object o)
@NotNull List<AttachmentResource>	getAttachments()
@NotNull List<Recipient>	getBccRecipients()
@Nullable Recipient	getBounceToRecipient()
@Nullable CalendarMethod	getCalendarMethod()
@Nullable String	getCalendarText()
@NotNull List<Recipient>	getCcRecipients()
@Nullable ContentTransferEncoding	getContentTransferEncoding()
@NotNull List<AttachmentResource>	getDecryptedAttachments()
@Nullable Recipient	getDispositionNotificationTo()
@Nullable DkimConfig	getDkimConfig()
@Nullable jakarta.mail.internet.MimeMessage	getEmailToForward()
@NotNull List<AttachmentResource>	getEmbeddedImages()
@Nullable Recipient	getFromRecipient()
@NotNull Map<String,Collection<String>>	getHeaders()
@Nullable String	getHTMLText()
@Nullable String	getId()
@NotNull OriginalSmimeDetails	getOriginalSmimeDetails()
@Nullable Pkcs12Config	getPkcs12ConfigForSmimeSigning()
@Nullable String	getPlainText()
@Nullable Set<org.simplejavamail.internal.config.EmailProperty>	getPropertiesNotToApplyDefaultValueFor()
@Nullable Set<org.simplejavamail.internal.config.EmailProperty>	getPropertiesNotToApplyOverrideValueFor()
@NotNull List<Recipient>	getRecipients()
@NotNull List<Recipient>	getReplyToRecipients()
@Nullable Recipient	getReturnReceiptTo()
@Nullable Date	getSentDate()
@Nullable Email	getSmimeSignedEmail()
@Nullable String	getSubject()
@NotNull List<Recipient>	getToRecipients()
@Nullable Boolean	getUseDispositionNotificationTo()
@Nullable Boolean	getUseReturnReceiptTo()
@Nullable X509Certificate	getX509CertificateForSmimeEncryption()
int	hashCode()
boolean	isIgnoreDefaults()
boolean	isIgnoreOverrides()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Email

public Email(@NotNull
             @NotNull EmailPopulatingBuilder builder)

Simply transfers everything from EmailPopulatingBuilder to this Email instance.

See Also:

EmailPopulatingBuilder.buildEmail()

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
                      @Nullable Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

isIgnoreDefaults

public boolean isIgnoreDefaults()

See Also:

EmailPopulatingBuilder.ignoringDefaults(boolean)

isIgnoreOverrides

public boolean isIgnoreOverrides()

See Also:

EmailPopulatingBuilder.ignoringOverrides(boolean)

getPropertiesNotToApplyDefaultValueFor

@Nullable
public @Nullable Set<org.simplejavamail.internal.config.EmailProperty> getPropertiesNotToApplyDefaultValueFor()

See Also:

EmailPopulatingBuilder.dontApplyDefaultValueFor(EmailProperty...)

getPropertiesNotToApplyOverrideValueFor

@Nullable
public @Nullable Set<org.simplejavamail.internal.config.EmailProperty> getPropertiesNotToApplyOverrideValueFor()

See Also:

EmailPopulatingBuilder.dontApplyOverrideValueFor(EmailProperty...)

getId

@Nullable
public @Nullable String getId()

See Also:

EmailPopulatingBuilder.fixingMessageId(String)

getFromRecipient

@Nullable
public @Nullable Recipient getFromRecipient()

See Also:

EmailPopulatingBuilder.from(Recipient)

getReplyToRecipients

@NotNull
public @NotNull List<Recipient> getReplyToRecipients()

See Also:

EmailPopulatingBuilder.withReplyTo(Recipient)

getBounceToRecipient

@Nullable
public @Nullable Recipient getBounceToRecipient()

See Also:

EmailPopulatingBuilder.withBounceTo(Recipient)

getSubject

@Nullable
public @Nullable String getSubject()

See Also:

EmailPopulatingBuilder.withSubject(String)

getUseDispositionNotificationTo

@Nullable
public @Nullable Boolean getUseDispositionNotificationTo()

See Also:

EmailPopulatingBuilder.withDispositionNotificationTo(), EmailPopulatingBuilder.withDispositionNotificationTo(Recipient)

getDispositionNotificationTo

@Nullable
public @Nullable Recipient getDispositionNotificationTo()

See Also:

EmailPopulatingBuilder.withDispositionNotificationTo(), EmailPopulatingBuilder.withDispositionNotificationTo(Recipient)

getUseReturnReceiptTo

@Nullable
public @Nullable Boolean getUseReturnReceiptTo()

See Also:

EmailPopulatingBuilder.withReturnReceiptTo(), EmailPopulatingBuilder.withReturnReceiptTo(Recipient)

getReturnReceiptTo

@Nullable
public @Nullable Recipient getReturnReceiptTo()

See Also:

EmailPopulatingBuilder.withReturnReceiptTo(), EmailPopulatingBuilder.withReturnReceiptTo(Recipient)

getEmailToForward

@Nullable
public @Nullable jakarta.mail.internet.MimeMessage getEmailToForward()

See Also:

EmailStartingBuilder.forwarding(MimeMessage)

getPlainText

@Nullable
public @Nullable String getPlainText()

See Also:

EmailPopulatingBuilder.withPlainText(String)

getHTMLText

@Nullable
public @Nullable String getHTMLText()

See Also:

EmailPopulatingBuilder.withHTMLText(String)

getCalendarMethod

@Nullable
public @Nullable CalendarMethod getCalendarMethod()

See Also:

EmailPopulatingBuilder.withCalendarText(CalendarMethod, String)

getCalendarText

@Nullable
public @Nullable String getCalendarText()

See Also:

EmailPopulatingBuilder.withCalendarText(CalendarMethod, String)

getAttachments

@NotNull
public @NotNull List<AttachmentResource> getAttachments()

See Also:

EmailPopulatingBuilder.withAttachment(String, DataSource)

getDecryptedAttachments

@NotNull
public @NotNull List<AttachmentResource> getDecryptedAttachments()

See Also:

EmailPopulatingBuilder.getDecryptedAttachments()

getEmbeddedImages

@NotNull
public @NotNull List<AttachmentResource> getEmbeddedImages()

See Also:

EmailPopulatingBuilder.withEmbeddedImage(String, DataSource)

getRecipients

@NotNull
public @NotNull List<Recipient> getRecipients()

See Also:

EmailPopulatingBuilder.to(Recipient...), EmailPopulatingBuilder.cc(Recipient...), EmailPopulatingBuilder.bcc(Recipient...)

getToRecipients

@NotNull
public @NotNull List<Recipient> getToRecipients()

See Also:

EmailPopulatingBuilder.to(Recipient...), EmailPopulatingBuilder.cc(Recipient...), EmailPopulatingBuilder.bcc(Recipient...)

getCcRecipients

@NotNull
public @NotNull List<Recipient> getCcRecipients()

See Also:

EmailPopulatingBuilder.to(Recipient...), EmailPopulatingBuilder.cc(Recipient...), EmailPopulatingBuilder.bcc(Recipient...)

getBccRecipients

@NotNull
public @NotNull List<Recipient> getBccRecipients()

See Also:

EmailPopulatingBuilder.to(Recipient...), EmailPopulatingBuilder.cc(Recipient...), EmailPopulatingBuilder.bcc(Recipient...)

getHeaders

@NotNull
public @NotNull Map<String,Collection<String>> getHeaders()

See Also:

EmailPopulatingBuilder.withHeader(String, Object), EmailStartingBuilder.replyingTo(MimeMessage, boolean, String)

getDkimConfig

@Nullable
public @Nullable DkimConfig getDkimConfig()

See Also:

EmailPopulatingBuilder.signWithDomainKey(DkimConfig), EmailPopulatingBuilder.signWithDomainKey(byte[], String, String, Set)

getX509CertificateForSmimeEncryption

@Nullable
public @Nullable X509Certificate getX509CertificateForSmimeEncryption()

See Also:

EmailPopulatingBuilder.signWithSmime(Pkcs12Config), EmailPopulatingBuilder.signWithSmime(InputStream, String, String, String)

getPkcs12ConfigForSmimeSigning

@Nullable
public @Nullable Pkcs12Config getPkcs12ConfigForSmimeSigning()

See Also:

EmailPopulatingBuilder.encryptWithSmime(X509Certificate), EmailPopulatingBuilder.encryptWithSmime(InputStream)

getSmimeSignedEmail

@Nullable
public @Nullable Email getSmimeSignedEmail()

See Also:

EmailPopulatingBuilder.getSmimeSignedEmail()

getOriginalSmimeDetails

@NotNull
public @NotNull OriginalSmimeDetails getOriginalSmimeDetails()

See Also:

EmailPopulatingBuilder.getOriginalSmimeDetails()

getSentDate

@Nullable
public @Nullable Date getSentDate()

See Also:

EmailPopulatingBuilder.fixingSentDate(Date)

getContentTransferEncoding

@Nullable
public @Nullable ContentTransferEncoding getContentTransferEncoding()

See Also:

EmailPopulatingBuilder.withContentTransferEncoding(ContentTransferEncoding)