Show / Hide Table of Contents

Class Smtp

Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp

Inheritance
System.Object
Smtp
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.Grafana.dll
Syntax
public class Smtp : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Grafana.Models.Smtp>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Grafana.Models.Smtp>

Constructors

Smtp()

Initializes a new instance of Smtp.

Declaration
public Smtp ();

Properties

Enabled

Enable this to allow Grafana to send email. Default is false.

Declaration
public Nullable<bool> Enabled { get; set; }
Property Value
System.Nullable<System.Boolean>

FromAddress

Address used when sending out emails https://pkg.go.dev/net/mail#Address

Declaration
public string FromAddress { get; set; }
Property Value
System.String

FromName

Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" https://pkg.go.dev/net/mail#Address

Declaration
public string FromName { get; set; }
Property Value
System.String

Host

SMTP server hostname with port, e.g. test.email.net:587.

Declaration
public string Host { get; set; }
Property Value
System.String

Password

Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes.

Declaration
public string Password { get; set; }
Property Value
System.String

SkipVerify

Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls#Config

Declaration
public Nullable<bool> SkipVerify { get; set; }
Property Value
System.Nullable<System.Boolean>

StartTLSPolicy

The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy

Declaration
public Nullable<Azure.ResourceManager.Grafana.Models.StartTLSPolicy> StartTLSPolicy { get; set; }
Property Value
System.Nullable<StartTLSPolicy>

User

User of SMTP auth.

Declaration
public string User { get; set; }
Property Value
System.String

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration
protected virtual void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The JSON writer.

System.ClientModel.Primitives.ModelReaderWriterOptions options

The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<Smtp>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration
Azure.ResourceManager.Grafana.Models.Smtp IJsonModel<Smtp>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonReader reader

The System.Text.Json.Utf8JsonReader to read.

System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns
Smtp

A T representation of the JSON value.

Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<Smtp>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration
void IJsonModel<Smtp>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The System.Text.Json.Utf8JsonWriter to write into.

System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<Smtp>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.Grafana.Models.Smtp IPersistableModel<Smtp>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.BinaryData data

The System.BinaryData to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns
Smtp

A T representation of the data.

Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<Smtp>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration
string IPersistableModel<Smtp>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.

Returns
System.String

The format that the model uses when communicating with the serivce.

IPersistableModel<Smtp>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<Smtp>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns
System.BinaryData

A binary representation of the written model.

Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

Back to top Azure SDK for .NET