org.openapitools.client.api

Class EmailServerApi

java.lang.Object

org.openapitools.client.api.EmailServerApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T17:07:26.321-05:00[America/Chicago]")
public class EmailServerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EmailServerApi()
EmailServerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
EmailServerResponse	createEmailServer(EmailServerPost emailServerPost) Create a custom SMTP server Creates a custom email SMTP server configuration for your organization
EmailServerResponse	createEmailServer(EmailServerPost emailServerPost, Map<String,String> additionalHeaders) Create a custom SMTP server Creates a custom email SMTP server configuration for your organization
void	deleteEmailServer(String emailServerId) Delete an SMTP Server configuration Deletes your organization's custom SMTP server with the given ID
void	deleteEmailServer(String emailServerId, Map<String,String> additionalHeaders) Delete an SMTP Server configuration Deletes your organization's custom SMTP server with the given ID
ApiClient	getApiClient()
EmailServerListResponse	getEmailServer(String emailServerId) Retrieve an SMTP Server configuration Retrieves a configuration of your organization's custom SMTP server with the given ID
EmailServerListResponse	getEmailServer(String emailServerId, Map<String,String> additionalHeaders) Retrieve an SMTP Server configuration Retrieves a configuration of your organization's custom SMTP server with the given ID
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
EmailServerListResponse	listEmailServers() List all enrolled SMTP servers Lists all the enrolled custom email SMTP servers
EmailServerListResponse	listEmailServers(Map<String,String> additionalHeaders) List all enrolled SMTP servers Lists all the enrolled custom email SMTP servers
void	setApiClient(ApiClient apiClient)
void	testEmailServer(String emailServerId, EmailTestAddresses emailTestAddresses) Test an SMTP Server configuration Tests your organization's custom SMTP Server with the given ID
void	testEmailServer(String emailServerId, EmailTestAddresses emailTestAddresses, Map<String,String> additionalHeaders) Test an SMTP Server configuration Tests your organization's custom SMTP Server with the given ID
EmailServerResponse	updateEmailServer(String emailServerId, EmailServerRequest emailServerRequest) Update an SMTP Server configuration Updates one or more fields of your organization's custom SMTP Server configuration
EmailServerResponse	updateEmailServer(String emailServerId, EmailServerRequest emailServerRequest, Map<String,String> additionalHeaders) Update an SMTP Server configuration Updates one or more fields of your organization's custom SMTP Server configuration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmailServerApi

public EmailServerApi()

EmailServerApi

public EmailServerApi(ApiClient apiClient)

Method Detail

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()