The mail delivery client

In go-mail the Client is responsible for the mail delivery with remote mail servers that communicate via the SMTP protocol.

NewClient()

Signature

1
func NewClient(string, ...Option) (*Client, error)

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
package main

import "github.com/wneessen/go-mail"

func main() {
	c, err := mail.NewClient("mail.example.com")
	if err != nil {
		panic(err)
	}
}

To create a new Client, you can use the NewClient() method. As first argument it requires the hostname of the sending SMTP server. Optionally you can provide a list of Option funcionts. These option functions can be used to override the default settings of the Client.

Check the Options documentation for in-depth details to all available Options.

Client

Signature

1
2
3
type Client struct {
// contains filtered or unexported fields
}

Close()

Signature

1
func (*Client) Close() error

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
package main

import "github.com/wneessen/go-mail"

func main() {
	c, err := mail.NewClient("mail.example.com")
	if err != nil {
		panic(err)
	}
	defer c.Close()
}

Close() closes the connection to the SMTP server the Client is connected to. It returns an error in case the Client has no active connection or if closing the connection fails.

DialAndSend()

Signature

1
func (*Client) DialAndSend(...*Msg) error

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package main

import "github.com/wneessen/go-mail"

func main() {
	from := "Toni Tester <toni@example.com>"
	to := "Alice <alice@example.com>"
	server := "mail.example.com"

	m := mail.NewMsg()
	if err := m.From(from); err != nil {
		panic(err)
	}
	if err := m.To(to); err != nil {
		panic(err)
	}
	m.Subject("This is a great subject")

	c, err := mail.NewClient(server)
	if err != nil {
		panic(err)
	}
	if err := c.DialAndSend(m); err != nil {
		panic(err)
	}
}

The DialAndSend() method is an alias for DialAndSendWithContext() with a default context.Background context. DialAndSend() takes a list of Msg pointer as argument(s) and returns an error in case any of the performed actions fails.

DialAndSendWithContext()

Signature

1
func (*Client) DialAndSendWithContext(context.Context, ...*Msg) error

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
package main

import "github.com/wneessen/go-mail"

func main() {
	from := "Toni Tester <toni@example.com>"
	to := "Alice <alice@example.com>"
	server := "mail.example.com"

	m := mail.NewMsg()
	if err := m.From(from); err != nil {
		panic(err)
	}
	if err := m.To(to); err != nil {
		panic(err)
	}
	m.Subject("This is a great subject")

	c, err := mail.NewClient(server)
	if err != nil {
		panic(err)
	}
	ctx := context.Background()
	if err := c.DialAndSendWithContext(ctx, m); err != nil {
		panic(err)
	}
}

The DialAndSendWithContext() is a one-for-all shortcut method on the Client. Once the Client is created, calling the DialAndSendWithContext() method will have it connect to the configured server, send out the given mail Msg and finalize by closing the connection again.

The first argument of the method is a context.Context followed by a list of one or more Msg pointers. DialAndSendWithContext() does return an error in case any of the performed actions fails.