net/smtp: clearer documentation for SendMail

[gopherbot]

by faraazs:

Hello,

This is my first bug report for golang. I tried searching for this issue, but
could not find any issues relating to this problem. Please excuse me if I missed
one.

The documentation for net/smtp.SendMail can be clearer. Specifically, it is not
clear that the msg parameter is included directly within the header section. I
have attached a patch that includes a bit more documentation on the msg
parameter.

Attachments:

1. smtp.patch (734 bytes)

[gopherbot]

Comment 1 by faraazs:

Another option for this change would be to extend the net/smtp package to have a similar
API to the net/http package. SMTP and HTTP follow a similar text based protocol. I
haven't studied the code too closely, but the two packages may be able to share some
code.

[rsc]

Comment 4:

Labels changed: added go1.3maybe.

[rsc]

Comment 5:

Labels changed: added release-none, removed go1.3maybe.

[rsc]

Comment 6:

Labels changed: added repo-main.

[agnivade]

I believe this can be closed. SendMail documentation now clearly specifies that the msg parameter contains the headers.

  // The msg parameter should be an RFC 822-style email with headers
  // first, a blank line, and then the message body. The lines of msg
  // should be CRLF terminated. The msg headers should usually include
  // fields such as "From", "To", "Subject", and "Cc".  Sending "Bcc"
  // messages is accomplished by including an email address in the to
  // parameter but not including it in the msg headers.

[bradfitz]

@agnivade, thanks!