wneessen/go-mail
1
1
Fork 0
mirror of https://github.com/wneessen/go-mail.git synced 2024-11-23 06:10:48 +01:00
Code Issues Projects Releases Packages Wiki Activity

Refine WriteToTempFile docstring

Browse source 
Clarify the documentation for WriteToTempFile to better explain its functionality, ensure consistency, and detail its return values.
This commit is contained in:
Winni Neessen 2024-10-06 16:21:37 +02:00
parent 3333c784a6
commit 0b105048e6
Signed by: wneessen
GPG key ID: 385AC9889632126E
2 changed files with 16 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
msg_totmpfile.go
View file

@ -12,8 +12,14 @@ import (
"os"
)
// WriteToTempFile will create a temporary file and output the Msg to this file
// The method will return the filename of the temporary file
// WriteToTempFile creates a temporary file and writes the Msg content to this file.
//
// This method generates a temporary file with a ".eml" extension, writes the Msg to it, and returns the
// filename of the created temporary file.
//
// Returns:
// - A string representing the filename of the temporary file.
// - An error if the file creation or writing process fails.
func (m *Msg) WriteToTempFile() (string, error) {
f, err := os.CreateTemp("", "go-mail_*.eml")
if err != nil {

10
msg_totmpfile_116.go
View file

@ -12,8 +12,14 @@ import (
"io/ioutil"
)
// WriteToTempFile will create a temporary file and output the Msg to this file
// The method will return the filename of the temporary file
// WriteToTempFile creates a temporary file and writes the Msg content to this file.
//
// This method generates a temporary file with a ".eml" extension, writes the Msg to it, and returns the
// filename of the created temporary file.
//
// Returns:
// - A string representing the filename of the temporary file.
// - An error if the file creation or writing process fails.
func (m *Msg) WriteToTempFile() (string, error) {
f, err := ioutil.TempFile("", "go-mail_*.eml")
if err != nil {