Class DomainEmailSettingsClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class DomainEmailSettingsClient

Inheritance

object

DomainEmailSettingsClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DomainEmailSettingsClient(string, HttpClient)

public DomainEmailSettingsClient(string baseUrl, HttpClient httpClient)

Parameters

baseUrl string

httpClient HttpClient

Properties

BaseUrl

public string BaseUrl { get; set; }

Property Value

string

JsonSerializerSettings

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

JsonSerializerSettings

ReadResponseAsString

public bool ReadResponseAsString { get; set; }

Property Value

bool

Methods

GetAsync(CancellationToken)

Gets the domain email settings.

public virtual Task<EmailSettingsResponseModel> GetAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<EmailSettingsResponseModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PutAsync(EmailSettingsRequestModel, CancellationToken)

Update the domain email settings.

public virtual Task<EmailSettingsResponseModel> PutAsync(EmailSettingsRequestModel emailSettings, CancellationToken cancellationToken = default)

Parameters

emailSettings EmailSettingsRequestModel

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<EmailSettingsResponseModel>

Success

Exceptions

NfieldSdkException

A server side error occurred.

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

protected virtual Task<DomainEmailSettingsClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

response HttpResponseMessage

headers IReadOnlyDictionary<string, IEnumerable<string>>

cancellationToken CancellationToken

Returns

Task<DomainEmailSettingsClient.ObjectResponseResult<T>>

Type Parameters

T