Record Class MailpitMessageRelayConfiguration

java.lang.Object
java.lang.Record
io.micronaut.email.mailpit.client.model.MailpitMessageRelayConfiguration
Record Components:
enabled - Whether relay is enabled.
smtpServer - Configured SMTP server.
returnPath - Enforced return path.
allowedRecipients - Allowed recipient pattern.
blockedRecipients - Blocked recipient pattern.
overrideFrom - Override From value.
preserveMessageIds - Whether original Message-IDs are preserved.
recipientAllowlist - Deprecated recipient allowlist value.
public record MailpitMessageRelayConfiguration(boolean enabled, @Nullable String smtpServer, @Nullable String returnPath, @Nullable String allowedRecipients, @Nullable String blockedRecipients, @Nullable String overrideFrom, boolean preserveMessageIds, @Nullable String recipientAllowlist) extends Record
Mailpit message relay configuration.
Since:
3.1.0

  • Constructor Details

    • MailpitMessageRelayConfiguration

      public MailpitMessageRelayConfiguration(boolean enabled, @Nullable String smtpServer, @Nullable String returnPath, @Nullable String allowedRecipients, @Nullable String blockedRecipients, @Nullable String overrideFrom, boolean preserveMessageIds, @Nullable String recipientAllowlist)
      Creates an instance of a MailpitMessageRelayConfiguration record class.
      Parameters:
      enabled - the value for the enabled record component
      smtpServer - the value for the smtpServer record component
      returnPath - the value for the returnPath record component
      allowedRecipients - the value for the allowedRecipients record component
      blockedRecipients - the value for the blockedRecipients record component
      overrideFrom - the value for the overrideFrom record component
      preserveMessageIds - the value for the preserveMessageIds record component
      recipientAllowlist - the value for the recipientAllowlist 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • enabled

      public boolean enabled()
      Returns the value of the enabled record component.
      Returns:
      the value of the enabled record component

    • smtpServer

      public @Nullable String smtpServer()
      Returns the value of the smtpServer record component.
      Returns:
      the value of the smtpServer record component

    • returnPath

      public @Nullable String returnPath()
      Returns the value of the returnPath record component.
      Returns:
      the value of the returnPath record component

    • allowedRecipients

      public @Nullable String allowedRecipients()
      Returns the value of the allowedRecipients record component.
      Returns:
      the value of the allowedRecipients record component

    • blockedRecipients

      public @Nullable String blockedRecipients()
      Returns the value of the blockedRecipients record component.
      Returns:
      the value of the blockedRecipients record component

    • overrideFrom

      public @Nullable String overrideFrom()
      Returns the value of the overrideFrom record component.
      Returns:
      the value of the overrideFrom record component

    • preserveMessageIds

      public boolean preserveMessageIds()
      Returns the value of the preserveMessageIds record component.
      Returns:
      the value of the preserveMessageIds record component

    • recipientAllowlist

      public @Nullable String recipientAllowlist()
      Returns the value of the recipientAllowlist record component.
      Returns:
      the value of the recipientAllowlist record component