package
2.85.0+incompatible
Repository: https://github.com/transcom/mymove.git
Documentation: pkg.go.dev
# Functions
No description provided by the author
GetSysAdminEmail returns the System Administrators' email address that has been set in the NotificationSender.
InitEmail initializes the email backend.
InitReceiver initializes the receiver backend, only call this once.
NewClientCertCreated returns a new ClientCertModified notification for account creation.
NewClientCertRemoved returns a new ClientCertModified notification for account removal.
NewClientCertUpdated returns a new ClientCertModified notification for cert modification.
NewMoveApproved returns a new move approval notification.
NewMoveCanceled returns a new move approval notification.
NewMoveCounseled returns a new move counseled notification (before TOO approval).
NewMoveIssuedToPrime returns a new move submitted notification.
NewMoveSubmitted returns a new move submitted notification.
NewNotificationReceiver returns a new NotificationReceiverContext.
NewNotificationSender returns a new NotificationSendingContext.
NewOfficeAccountRejected returns a new office user rejected notification.
NewPaymentReminder returns a new payment reminder notification 14 days after actual move in date.
NewPpmPacketEmail returns a new payment reminder notification 14 days after actual move in date.
NewPrimeCounselingComplete returns a new payment reminder notification 14 days after actual move in date.
NewReweighRequested returns a new move submitted notification.
NewStubNotificationReceiver returns a new StubNotificationReceiver.
NewStubNotificationSender returns a new StubNotificationSender.
NewUserAccountActivated returns a new UserAccountModified notification for account activation.
NewUserAccountCreated returns a new UserAccountModified notification for account creation.
NewUserAccountDeactivated returns a new UserAccountModified notification for account deactivation.
NewUserAccountRemoved returns a new UserAccountModified notification for account removal.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
ClientCertModified has notification content for alerting admins when a user account has been modified.
Used to get logging data from GetEmailData.
MoveApproved has notification content for approved moves.
MoveCanceled has notification content for approved moves.
MoveCounseled has notification content for counseled moves (before TOO approval).
No description provided by the author
MoveIssuedToPrime has notification content for submitted moves.
MoveSubmitted has notification content for submitted moves.
NotificationQueueParams stores the params for queue creation.
NotificationReceiverConext provides context to a notification Receiver.
NotificationSendingContext provides context to a notification sender.
OfficeAccountRejected has notification content for rejected office users.
PaymentReminder has notification content for approved moves.
PaymentReminderEmailData is used to render an email template.
PaymentReminderEmailInfo contains payment reminder data for rendering a template.
PpmPacketEmail has notification content for approved moves.
ppmPacketEmailData is used to render an email template Uses ZIPs only if no city/state data is provided.
PrimeCounselingComplete has notification content for moves that have had their counseling completed by the Prime.
PrimeCounselingCompleteData is used to render an email template.
ReceivedMessage standardizes the format of the received message.
ReweighRequested has notification content for submitted moves.
UserAccountModified has notification content for alerting admins when a user account has been modified.
# Interfaces
Notification is an interface for creating emails.
NotificationReceiver is an interface for receiving notifications.
NotificationSender is an interface for sending notifications
go:generate mockery --name NotificationSender.
No description provided by the author
go:generate mockery --name SnsClient --output ./receiverMocks.
go:generate mockery --name SqsClient --output ./receiverMocks.
go:generate mockery --name ViperType --output ./receiverMocks.
# Type aliases
PaymentReminderEmailInfos is a slice of PaymentReminderEmailInfo.
QueuePrefixType represents a prefix identifier given to a name of dynamic notification queues.
StubNotificationReceiver mocks an SNS & SQS client for local usage.
StubNotificationSender mocks an SES client for local usage.