README
¶
SMTP Endpoint Service
This service allows email message validation. Listen operation starts SMTP endpoint that places all incoming messages to validation queue. Assert operation validates mail messages.
| Service Id | Action | Description | Request | Response |
|---|---|---|---|---|
| smtp/endpoint | listen | start accepting mails | ListenRequest | ListenResponse |
| smtp/endpoint | assert | perform validation on provided expected user message | AssertRequest | AssertResponse |
Usage
endly -r=test.yaml
pipeline:
listen:
action: smtp/endpoint:listen
port: 1465
enableTLS: true
certLocation:
users:
- username: bob
credentials: e2eendly
send:
action: smtp:send
target:
URL: smtp://localhost:1465
credentials: e2eendly
mail:
from: tester@localhost
to:
- bob@localhost
subject: test subject
body: this is test body
assert:
action: smtp/endpoint:assert
expect:
- user: bob
message:
Subject: test subject2
Body: /test body/
Using SSL/TLS
When enabling SSL/TLS for testing you can use the following command to generate self describing cert:
openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout key.pem -out cert.pem
Documentation
¶
Index ¶
Constants ¶
View Source
const ServiceID = "smtp/endpoint"
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AssertRequest ¶
type AssertRequest struct {
DescriptionTemplate string
Expect []*UserMessage `required:"true" description:"expected user messagesByUser"`
}
AssertRequest represents a log assert request
func (*AssertRequest) Init ¶
func (r *AssertRequest) Init() error
type AssertResponse ¶
type AssertResponse struct {
Validations []*assertly.Validation
}
AssertResponse represents a smtp message assert response
func (*AssertResponse) Assertion ¶
func (r *AssertResponse) Assertion() []*assertly.Validation
Assertion returns description with validation slice
type ListenRequest ¶
type ListenRequest struct {
ServerName string
Port int
EnableTLS bool
MaxBodySize int
Users []*User
CertLocation string
Debug bool
}
ListenRequest represents a new listen request
func (*ListenRequest) Init ¶
func (r *ListenRequest) Init() error
func (*ListenRequest) Validate ¶
func (r *ListenRequest) Validate() error
type Message ¶
type Message struct {
From string
To []string
Subject string
Header map[string]string
Raw string
Body string
}
Message represent an email
type Messages ¶
Messages represents a FIFO message collection grouped by user
func NewMessages ¶
func NewMessages() *Messages
NewMessages returns a new FIFO message collection by user
type UserMessage ¶
UserMessage represents desired user message
Source Files
Click to show internal directories.
Click to hide internal directories.