Type Alias GetEmailConfig

type GetEmailConfig = {
    authFailures?: number;
    emailAddress?: string;
    errorCode?: string;
    isValid?: boolean;
    lastUpdated?: string;
    modificationTime?: string;
    passwordExists?: boolean;
    providerConfig?: GetMicrosoft365Config | GetBasicAuthConfig;
    securityType?: string;
    serverAddress?: string;
    serverPort?: number;
    serviceProvider?: "Microsoft365" | "BasicAuth";
    status?: SmtpConfigStatus;
    tenantId?: string;
    username?: string;
}
Index

Properties

authFailures? emailAddress? errorCode? isValid? lastUpdated? modificationTime? passwordExists? providerConfig? securityType? serverAddress? serverPort? serviceProvider? status? tenantId? username?

Properties

authFailures?: number

Number of authentication failures

emailAddress?: string

used for SMTP authentication

errorCode?: string

Indicates error with this email configuration. OK means that no error is indicated. Possible values are OK, CONFIG_NOT_SET, INCOMPLETE_CONFIG, INVALID_CREDENTIALS, PROVIDER_ERROR

isValid?: boolean

Is the configuration valid

lastUpdated?: string
modificationTime?: string

Last modification time. Formatted as a ISO 8601 string.

passwordExists?: boolean

Indicates if password is defined for this smtp config. The password itself is not returned!

providerConfig?: GetMicrosoft365Config | GetBasicAuthConfig
securityType?: string

one of none, StartTLS or SSL/TLS

serverAddress?: string

domain name or IP address of SMTP server

serverPort?: number

smtp server listening port

serviceProvider?: "Microsoft365" | "BasicAuth"

Name of the service provider for authentication

status?: SmtpConfigStatus

Contains statusCode and statusReason

tenantId?: string

The tenant Id

username?: string

user name

Settings

Member Visibility

On This Page

Properties