Skip to content

Commit 7f21157

Browse files
authored
Technical/Fix docs typos (#40)
1 parent 92425e2 commit 7f21157

File tree

3 files changed

+7
-13
lines changed

3 files changed

+7
-13
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# ![Golang SMTP mock. Mimic SMTP server behaviour for your test environment and even more](https://repository-images.githubusercontent.com/401721985/848bc1dd-fc35-4d78-8bd9-0ac3430270d8)
22

3-
[![CircleCI](https://circleci.com/gh/mocktools/golang-smtp-mock/tree/master.svg?style=svg)](https://circleci.com/gh/mocktools/golang-smtp-mock/tree/master)
4-
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/mocktools/golang-smtp-mock)](https://github.com/mocktools/golang-smtp-mock/releases)
3+
[![CircleCI](https://circleci.com/gh/mocktools/go-smtp-mock/tree/master.svg?style=svg)](https://circleci.com/gh/mocktools/go-smtp-mock/tree/master)
4+
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/mocktools/go-smtp-mock)](https://github.com/mocktools/go-smtp-mock/releases)
55
[![Go Report Card](https://goreportcard.com/badge/github.com/mocktools/go-smtp-mock)](https://goreportcard.com/report/github.com/mocktools/go-smtp-mock)
66
[![PkgGoDev](https://pkg.go.dev/badge/github.com/mocktools/go-smtp-mock)](https://pkg.go.dev/github.com/mocktools/go-smtp-mock)
7-
[![GitHub](https://img.shields.io/github/license/mocktools/golang-smtp-mock)](LICENSE.txt)
7+
[![GitHub](https://img.shields.io/github/license/mocktools/go-smtp-mock)](LICENSE.txt)
88
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
99

1010
Golang SMTP mock. Mimic SMTP server behaviour for your test environment and even more. It's lightweight configurable multithreaded SMTP server package written in Go. It meets the minimum requirements specified by [RFC 2821](https://datatracker.ietf.org/doc/html/rfc2821) & [RFC 5321](https://datatracker.ietf.org/doc/html/rfc5321).
@@ -187,7 +187,7 @@ smtpmock.ConfigurationAttr{
187187

188188
### Starting-stopping server
189189

190-
To iterate with your SMTP mock server you have to create it using `smtpmock.New()` and `smtpmock.ConfigurationAttr` first. Example of usage:
190+
You have to create your SMTP mock server using `smtpmock.New()` and `smtpmock.ConfigurationAttr` to iterate with it first. Example of usage:
191191

192192
```go
193193
package main
@@ -260,7 +260,7 @@ This golang package is available as open source under the terms of the [MIT Lice
260260

261261
## Code of Conduct
262262

263-
Everyone interacting in the SmtpMock project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
263+
Everyone interacting in the `smtpmock` project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
264264

265265
## Credits
266266

@@ -269,4 +269,4 @@ Everyone interacting in the SmtpMock project’s codebases, issue trackers, chat
269269

270270
## Versioning
271271

272-
SmtpMock uses [Semantic Versioning 2.0.0](https://semver.org)
272+
`smtpmock` uses [Semantic Versioning 2.0.0](https://semver.org)

consts.go

-6
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ import "log"
44

55
const (
66
// SMTP mock default messages
7-
87
DefaultGreetingMsg = "220 Welcome"
98
DefaultQuitMsg = "221 Closing connection"
109
DefaultReceivedMsg = "250 Received"
@@ -21,22 +20,19 @@ const (
2120
DefaultMsgSizeIsTooBigMsg = "552 Message exceeded max size of"
2221

2322
// Logger
24-
2523
InfoLogLevel = "INFO"
2624
WarningLogLevel = "WARNING"
2725
ErrorLogLevel = "ERROR"
2826
LogFlag = log.Ldate | log.Lmicroseconds
2927

3028
// Session
31-
3229
SessionStartMsg = "SMTP session started"
3330
SessionRequestMsg = "SMTP request: "
3431
SessionResponseMsg = "SMTP response: "
3532
SessionEndMsg = "SMTP session finished"
3633
SessionBinaryDataMsg = "message binary data portion"
3734

3835
// Server
39-
4036
NetworkProtocol = "tcp"
4137
DefaultHostAddress = "0.0.0.0"
4238
DefaultPortNuber = 2525
@@ -50,7 +46,6 @@ const (
5046
ServerStopMsg = "SMTP mock server was stopped successfully"
5147

5248
// Regex patterns
53-
5449
AvailableCmdsRegexPattern = `(?i)helo|ehlo|mail from:|rcpt to:|data|quit`
5550
DomainRegexPattern = `(?i)([\p{L}0-9]+([\-.]{1}[\p{L}0-9]+)*\.\p{L}{2,63})`
5651
EmailRegexPattern = `(?i)<?((.+)@` + DomainRegexPattern + `)>?`
@@ -64,6 +59,5 @@ const (
6459
ValidRcpttoComplexCmdRegexPattern = `\A(` + ValidRcpttoCmdRegexPattern + `) ?(` + EmailRegexPattern + `)\z`
6560

6661
// Helpers
67-
6862
EmptyString = ""
6963
)

test_helpers_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ func createNotEmptyMessage() *message {
3939
}
4040
}
4141

42-
// Runs minimal successfull SMTP session with target host
42+
// Runs minimal successful SMTP session with target host
4343
func runMinimalSuccessfulSmtpSession(hostAddress string, portNumber int) error {
4444
connection, _ := net.DialTimeout(NetworkProtocol, serverWithPortNumber(hostAddress, portNumber), time.Duration(2)*time.Second)
4545
client, _ := smtp.NewClient(connection, hostAddress)

0 commit comments

Comments
 (0)