Package com.okta.sdk.resource.api

Class EmailServerApi

java.lang.Object
com.okta.sdk.resource.api.EmailServerApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-03-29T16:47:02.065887-05:00[America/Chicago]", comments="Generator version: 7.4.0") public class EmailServerApi extends Object

  • Constructor Details

    • EmailServerApi

      public EmailServerApi()

    • EmailServerApi

      public EmailServerApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createEmailServer

      public EmailServerResponse createEmailServer(EmailServerPost emailServerPost) throws ApiException
      Create a custom SMTP server Creates a custom email SMTP server configuration for your organization
      Parameters:
      emailServerPost - (optional)
      Returns:
      EmailServerResponse
      Throws:
      ApiException - if fails to make API call

    • createEmailServer

      public EmailServerResponse createEmailServer(EmailServerPost emailServerPost, Map<String,String> additionalHeaders) throws ApiException
      Create a custom SMTP server Creates a custom email SMTP server configuration for your organization
      Parameters:
      emailServerPost - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailServerResponse
      Throws:
      ApiException - if fails to make API call

    • deleteEmailServer

      public void deleteEmailServer(String emailServerId) throws ApiException
      Delete an SMTP Server configuration Deletes your organization's custom SMTP server with the given ID
      Parameters:
      emailServerId - (required)
      Throws:
      ApiException - if fails to make API call

    • deleteEmailServer

      public void deleteEmailServer(String emailServerId, Map<String,String> additionalHeaders) throws ApiException
      Delete an SMTP Server configuration Deletes your organization's custom SMTP server with the given ID
      Parameters:
      emailServerId - (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getEmailServer

      public EmailServerListResponse getEmailServer(String emailServerId) throws ApiException
      Retrieve an SMTP Server configuration Retrieves a configuration of your organization's custom SMTP server with the given ID
      Parameters:
      emailServerId - (required)
      Returns:
      EmailServerListResponse
      Throws:
      ApiException - if fails to make API call

    • getEmailServer

      public EmailServerListResponse getEmailServer(String emailServerId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve an SMTP Server configuration Retrieves a configuration of your organization's custom SMTP server with the given ID
      Parameters:
      emailServerId - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailServerListResponse
      Throws:
      ApiException - if fails to make API call

    • listEmailServers

      public EmailServerListResponse listEmailServers() throws ApiException
      List all enrolled SMTP servers Lists all the enrolled custom email SMTP servers
      Returns:
      EmailServerListResponse
      Throws:
      ApiException - if fails to make API call

    • listEmailServers

      public EmailServerListResponse listEmailServers(Map<String,String> additionalHeaders) throws ApiException
      List all enrolled SMTP servers Lists all the enrolled custom email SMTP servers
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailServerListResponse
      Throws:
      ApiException - if fails to make API call

    • testEmailServer

      public void testEmailServer(String emailServerId, EmailTestAddresses emailTestAddresses) throws ApiException
      Test an SMTP Server configuration Tests your organization's custom SMTP Server with the given ID
      Parameters:
      emailServerId - (required)
      emailTestAddresses - (optional)
      Throws:
      ApiException - if fails to make API call

    • testEmailServer

      public void testEmailServer(String emailServerId, EmailTestAddresses emailTestAddresses, Map<String,String> additionalHeaders) throws ApiException
      Test an SMTP Server configuration Tests your organization's custom SMTP Server with the given ID
      Parameters:
      emailServerId - (required)
      emailTestAddresses - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • updateEmailServer

      public EmailServerResponse updateEmailServer(String emailServerId, EmailServerRequest emailServerRequest) throws ApiException
      Update an SMTP Server configuration Updates one or more fields of your organization's custom SMTP Server configuration
      Parameters:
      emailServerId - (required)
      emailServerRequest - (optional)
      Returns:
      EmailServerResponse
      Throws:
      ApiException - if fails to make API call

    • updateEmailServer

      public EmailServerResponse updateEmailServer(String emailServerId, EmailServerRequest emailServerRequest, Map<String,String> additionalHeaders) throws ApiException
      Update an SMTP Server configuration Updates one or more fields of your organization's custom SMTP Server configuration
      Parameters:
      emailServerId - (required)
      emailServerRequest - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailServerResponse
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

      protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()