Package org.forgerock.opendj.server.config.meta

Class MailServerCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<MailServerCfgClient,MailServerCfg>
org.forgerock.opendj.server.config.meta.MailServerCfgDefn
public final class MailServerCfgDefn extends ManagedObjectDefinition<MailServerCfgClient,MailServerCfg>
An interface for querying the Mail Server managed object definition meta information.

Mail Servers are used to define how to connect and authenticate to an external mail server.

  • Method Details

    • getInstance

      public static MailServerCfgDefn getInstance()
      Get the Mail Server configuration definition singleton.
      Returns:
      Returns the Mail Server configuration definition singleton.

    • createClientConfiguration

      public MailServerCfgClient createClientConfiguration(ManagedObject<? extends MailServerCfgClient> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.
      Specified by:
      createClientConfiguration in class ManagedObjectDefinition<MailServerCfgClient,MailServerCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public MailServerCfg createServerConfiguration(ServerManagedObject<? extends MailServerCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<MailServerCfgClient,MailServerCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<MailServerCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<MailServerCfgClient,MailServerCfg>
      Returns:
      Returns the server configuration class instance associated with this managed object definition.

    • getAuthPasswordPropertyDefinition

      public StringPropertyDefinition getAuthPasswordPropertyDefinition()
      Get the "auth-password" property definition.

      Specifies the password for authenticating to the SMTP server. You must also set the auth-name.

      Returns:
      Returns the "auth-password" property definition.

    • getAuthUsernamePropertyDefinition

      public StringPropertyDefinition getAuthUsernamePropertyDefinition()
      Get the "auth-username" property definition.

      Specifies the username for authenticating to the SMTP server.

      Returns:
      Returns the "auth-username" property definition.

    • getEnabledPropertyDefinition

      public BooleanPropertyDefinition getEnabledPropertyDefinition()
      Get the "enabled" property definition.

      Indicates whether the Mail Server is enabled.

      Returns:
      Returns the "enabled" property definition.

    • getSmtpPropertyPropertyDefinition

      public StringPropertyDefinition getSmtpPropertyPropertyDefinition()
      Get the "smtp-property" property definition.

      Specifies additional options to pass when submitting messages.

      Any supported property can be specified here. Refer to the documentation at https://javaee.github.io/javamail/docs/api/javax/mail/package-summary.html#properties for further information on related properties, their implications, and range values. Note these extra properties will be added after the normal properties are set for this Mail Server.

      Returns:
      Returns the "smtp-property" property definition.

    • getSmtpServerPropertyDefinition

      public StringPropertyDefinition getSmtpServerPropertyDefinition()
      Get the "smtp-server" property definition.

      Specifies the address (and optional port number) for a mail server that can be used to send email messages via SMTP.

      It may be an IP address or resolvable hostname, optionally followed by a colon and a port number.

      Returns:
      Returns the "smtp-server" property definition.

    • getTrustManagerProviderPropertyDefinition

      public AggregationPropertyDefinition<TrustManagerProviderCfgClient,TrustManagerProviderCfg> getTrustManagerProviderPropertyDefinition()
      Get the "trust-manager-provider" property definition.

      Specifies the name of the trust manager that should be used when negotiating SSL connections with remote mail servers.

      Returns:
      Returns the "trust-manager-provider" property definition.

    • getUseSslPropertyDefinition

      public BooleanPropertyDefinition getUseSslPropertyDefinition()
      Get the "use-ssl" property definition.

      Indicates whether the Mail Server should use SSL.

      If enabled, the Mail Server will use SSL to encrypt communication with the clients.

      Returns:
      Returns the "use-ssl" property definition.

    • getUseStartTlsPropertyDefinition

      public BooleanPropertyDefinition getUseStartTlsPropertyDefinition()
      Get the "use-start-tls" property definition.

      Indicates whether to use StartTLS.

      If enabled, the Mail Server will use the StartTLS command after connecting to initiate secure communication over an otherwise insecure channel. Note that this is only allowed if the Mail Server is not configured to use SSL.

      Returns:
      Returns the "use-start-tls" property definition.