Class: Jamf::OAPISchemas::SmtpServer

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::SmtpServer

Defined in:

lib/jamf/api/jamf_pro/oapi_schemas/smtp_server.rb

Overview

OAPI Object Model and Enums for: SmtpServer

This class was automatically generated from the api/schema URL path on a Jamf Pro server version 11.6.1-t1718634702

This class may be used directly, e.g instances of other classes may use instances of this class as one of their own properties/attributes.

It may also be used as a superclass when implementing Jamf Pro API Resources in ruby-jss. The subclasses include appropriate mixins, and should expand on the basic functionality provided here.

Container Objects: Other object models that use this model as the value in one of their attributes.

Sub Objects: Other object models used by this model’s attributes.

Endpoints and Privileges: API endpoints and HTTP operations that use this object model, and the Jamf Pro privileges needed to access them.

- '/v1/smtp-server:GET' needs permissions:
  - Read SMTP Server
- '/v1/smtp-server:PUT' needs permissions:
  - Update SMTP Server

Constant Summary

ENCRYPTION_TYPE_OPTIONS =

Enums used by this class or others

[
  'NONE',
  'SSL',
  'TLS_1_3',
  'TLS_1_2',
  'TLS_1_1',
  'TLS_1'
]

OAPI_PROPERTIES =

{

  # @!attribute enabled
  #   @return [Boolean]
  enabled: {
    class: :boolean,
    required: true
  },

  # @!attribute server
  #   @return [String]
  server: {
    class: :string,
    required: true
  },

  # @!attribute port
  #   @return [Integer]
  port: {
    class: :integer,
    required: true
  },

  # @!attribute encryptionType
  #   @return [String]
  encryptionType: {
    class: :string,
    required: true,
    enum: ENCRYPTION_TYPE_OPTIONS
  },

  # @!attribute connectionTimeout
  #   @return [Integer]
  connectionTimeout: {
    class: :integer,
    required: true
  },

  # @!attribute senderDisplayName
  #   @return [String]
  senderDisplayName: {
    class: :string,
    required: true
  },

  # @!attribute senderEmailAddress
  #   @return [String]
  senderEmailAddress: {
    class: :string,
    required: true
  },

  # @!attribute requiresAuthentication
  #   @return [Boolean]
  requiresAuthentication: {
    class: :boolean,
    required: true
  },

  # @!attribute username
  #   @return [String]
  username: {
    class: :string
  },

  # @!attribute password
  #   @return [String]
  password: {
    class: :string,
    format: 'password',
    writeonly: true
  }

}

Instance Attribute Summary

• #connectionTimeout ⇒ Integer
• #enabled ⇒ Boolean
• #encryptionType ⇒ String
• #password ⇒ String
• #port ⇒ Integer
• #requiresAuthentication ⇒ Boolean
• #senderDisplayName ⇒ String
• #senderEmailAddress ⇒ String
• #server ⇒ String
• #username ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#connectionTimeout ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/smtp_server.rb', line 110

#enabled ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/smtp_server.rb', line 81

#encryptionType ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/smtp_server.rb', line 102

#password ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/smtp_server.rb', line 144

#port ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/smtp_server.rb', line 95

#requiresAuthentication ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/smtp_server.rb', line 131

#senderDisplayName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/smtp_server.rb', line 117

#senderEmailAddress ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/smtp_server.rb', line 124

#server ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/smtp_server.rb', line 88

#username ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/smtp_server.rb', line 138