237 строки
15 KiB
YAML
237 строки
15 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.dashboard.models.Smtp"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp"
|
|
name: "Smtp"
|
|
nameWithType: "Smtp"
|
|
summary: "Email server settings."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **Smtp**"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.Smtp()"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.Smtp()"
|
|
name: "Smtp()"
|
|
nameWithType: "Smtp.Smtp()"
|
|
summary: "Creates an instance of Smtp class."
|
|
syntax: "public Smtp()"
|
|
desc: "Creates an instance of Smtp class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.enabled()"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.enabled()"
|
|
name: "enabled()"
|
|
nameWithType: "Smtp.enabled()"
|
|
summary: "Get the enabled property: Enable this to allow Grafana to send email."
|
|
syntax: "public Boolean enabled()"
|
|
desc: "Get the enabled property: Enable this to allow Grafana to send email. Default is false."
|
|
returns:
|
|
description: "the enabled value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.fromAddress()"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.fromAddress()"
|
|
name: "fromAddress()"
|
|
nameWithType: "Smtp.fromAddress()"
|
|
summary: "Get the from<wbr>Address property: Address used when sending out emails https://pkg.<wbr>go.<wbr>dev/net/mail\\#Address."
|
|
syntax: "public String fromAddress()"
|
|
desc: "Get the fromAddress property: Address used when sending out emails https://pkg.go.dev/net/mail\\#Address."
|
|
returns:
|
|
description: "the fromAddress value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.fromName()"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.fromName()"
|
|
name: "fromName()"
|
|
nameWithType: "Smtp.fromName()"
|
|
summary: "Get the from<wbr>Name property: Name to be used when sending out emails."
|
|
syntax: "public String fromName()"
|
|
desc: "Get the fromName property: Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\" https://pkg.go.dev/net/mail\\#Address."
|
|
returns:
|
|
description: "the fromName value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.host()"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.host()"
|
|
name: "host()"
|
|
nameWithType: "Smtp.host()"
|
|
summary: "Get the host property: SMTP server hostname with port, e.<wbr>g."
|
|
syntax: "public String host()"
|
|
desc: "Get the host property: SMTP server hostname with port, e.g. test.email.net:587."
|
|
returns:
|
|
description: "the host value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.password()"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.password()"
|
|
name: "password()"
|
|
nameWithType: "Smtp.password()"
|
|
summary: "Get the password property: Password of SMTP auth."
|
|
syntax: "public String password()"
|
|
desc: "Get the password property: Password of SMTP auth. If the password contains \\# or ;, then you have to wrap it with triple quotes."
|
|
returns:
|
|
description: "the password value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.skipVerify()"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.skipVerify()"
|
|
name: "skipVerify()"
|
|
nameWithType: "Smtp.skipVerify()"
|
|
summary: "Get the skip<wbr>Verify property: Verify SSL for SMTP server."
|
|
syntax: "public Boolean skipVerify()"
|
|
desc: "Get the skipVerify property: Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls\\#Config."
|
|
returns:
|
|
description: "the skipVerify value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.startTlsPolicy()"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.startTlsPolicy()"
|
|
name: "startTlsPolicy()"
|
|
nameWithType: "Smtp.startTlsPolicy()"
|
|
summary: "Get the start<wbr>Tls<wbr>Policy property: The Start<wbr>TLSPolicy setting of the SMTP configuration https://pkg.<wbr>go.<wbr>dev/github.<wbr>com/go-mail/mail\\#Start<wbr>TLSPolicy."
|
|
syntax: "public StartTlsPolicy startTlsPolicy()"
|
|
desc: "Get the startTlsPolicy property: The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail\\#StartTLSPolicy."
|
|
returns:
|
|
description: "the startTlsPolicy value."
|
|
type: "<xref href=\"com.azure.resourcemanager.dashboard.models.StartTlsPolicy?alt=com.azure.resourcemanager.dashboard.models.StartTlsPolicy&text=StartTlsPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.user()"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.user()"
|
|
name: "user()"
|
|
nameWithType: "Smtp.user()"
|
|
summary: "Get the user property: User of SMTP auth."
|
|
syntax: "public String user()"
|
|
desc: "Get the user property: User of SMTP auth."
|
|
returns:
|
|
description: "the user value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.validate()"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.validate()"
|
|
name: "validate()"
|
|
nameWithType: "Smtp.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.withEnabled(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.withEnabled(Boolean enabled)"
|
|
name: "withEnabled(Boolean enabled)"
|
|
nameWithType: "Smtp.withEnabled(Boolean enabled)"
|
|
summary: "Set the enabled property: Enable this to allow Grafana to send email."
|
|
parameters:
|
|
- description: "the enabled value to set."
|
|
name: "enabled"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public Smtp withEnabled(Boolean enabled)"
|
|
desc: "Set the enabled property: Enable this to allow Grafana to send email. Default is false."
|
|
returns:
|
|
description: "the Smtp object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dashboard.models.Smtp?alt=com.azure.resourcemanager.dashboard.models.Smtp&text=Smtp\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.withFromAddress(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.withFromAddress(String fromAddress)"
|
|
name: "withFromAddress(String fromAddress)"
|
|
nameWithType: "Smtp.withFromAddress(String fromAddress)"
|
|
summary: "Set the from<wbr>Address property: Address used when sending out emails https://pkg.<wbr>go.<wbr>dev/net/mail\\#Address."
|
|
parameters:
|
|
- description: "the fromAddress value to set."
|
|
name: "fromAddress"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Smtp withFromAddress(String fromAddress)"
|
|
desc: "Set the fromAddress property: Address used when sending out emails https://pkg.go.dev/net/mail\\#Address."
|
|
returns:
|
|
description: "the Smtp object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dashboard.models.Smtp?alt=com.azure.resourcemanager.dashboard.models.Smtp&text=Smtp\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.withFromName(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.withFromName(String fromName)"
|
|
name: "withFromName(String fromName)"
|
|
nameWithType: "Smtp.withFromName(String fromName)"
|
|
summary: "Set the from<wbr>Name property: Name to be used when sending out emails."
|
|
parameters:
|
|
- description: "the fromName value to set."
|
|
name: "fromName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Smtp withFromName(String fromName)"
|
|
desc: "Set the fromName property: Name to be used when sending out emails. Default is \"Azure Managed Grafana Notification\" https://pkg.go.dev/net/mail\\#Address."
|
|
returns:
|
|
description: "the Smtp object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dashboard.models.Smtp?alt=com.azure.resourcemanager.dashboard.models.Smtp&text=Smtp\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.withHost(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.withHost(String host)"
|
|
name: "withHost(String host)"
|
|
nameWithType: "Smtp.withHost(String host)"
|
|
summary: "Set the host property: SMTP server hostname with port, e.<wbr>g."
|
|
parameters:
|
|
- description: "the host value to set."
|
|
name: "host"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Smtp withHost(String host)"
|
|
desc: "Set the host property: SMTP server hostname with port, e.g. test.email.net:587."
|
|
returns:
|
|
description: "the Smtp object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dashboard.models.Smtp?alt=com.azure.resourcemanager.dashboard.models.Smtp&text=Smtp\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.withPassword(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.withPassword(String password)"
|
|
name: "withPassword(String password)"
|
|
nameWithType: "Smtp.withPassword(String password)"
|
|
summary: "Set the password property: Password of SMTP auth."
|
|
parameters:
|
|
- description: "the password value to set."
|
|
name: "password"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Smtp withPassword(String password)"
|
|
desc: "Set the password property: Password of SMTP auth. If the password contains \\# or ;, then you have to wrap it with triple quotes."
|
|
returns:
|
|
description: "the Smtp object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dashboard.models.Smtp?alt=com.azure.resourcemanager.dashboard.models.Smtp&text=Smtp\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.withSkipVerify(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.withSkipVerify(Boolean skipVerify)"
|
|
name: "withSkipVerify(Boolean skipVerify)"
|
|
nameWithType: "Smtp.withSkipVerify(Boolean skipVerify)"
|
|
summary: "Set the skip<wbr>Verify property: Verify SSL for SMTP server."
|
|
parameters:
|
|
- description: "the skipVerify value to set."
|
|
name: "skipVerify"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public Smtp withSkipVerify(Boolean skipVerify)"
|
|
desc: "Set the skipVerify property: Verify SSL for SMTP server. Default is false https://pkg.go.dev/crypto/tls\\#Config."
|
|
returns:
|
|
description: "the Smtp object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dashboard.models.Smtp?alt=com.azure.resourcemanager.dashboard.models.Smtp&text=Smtp\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.withStartTlsPolicy(com.azure.resourcemanager.dashboard.models.StartTlsPolicy)"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.withStartTlsPolicy(StartTlsPolicy startTlsPolicy)"
|
|
name: "withStartTlsPolicy(StartTlsPolicy startTlsPolicy)"
|
|
nameWithType: "Smtp.withStartTlsPolicy(StartTlsPolicy startTlsPolicy)"
|
|
summary: "Set the start<wbr>Tls<wbr>Policy property: The Start<wbr>TLSPolicy setting of the SMTP configuration https://pkg.<wbr>go.<wbr>dev/github.<wbr>com/go-mail/mail\\#Start<wbr>TLSPolicy."
|
|
parameters:
|
|
- description: "the startTlsPolicy value to set."
|
|
name: "startTlsPolicy"
|
|
type: "<xref href=\"com.azure.resourcemanager.dashboard.models.StartTlsPolicy?alt=com.azure.resourcemanager.dashboard.models.StartTlsPolicy&text=StartTlsPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Smtp withStartTlsPolicy(StartTlsPolicy startTlsPolicy)"
|
|
desc: "Set the startTlsPolicy property: The StartTLSPolicy setting of the SMTP configuration https://pkg.go.dev/github.com/go-mail/mail\\#StartTLSPolicy."
|
|
returns:
|
|
description: "the Smtp object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dashboard.models.Smtp?alt=com.azure.resourcemanager.dashboard.models.Smtp&text=Smtp\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.dashboard.models.Smtp.withUser(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.dashboard.models.Smtp.withUser(String user)"
|
|
name: "withUser(String user)"
|
|
nameWithType: "Smtp.withUser(String user)"
|
|
summary: "Set the user property: User of SMTP auth."
|
|
parameters:
|
|
- description: "the user value to set."
|
|
name: "user"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Smtp withUser(String user)"
|
|
desc: "Set the user property: User of SMTP auth."
|
|
returns:
|
|
description: "the Smtp object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.dashboard.models.Smtp?alt=com.azure.resourcemanager.dashboard.models.Smtp&text=Smtp\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Email server settings. https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/\\#smtp."
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.dashboard.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-dashboard:1.0.0
|