model

Documentation

Index

• Variables
• func ConvertDeliveryToPublishing(message amqp.Delivery) amqp.Publishing
• func LoggedAck(message amqp.Delivery)
• func LoggedCloser(closer io.Closer)
• func LoggedReject(message amqp.Delivery, requeue bool)
• type AMQPClient
  • func GetAMQPClient(uri, exchangeName, queueName string) (client AMQPClient, err error)
  • func (a AMQPClient) ClientName() string
  • func (a AMQPClient) Close()
  • func (a AMQPClient) Enabled() bool
  • func (a AMQPClient) ExchangeName() string
  • func (a AMQPClient) GetGarbage() (amqp.Delivery, bool, error)
  • func (a AMQPClient) Listen() (<-chan amqp.Delivery, error)
  • func (a AMQPClient) Ping() error
  • func (a AMQPClient) QueueName() string
  • func (a AMQPClient) Send(payload amqp.Publishing) error
  • func (a AMQPClient) Vhost() string
• type Mail
• type MailRequest
  • func NewMailRequest() *MailRequest
  • func (mr *MailRequest) As(sender string) *MailRequest
  • func (mr *MailRequest) Check() error
  • func (mr *MailRequest) ConvertToMail(content io.Reader) Mail
  • func (mr *MailRequest) Data(payload interface{}) *MailRequest
  • func (mr *MailRequest) From(fromEmail string) *MailRequest
  • func (mr *MailRequest) Template(Tpl string) *MailRequest
  • func (mr *MailRequest) To(recipients ...string) *MailRequest
  • func (mr *MailRequest) WithSubject(subject string) *MailRequest
• type Sender

Variables

var (
	// EmptyMailRequest for not found case
	EmptyMailRequest = MailRequest{}
)

Functions

func ConvertDeliveryToPublishing

func ConvertDeliveryToPublishing(message amqp.Delivery) amqp.Publishing

ConvertDeliveryToPublishing convert a delivery to a publishing, for requeuing

func LoggedAck

func LoggedAck(message amqp.Delivery)

LoggedAck ack a message with error handling

func LoggedCloser

func LoggedCloser(closer io.Closer)

LoggedCloser closes a ressources with handling error

func LoggedReject

func LoggedReject(message amqp.Delivery, requeue bool)

LoggedReject reject a message with error handling

Types

type AMQPClient

type AMQPClient struct {
	// contains filtered or unexported fields
}

AMQPClient wraps all object required for AMQP usage

func GetAMQPClient

func GetAMQPClient(uri, exchangeName, queueName string) (client AMQPClient, err error)

GetAMQPClient inits AMQP connection, channel and queue

func (AMQPClient) ClientName

func (a AMQPClient) ClientName() string

ClientName returns client name

func (AMQPClient) Close

func (a AMQPClient) Close()

Close closes opened ressources

func (AMQPClient) Enabled

func (a AMQPClient) Enabled() bool

Enabled checks if connection is setup

func (AMQPClient) ExchangeName

func (a AMQPClient) ExchangeName() string

ExchangeName returns exchange name

func (AMQPClient) GetGarbage

func (a AMQPClient) GetGarbage() (amqp.Delivery, bool, error)

GetGarbage get a message from the garbage

func (AMQPClient) Listen

func (a AMQPClient) Listen() (<-chan amqp.Delivery, error)

Listen listen to queue

func (AMQPClient) Ping

func (a AMQPClient) Ping() error

Ping checks if connection is live

func (AMQPClient) QueueName

func (a AMQPClient) QueueName() string

QueueName returns queue name

func (AMQPClient) Send

func (a AMQPClient) Send(payload amqp.Publishing) error

Send sends payload to the underlying exchange and queue

func (AMQPClient) Vhost

func (a AMQPClient) Vhost() string

Vhost returns connection Vhost

type Mail

type Mail struct {
	From    string
	Sender  string
	Subject string
	Content io.Reader
	To      []string
}

Mail describe envelope of an email

type MailRequest

type MailRequest struct {
	Payload    interface{}
	Tpl        string
	FromEmail  string
	Sender     string
	Subject    string
	Recipients []string
}

MailRequest describes an email to be sent

func NewMailRequest

func NewMailRequest() *MailRequest

NewMailRequest create a new email

func (*MailRequest) As

func (mr *MailRequest) As(sender string) *MailRequest

As set sender

func (*MailRequest) Check

func (mr *MailRequest) Check() error

Check checks if current instance is valid

func (*MailRequest) ConvertToMail

func (mr *MailRequest) ConvertToMail(content io.Reader) Mail

ConvertToMail convert mail request to Mail with given content

func (*MailRequest) Data

func (mr *MailRequest) Data(payload interface{}) *MailRequest

Data set payload

func (*MailRequest) From

func (mr *MailRequest) From(fromEmail string) *MailRequest

From set from

func (*MailRequest) Template

func (mr *MailRequest) Template(Tpl string) *MailRequest

Template set template

func (*MailRequest) To

func (mr *MailRequest) To(recipients ...string) *MailRequest

To add recipients to list

func (*MailRequest) WithSubject

func (mr *MailRequest) WithSubject(subject string) *MailRequest

WithSubject set subject

type Sender

type Sender interface {
	Send(ctx context.Context, mail Mail) error
}

Sender send given email