Class: Jamf::OAPISchemas::SmtpServerV2

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::SmtpServerV2

Defined in:

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

Overview

OAPI Object Model and Enums for: SmtpServerV2

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.

- Jamf::OAPISchemas::SmtpConnectionSettings
- Jamf::OAPISchemas::SmtpSenderSettings
- Jamf::OAPISchemas::SmtpBasicCredentials
- Jamf::OAPISchemas::SmtpGraphApiCredentials

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

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

Constant Summary

AUTHENTICATION_TYPE_OPTIONS =

Enums used by this class or others

[
  'NONE',
  'BASIC',
  'GRAPH_API'
]

OAPI_PROPERTIES =

{

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

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

  # @!attribute connectionSettings
  #   @return [Jamf::OAPISchemas::SmtpConnectionSettings]
  connectionSettings: {
    class: Jamf::OAPISchemas::SmtpConnectionSettings
  },

  # @!attribute senderSettings
  #   @return [Jamf::OAPISchemas::SmtpSenderSettings]
  senderSettings: {
    class: Jamf::OAPISchemas::SmtpSenderSettings,
    required: true
  },

  # @!attribute basicAuthCredentials
  #   @return [Jamf::OAPISchemas::SmtpBasicCredentials]
  basicAuthCredentials: {
    class: Jamf::OAPISchemas::SmtpBasicCredentials
  },

  # @!attribute graphApiCredentials
  #   @return [Jamf::OAPISchemas::SmtpGraphApiCredentials]
  graphApiCredentials: {
    class: Jamf::OAPISchemas::SmtpGraphApiCredentials
  }

}

Instance Attribute Summary

• #authenticationType ⇒ String
• #basicAuthCredentials ⇒ Jamf::OAPISchemas::SmtpBasicCredentials
• #connectionSettings ⇒ Jamf::OAPISchemas::SmtpConnectionSettings
• #enabled ⇒ Boolean
• #graphApiCredentials ⇒ Jamf::OAPISchemas::SmtpGraphApiCredentials
• #senderSettings ⇒ Jamf::OAPISchemas::SmtpSenderSettings

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#authenticationType ⇒ String

Returns:

• (String)

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

#basicAuthCredentials ⇒ Jamf::OAPISchemas::SmtpBasicCredentials

Returns:

• (Jamf::OAPISchemas::SmtpBasicCredentials)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/smtp_server_v2.rb', line 109

#connectionSettings ⇒ Jamf::OAPISchemas::SmtpConnectionSettings

Returns:

• (Jamf::OAPISchemas::SmtpConnectionSettings)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/smtp_server_v2.rb', line 96

#enabled ⇒ Boolean

Returns:

• (Boolean)

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

#graphApiCredentials ⇒ Jamf::OAPISchemas::SmtpGraphApiCredentials

Returns:

• (Jamf::OAPISchemas::SmtpGraphApiCredentials)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/smtp_server_v2.rb', line 115

#senderSettings ⇒ Jamf::OAPISchemas::SmtpSenderSettings

Returns:

• (Jamf::OAPISchemas::SmtpSenderSettings)

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