Puppet Class: nexus::config::email

Defined in:
manifests/config/email.pp

Summary

Manage the nexus repository manager email settings

Overview

Examples:

include nexus::config::email

Parameters:

  • enabled (Boolean) (defaults to: false) —

    Enable to let nexus repository manager send emails.

  • host (Stdlib::Host) (defaults to: 'localhost') —

    The smtp host to connect to.

  • port (Stdlib::Port) (defaults to: 25) —

    The port to connect to send emails.

  • username (String) (defaults to: '') —

    The username to connect to the smtp server.

  • password (Optional[String]) (defaults to: undef) —

    The password to connect to the smtp server.

  • from_address (String[1]) (defaults to: 'nexus@example.org') —

    The email address used to set as From-Header.

  • subject_prefix (String) (defaults to: '') —

    Prefix which will be added to all emails.

  • start_tls_enabled (Boolean) (defaults to: false) —

    Enable STARTTLS support for insecure connections.

  • start_tls_required (Boolean) (defaults to: false) —

    Require STARTTLS support.

  • ssl_on_connect_enabled (Boolean) (defaults to: false) —

    Enable SSL/TLS encryption upon connection.

  • ssl_server_identity_check_enabled (Boolean) (defaults to: false) —

    Enable server identity check.

  • nexus_trust_store_enabled (Boolean) (defaults to: false) —

    Use certificates stored in the Nexus truststore to connect to external systems.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'manifests/config/email.pp', line 31

class nexus::config::email (
  Boolean $enabled = false,
  Stdlib::Host $host = 'localhost',
  Stdlib::Port $port = 25,
  String $username = '',
  Optional[String] $password = undef,
  String[1] $from_address = 'nexus@example.org',
  String $subject_prefix = '',
  Boolean $start_tls_enabled = false,
  Boolean $start_tls_required = false,
  Boolean $ssl_on_connect_enabled = false,
  Boolean $ssl_server_identity_check_enabled = false,
  Boolean $nexus_trust_store_enabled = false,
) {
  nexus_setting { 'email':
    attributes => {
      'enabled'                       => $enabled,
      'host'                          => $host,
      'port'                          => $port,
      'username'                      => $username,
      'password'                      => $password,
      'fromAddress'                   => $from_address,
      'subjectPrefix'                 => $subject_prefix,
      'startTlsEnabled'               => $start_tls_enabled,
      'startTlsRequired'              => $start_tls_required,
      'sslOnConnectEnabled'           => $ssl_on_connect_enabled,
      'sslServerIdentityCheckEnabled' => $ssl_server_identity_check_enabled,
      'nexusTrustStoreEnabled'        => $nexus_trust_store_enabled,
    },
  }
}