Documentation
¶
Index ¶
- Variables
- type Mail
- func (*Mail) Descriptor() ([]byte, []int)deprecated
- func (x *Mail) GetFrom() string
- func (x *Mail) GetMailerConfig() isMail_MailerConfig
- func (x *Mail) GetMaxRetries() int32
- func (x *Mail) GetNickname() string
- func (x *Mail) GetRetryInterval() int64
- func (x *Mail) GetSmtpConfig() *SmtpConfig
- func (*Mail) ProtoMessage()
- func (x *Mail) ProtoReflect() protoreflect.Message
- func (x *Mail) Reset()
- func (x *Mail) String() string
- func (m *Mail) Validate() error
- func (m *Mail) ValidateAll() error
- type MailMultiError
- type MailValidationError
- type Mail_SmtpConfig
- type SmtpConfig
- func (*SmtpConfig) Descriptor() ([]byte, []int)deprecated
- func (x *SmtpConfig) GetHost() string
- func (x *SmtpConfig) GetPassword() string
- func (x *SmtpConfig) GetPort() int32
- func (x *SmtpConfig) GetSsl() bool
- func (x *SmtpConfig) GetTokenSecret() string
- func (x *SmtpConfig) GetUsername() string
- func (*SmtpConfig) ProtoMessage()
- func (x *SmtpConfig) ProtoReflect() protoreflect.Message
- func (x *SmtpConfig) Reset()
- func (x *SmtpConfig) String() string
- func (m *SmtpConfig) Validate() error
- func (m *SmtpConfig) ValidateAll() error
- type SmtpConfigMultiError
- type SmtpConfigValidationError
Constants ¶
This section is empty.
Variables ¶
var File_runtime_mail_v1_mail_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Mail ¶
type Mail struct {
// Common mailer settings
Nickname string `protobuf:"bytes,1,opt,name=nickname,proto3" json:"nickname,omitempty"`
From string `protobuf:"bytes,2,opt,name=from,proto3" json:"from,omitempty"`
MaxRetries int32 `protobuf:"varint,3,opt,name=max_retries,proto3" json:"max_retries,omitempty"`
RetryInterval int64 `protobuf:"varint,4,opt,name=retry_interval,proto3" json:"retry_interval,omitempty"`
// Mailer-specific configuration. Only one of these can be set.
//
// Types that are valid to be assigned to MailerConfig:
//
// *Mail_SmtpConfig
MailerConfig isMail_MailerConfig `protobuf_oneof:"mailer_config"`
// contains filtered or unexported fields
}
Mail represents the general configuration for a mail service.
func (*Mail) Descriptor
deprecated
func (*Mail) GetMailerConfig ¶
func (x *Mail) GetMailerConfig() isMail_MailerConfig
func (*Mail) GetMaxRetries ¶
func (*Mail) GetNickname ¶
func (*Mail) GetRetryInterval ¶
func (*Mail) GetSmtpConfig ¶
func (x *Mail) GetSmtpConfig() *SmtpConfig
func (*Mail) ProtoMessage ¶
func (*Mail) ProtoMessage()
func (*Mail) ProtoReflect ¶
func (x *Mail) ProtoReflect() protoreflect.Message
func (*Mail) Validate ¶
Validate checks the field values on Mail with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*Mail) ValidateAll ¶
ValidateAll checks the field values on Mail with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in MailMultiError, or nil if none found.
type MailMultiError ¶
type MailMultiError []error
MailMultiError is an error wrapping multiple validation errors returned by Mail.ValidateAll() if the designated constraints aren't met.
func (MailMultiError) AllErrors ¶
func (m MailMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (MailMultiError) Error ¶
func (m MailMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type MailValidationError ¶
type MailValidationError struct {
// contains filtered or unexported fields
}
MailValidationError is the validation error returned by Mail.Validate if the designated constraints aren't met.
func (MailValidationError) Cause ¶
func (e MailValidationError) Cause() error
Cause function returns cause value.
func (MailValidationError) Error ¶
func (e MailValidationError) Error() string
Error satisfies the builtin error interface
func (MailValidationError) ErrorName ¶
func (e MailValidationError) ErrorName() string
ErrorName returns error name.
func (MailValidationError) Field ¶
func (e MailValidationError) Field() string
Field function returns field value.
func (MailValidationError) Key ¶
func (e MailValidationError) Key() bool
Key function returns key value.
func (MailValidationError) Reason ¶
func (e MailValidationError) Reason() string
Reason function returns reason value.
type Mail_SmtpConfig ¶
type Mail_SmtpConfig struct {
SmtpConfig *SmtpConfig `protobuf:"bytes,10,opt,name=smtp_config,json=smtpConfig,proto3,oneof"`
}
type SmtpConfig ¶
type SmtpConfig struct {
Host string `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"`
Port int32 `protobuf:"varint,2,opt,name=port,proto3" json:"port,omitempty"`
Username string `protobuf:"bytes,3,opt,name=username,proto3" json:"username,omitempty"`
Password string `protobuf:"bytes,4,opt,name=password,proto3" json:"password,omitempty"`
TokenSecret string `protobuf:"bytes,5,opt,name=token_secret,proto3" json:"token_secret,omitempty"` // Specific to some SMTP setups or OAuth
Ssl bool `protobuf:"varint,6,opt,name=ssl,proto3" json:"ssl,omitempty"`
// contains filtered or unexported fields
}
SmtpConfig represents the configuration for an SMTP mailer.
func (*SmtpConfig) Descriptor
deprecated
func (*SmtpConfig) Descriptor() ([]byte, []int)
Deprecated: Use SmtpConfig.ProtoReflect.Descriptor instead.
func (*SmtpConfig) GetHost ¶
func (x *SmtpConfig) GetHost() string
func (*SmtpConfig) GetPassword ¶
func (x *SmtpConfig) GetPassword() string
func (*SmtpConfig) GetPort ¶
func (x *SmtpConfig) GetPort() int32
func (*SmtpConfig) GetSsl ¶
func (x *SmtpConfig) GetSsl() bool
func (*SmtpConfig) GetTokenSecret ¶
func (x *SmtpConfig) GetTokenSecret() string
func (*SmtpConfig) GetUsername ¶
func (x *SmtpConfig) GetUsername() string
func (*SmtpConfig) ProtoMessage ¶
func (*SmtpConfig) ProtoMessage()
func (*SmtpConfig) ProtoReflect ¶
func (x *SmtpConfig) ProtoReflect() protoreflect.Message
func (*SmtpConfig) Reset ¶
func (x *SmtpConfig) Reset()
func (*SmtpConfig) String ¶
func (x *SmtpConfig) String() string
func (*SmtpConfig) Validate ¶
func (m *SmtpConfig) Validate() error
Validate checks the field values on SmtpConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*SmtpConfig) ValidateAll ¶
func (m *SmtpConfig) ValidateAll() error
ValidateAll checks the field values on SmtpConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in SmtpConfigMultiError, or nil if none found.
type SmtpConfigMultiError ¶
type SmtpConfigMultiError []error
SmtpConfigMultiError is an error wrapping multiple validation errors returned by SmtpConfig.ValidateAll() if the designated constraints aren't met.
func (SmtpConfigMultiError) AllErrors ¶
func (m SmtpConfigMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (SmtpConfigMultiError) Error ¶
func (m SmtpConfigMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type SmtpConfigValidationError ¶
type SmtpConfigValidationError struct {
// contains filtered or unexported fields
}
SmtpConfigValidationError is the validation error returned by SmtpConfig.Validate if the designated constraints aren't met.
func (SmtpConfigValidationError) Cause ¶
func (e SmtpConfigValidationError) Cause() error
Cause function returns cause value.
func (SmtpConfigValidationError) Error ¶
func (e SmtpConfigValidationError) Error() string
Error satisfies the builtin error interface
func (SmtpConfigValidationError) ErrorName ¶
func (e SmtpConfigValidationError) ErrorName() string
ErrorName returns error name.
func (SmtpConfigValidationError) Field ¶
func (e SmtpConfigValidationError) Field() string
Field function returns field value.
func (SmtpConfigValidationError) Key ¶
func (e SmtpConfigValidationError) Key() bool
Key function returns key value.
func (SmtpConfigValidationError) Reason ¶
func (e SmtpConfigValidationError) Reason() string
Reason function returns reason value.