Class EmailConfig

    • Method Detail

      • getAuthIdentity

        public String getAuthIdentity()
        authIdentity defines the identity to use for SMTP authentication. This is typically used with PLAIN authentication mechanism.
      • setAuthIdentity

        public void setAuthIdentity​(String authIdentity)
        authIdentity defines the identity to use for SMTP authentication. This is typically used with PLAIN authentication mechanism.
      • getAuthPassword

        public SecretKeySelector getAuthPassword()
        EmailConfig configures notifications via Email.
      • setAuthPassword

        public void setAuthPassword​(SecretKeySelector authPassword)
        EmailConfig configures notifications via Email.
      • getAuthSecret

        public SecretKeySelector getAuthSecret()
        EmailConfig configures notifications via Email.
      • setAuthSecret

        public void setAuthSecret​(SecretKeySelector authSecret)
        EmailConfig configures notifications via Email.
      • getAuthUsername

        public String getAuthUsername()
        authUsername defines the username to use for SMTP authentication. This is used for SMTP AUTH when the server requires authentication.
      • setAuthUsername

        public void setAuthUsername​(String authUsername)
        authUsername defines the username to use for SMTP authentication. This is used for SMTP AUTH when the server requires authentication.
      • getForceImplicitTLS

        public Boolean getForceImplicitTLS()
        forceImplicitTLS defines whether to force use of implicit TLS (direct TLS connection) for better security. true: force use of implicit TLS (direct TLS connection on any port) false: force disable implicit TLS (use explicit TLS/STARTTLS if required) nil (default): auto-detect based on port (465=implicit, other=explicit) for backward compatibility It requires Alertmanager >= v0.31.0.
      • setForceImplicitTLS

        public void setForceImplicitTLS​(Boolean forceImplicitTLS)
        forceImplicitTLS defines whether to force use of implicit TLS (direct TLS connection) for better security. true: force use of implicit TLS (direct TLS connection on any port) false: force disable implicit TLS (use explicit TLS/STARTTLS if required) nil (default): auto-detect based on port (465=implicit, other=explicit) for backward compatibility It requires Alertmanager >= v0.31.0.
      • getFrom

        public String getFrom()
        from defines the sender address for email notifications. This appears as the "From" field in the email header.
      • setFrom

        public void setFrom​(String from)
        from defines the sender address for email notifications. This appears as the "From" field in the email header.
      • getHeaders

        public List<KeyValue> getHeaders()
        headers defines additional email header key/value pairs. These override any headers previously set by the notification implementation.
      • setHeaders

        public void setHeaders​(List<KeyValue> headers)
        headers defines additional email header key/value pairs. These override any headers previously set by the notification implementation.
      • getHello

        public String getHello()
        hello defines the hostname to identify to the SMTP server. This is used in the SMTP HELO/EHLO command during the connection handshake.
      • setHello

        public void setHello​(String hello)
        hello defines the hostname to identify to the SMTP server. This is used in the SMTP HELO/EHLO command during the connection handshake.
      • getHtml

        public String getHtml()
        html defines the HTML body of the email notification. This allows for rich formatting in the email content.
      • setHtml

        public void setHtml​(String html)
        html defines the HTML body of the email notification. This allows for rich formatting in the email content.
      • getRequireTLS

        public Boolean getRequireTLS()
        requireTLS defines the SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.
      • setRequireTLS

        public void setRequireTLS​(Boolean requireTLS)
        requireTLS defines the SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.
      • getSendResolved

        public Boolean getSendResolved()
        sendResolved defines whether or not to notify about resolved alerts.
      • setSendResolved

        public void setSendResolved​(Boolean sendResolved)
        sendResolved defines whether or not to notify about resolved alerts.
      • getSmarthost

        public String getSmarthost()
        smarthost defines the SMTP host and port through which emails are sent. Format should be "hostname:port", e.g. "smtp.example.com:587".
      • setSmarthost

        public void setSmarthost​(String smarthost)
        smarthost defines the SMTP host and port through which emails are sent. Format should be "hostname:port", e.g. "smtp.example.com:587".
      • getText

        public String getText()
        text defines the plain text body of the email notification. This provides a fallback for email clients that don't support HTML.
      • setText

        public void setText​(String text)
        text defines the plain text body of the email notification. This provides a fallback for email clients that don't support HTML.
      • getThreading

        public EmailThreadingConfig getThreading()
        EmailConfig configures notifications via Email.
      • setThreading

        public void setThreading​(EmailThreadingConfig threading)
        EmailConfig configures notifications via Email.
      • getTlsConfig

        public SafeTLSConfig getTlsConfig()
        EmailConfig configures notifications via Email.
      • setTlsConfig

        public void setTlsConfig​(SafeTLSConfig tlsConfig)
        EmailConfig configures notifications via Email.
      • getTo

        public String getTo()
        to defines the email address to send notifications to. This is the recipient address for alert notifications.
      • setTo

        public void setTo​(String to)
        to defines the email address to send notifications to. This is the recipient address for alert notifications.
      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()
      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                          Object value)
      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)