Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type CreateMailingProviderArgs ¶
type CreateMailingProviderArgs struct {
// UID is the unique identifier of the mailing provider.
UID string
// Name is the name of the mailing provider.
Name string
// FromAddress is the default from address of the mailing provider.
FromAddress *mail.Address
// Type is the type of the mailing provider.
Type mailingpb.MailingProviderType
// Config is the configuration of the mailing provider.
Config mailingpb.MailingProviderConfig
}
CreateMailingProviderArgs creates a new mailing provider.
type MailingProviderStorage ¶
type MailingProviderStorage interface {
CreateProvider(ctx context.Context, in *CreateMailingProviderArgs) (mailprovider.MailingProviderDefinition, error)
UpdateProvider(ctx context.Context, in *UpdateMailingProviderArgs) (UpdateMailingProviderResult, error)
SetCurrentProvider(ctx context.Context, in *SetCurrentMailingProviderArgs) error
MarkProviderVerified(ctx context.Context, in *MarkProviderVerifiedArgs) error
GetCurrentProvider(ctx context.Context) (mailprovider.MailingProviderDefinition, error)
ListProviders(ctx context.Context) ([]mailprovider.MailingProviderDefinition, error)
}
MailingProviderStorage is an interface that represents a mailing provider storage.
type SetCurrentMailingProviderArgs ¶
type SetCurrentMailingProviderArgs struct {
// UID is the unique identifier of the mailing provider.
UID string
}
SetCurrentMailingProviderArgs sets the current mailing provider.
type UpdateMailingProviderArgs ¶
type UpdateMailingProviderArgs struct {
// UID is the unique identifier of the mailing provider.
UID string
// Name is the name of the mailing provider.
Name string
// FromAddress is the default from address of the mailing provider.
FromAddress *mail.Address
// Config is the configuration of the mailing provider.
Config *mailingpb.MailingProviderConfig
}
UpdateMailingProviderArgs updates a mailing provider.
type UpdateMailingProviderResult ¶
type UpdateMailingProviderResult struct {
WasInUse bool
MailingProvider mailprovider.MailingProviderDefinition
}
UpdateMailingProviderResult is the result of the UpdateMailingProvider method.
Click to show internal directories.
Click to hide internal directories.