email.go (view raw)
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 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 |
package mail import ( "bytes" "crypto/tls" "errors" "fmt" "io/ioutil" "mime" "net" "net/mail" "net/smtp" "net/textproto" "path/filepath" "time" ) // Email represents an email message. type Email struct { from string sender string replyTo string returnPath string recipients []string headers textproto.MIMEHeader parts []part attachments []*file inlines []*file Charset string Encoding encoding Encryption encryption Username string Password string TLSConfig *tls.Config ConnectTimeout int Error error } // part represents the different content parts of an email body. type part struct { contentType string body *bytes.Buffer } // file represents the files that can be added to the email message. type file struct { filename string mimeType string data []byte } type encryption int const ( // EncryptionTLS sets encryption type to TLS when sending email EncryptionTLS encryption = iota // EncryptionSSL sets encryption type to SSL when sending email EncryptionSSL // EncryptionNone uses no encryption when sending email EncryptionNone ) var encryptionTypes = [...]string{"TLS", "SSL", "None"} func (encryption encryption) String() string { return encryptionTypes[encryption] } type encoding int const ( // EncodingQuotedPrintable sets the message body encoding to quoted-printable EncodingQuotedPrintable encoding = iota // EncodingBase64 sets the message body encoding to base64 EncodingBase64 // EncodingNone turns off encoding on the message body EncodingNone ) var encodingTypes = [...]string{"quoted-printable", "base64", "binary"} func (encoding encoding) String() string { return encodingTypes[encoding] } // New creates a new email. It uses UTF-8 by default. func New() *Email { email := &Email{ headers: make(textproto.MIMEHeader), Charset: "UTF-8", Encoding: EncodingQuotedPrintable, Encryption: EncryptionNone, TLSConfig: new(tls.Config), } email.AddHeader("MIME-Version", "1.0") return email } // GetError returns the first email error encountered func (email *Email) GetError() error { return email.Error } // SetFrom sets the From address. func (email *Email) SetFrom(address string) *Email { if email.Error != nil { return email } email.AddAddresses("From", address) return email } // SetSender sets the Sender address. func (email *Email) SetSender(address string) *Email { if email.Error != nil { return email } email.AddAddresses("Sender", address) return email } // SetReplyTo sets the Reply-To address. func (email *Email) SetReplyTo(address string) *Email { if email.Error != nil { return email } email.AddAddresses("Reply-To", address) return email } // SetReturnPath sets the Return-Path address. This is most often used // to send bounced emails to a different email address. func (email *Email) SetReturnPath(address string) *Email { if email.Error != nil { return email } email.AddAddresses("Return-Path", address) return email } // AddTo adds a To address. You can provide multiple // addresses at the same time. func (email *Email) AddTo(addresses ...string) *Email { if email.Error != nil { return email } email.AddAddresses("To", addresses...) return email } // AddCc adds a Cc address. You can provide multiple // addresses at the same time. func (email *Email) AddCc(addresses ...string) *Email { if email.Error != nil { return email } email.AddAddresses("Cc", addresses...) return email } // AddBcc adds a Bcc address. You can provide multiple // addresses at the same time. func (email *Email) AddBcc(addresses ...string) *Email { if email.Error != nil { return email } email.AddAddresses("Bcc", addresses...) return email } // AddAddresses allows you to add addresses to the specified address header. func (email *Email) AddAddresses(header string, addresses ...string) *Email { if email.Error != nil { return email } found := false // check for a valid address header for _, h := range []string{"To", "Cc", "Bcc", "From", "Sender", "Reply-To", "Return-Path"} { if header == h { found = true } } if !found { email.Error = errors.New("Mail Error: Invalid address header; Header: [" + header + "]") return email } // check to see if the addresses are valid for i := range addresses { address, err := mail.ParseAddress(addresses[i]) if err != nil { email.Error = errors.New("Mail Error: " + err.Error() + "; Header: [" + header + "] Address: [" + addresses[i] + "]") return email } // check for more than one address switch { case header == "From" && len(email.from) > 0: fallthrough case header == "Sender" && len(email.sender) > 0: fallthrough case header == "Reply-To" && len(email.replyTo) > 0: fallthrough case header == "Return-Path" && len(email.returnPath) > 0: email.Error = errors.New("Mail Error: There can only be one \"" + header + "\" address; Header: [" + header + "] Address: [" + addresses[i] + "]") return email default: // other address types can have more than one address } // save the address switch header { case "From": email.from = address.Address case "Sender": email.sender = address.Address case "Reply-To": email.replyTo = address.Address case "Return-Path": email.returnPath = address.Address default: // check that the address was added to the recipients list email.recipients, err = addAddress(email.recipients, address.Address) if err != nil { email.Error = errors.New("Mail Error: " + err.Error() + "; Header: [" + header + "] Address: [" + addresses[i] + "]") return email } } // make sure the from and sender addresses are different if email.from != "" && email.sender != "" && email.from == email.sender { email.sender = "" email.headers.Del("Sender") email.Error = errors.New("Mail Error: From and Sender should not be set to the same address.") return email } // add all addresses to the headers except for Bcc and Return-Path if header != "Bcc" && header != "Return-Path" { // add the address to the headers email.headers.Add(header, address.String()) } } return email } // addAddress adds an address to the address list if it hasn't already been added func addAddress(addressList []string, address string) ([]string, error) { // loop through the address list to check for dups for _, a := range addressList { if address == a { return addressList, errors.New("Mail Error: Address: [" + address + "] has already been added") } } return append(addressList, address), nil } type priority int const ( // PriorityHigh sets the email priority to High PriorityHigh priority = iota // PriorityLow sets the email priority to Low PriorityLow ) var priorities = [...]string{"High", "Low"} func (priority priority) String() string { return priorities[priority] } // SetPriority sets the email message priority. Use with // either "High" or "Low". func (email *Email) SetPriority(priority priority) *Email { if email.Error != nil { return email } switch priority { case PriorityHigh: email.AddHeaders(textproto.MIMEHeader{ "X-Priority": {"1 (Highest)"}, "X-MSMail-Priority": {"High"}, "Importance": {"High"}, }) case PriorityLow: email.AddHeaders(textproto.MIMEHeader{ "X-Priority": {"5 (Lowest)"}, "X-MSMail-Priority": {"Low"}, "Importance": {"Low"}, }) default: } return email } // SetDate sets the date header to the provided date/time. // The format of the string should be YYYY-MM-DD HH:MM:SS Time Zone. // // Example: SetDate("2015-04-28 10:32:00 CDT") func (email *Email) SetDate(dateTime string) *Email { if email.Error != nil { return email } const dateFormat = "2006-01-02 15:04:05 MST" // Try to parse the provided date/time dt, err := time.Parse(dateFormat, dateTime) if err != nil { email.Error = errors.New("Mail Error: Setting date failed with: " + err.Error()) return email } email.headers.Set("Date", dt.Format(time.RFC1123Z)) return email } // SetSubject sets the subject of the email message. func (email *Email) SetSubject(subject string) *Email { if email.Error != nil { return email } email.AddHeader("Subject", subject) return email } // SetBody sets the body of the email message. func (email *Email) SetBody(contentType, body string) *Email { if email.Error != nil { return email } email.parts = []part{ part{ contentType: contentType, body: bytes.NewBufferString(body), }, } return email } // AddHeader adds the given "header" with the passed "value". func (email *Email) AddHeader(header string, values ...string) *Email { if email.Error != nil { return email } // check that there is actually a value if len(values) < 1 { email.Error = errors.New("Mail Error: no value provided; Header: [" + header + "]") return email } switch header { case "Sender": fallthrough case "From": fallthrough case "To": fallthrough case "Bcc": fallthrough case "Cc": fallthrough case "Reply-To": fallthrough case "Return-Path": email.AddAddresses(header, values...) case "Date": if len(values) > 1 { email.Error = errors.New("Mail Error: To many dates provided") return email } email.SetDate(values[0]) default: email.headers[header] = values } return email } // AddHeaders is used to add mulitple headers at once func (email *Email) AddHeaders(headers textproto.MIMEHeader) *Email { if email.Error != nil { return email } for header, values := range headers { email.AddHeader(header, values...) } return email } // AddAlternative allows you to add alternative parts to the body // of the email message. This is most commonly used to add an // html version in addition to a plain text version that was // already added with SetBody. func (email *Email) AddAlternative(contentType, body string) *Email { if email.Error != nil { return email } email.parts = append(email.parts, part{ contentType: contentType, body: bytes.NewBufferString(body), }, ) return email } // AddAttachment allows you to add an attachment to the email message. // You can optionally provide a different name for the file. func (email *Email) AddAttachment(file string, name ...string) *Email { if email.Error != nil { return email } if len(name) > 1 { email.Error = errors.New("Mail Error: Attach can only have a file and an optional name") return email } email.Error = email.attach(file, false, name...) return email } // AddInline allows you to add an inline attachment to the email message. // You can optionally provide a different name for the file. func (email *Email) AddInline(file string, name ...string) *Email { if email.Error != nil { return email } if len(name) > 1 { email.Error = errors.New("Mail Error: Inline can only have a file and an optional name") return email } email.Error = email.attach(file, true, name...) return email } // attach does the low level attaching of the files func (email *Email) attach(f string, inline bool, name ...string) error { // Get the file data data, err := ioutil.ReadFile(f) if err != nil { return errors.New("Mail Error: Failed to add file with following error: " + err.Error()) } // get the file mime type mimeType := mime.TypeByExtension(filepath.Ext(f)) if mimeType == "" { mimeType = "application/octet-stream" } // get the filename _, filename := filepath.Split(f) // if an alternative filename was provided, use that instead if len(name) == 1 { filename = name[0] } if inline { email.inlines = append(email.inlines, &file{ filename: filename, mimeType: mimeType, data: data, }) } else { email.attachments = append(email.attachments, &file{ filename: filename, mimeType: mimeType, data: data, }) } return nil } // getFrom returns the sender of the email, if any func (email *Email) getFrom() string { from := email.returnPath if from == "" { from = email.sender if from == "" { from = email.from if from == "" { from = email.replyTo } } } return from } func (email *Email) hasMixedPart() bool { return (len(email.parts) > 0 && len(email.attachments) > 0) || len(email.attachments) > 1 } func (email *Email) hasRelatedPart() bool { return (len(email.parts) > 0 && len(email.inlines) > 0) || len(email.inlines) > 1 } func (email *Email) hasAlternativePart() bool { return len(email.parts) > 1 } // GetMessage builds and returns the email message func (email *Email) GetMessage() string { msg := newMessage(email) if email.hasMixedPart() { msg.openMultipart("mixed") } if email.hasRelatedPart() { msg.openMultipart("related") } if email.hasAlternativePart() { msg.openMultipart("alternative") } for _, part := range email.parts { msg.addBody(part.contentType, part.body.Bytes()) } if email.hasAlternativePart() { msg.closeMultipart() } msg.addFiles(email.inlines, true) if email.hasRelatedPart() { msg.closeMultipart() } msg.addFiles(email.attachments, false) if email.hasMixedPart() { msg.closeMultipart() } return msg.getHeaders() + msg.body.String() } // Send sends the composed email func (email *Email) Send(address string) error { if email.Error != nil { return email.Error } var auth smtp.Auth from := email.getFrom() if from == "" { return errors.New(`Mail Error: No "From" address specified.`) } if len(email.recipients) < 1 { return errors.New("Mail Error: No recipient specified.") } msg := email.GetMessage() host, port, err := net.SplitHostPort(address) if err != nil { return errors.New("Mail Error: " + err.Error()) } if email.Username != "" || email.Password != "" { auth = smtp.PlainAuth("", email.Username, email.Password, host) } return send(host, port, from, email.recipients, msg, auth, email.Encryption, email.TLSConfig, email.ConnectTimeout) } // dial connects to the smtp server with the request encryption type func dial(host string, port string, encryption encryption, config *tls.Config) (*smtp.Client, error) { var conn net.Conn var err error address := host + ":" + port // do the actual dial switch encryption { case EncryptionSSL: conn, err = tls.Dial("tcp", address, config) default: conn, err = net.Dial("tcp", address) } if err != nil { return nil, errors.New("Mail Error on dailing with encryption type " + encryption.String() + ": " + err.Error()) } c, err := smtp.NewClient(conn, host) if err != nil { return nil, errors.New("Mail Error on smtp dial: " + err.Error()) } return c, err } // smtpConnect connects to the smtp server and starts TLS and passes auth // if necessary func smtpConnect(host string, port string, from string, to []string, msg string, auth smtp.Auth, encryption encryption, config *tls.Config) (*smtp.Client, error) { // connect to the mail server c, err := dial(host, port, encryption, config) if err != nil { return nil, err } // send Hello if err = c.Hello("localhost"); err != nil { c.Close() return nil, errors.New("Mail Error on Hello: " + err.Error()) } // start TLS if necessary if encryption == EncryptionTLS { if ok, _ := c.Extension("STARTTLS"); ok { if config.ServerName == "" { config = &tls.Config{ServerName: host} } if err = c.StartTLS(config); err != nil { c.Close() return nil, errors.New("Mail Error on Start TLS: " + err.Error()) } } } // pass the authentication if necessary if auth != nil { if ok, _ := c.Extension("AUTH"); ok { if err = c.Auth(auth); err != nil { c.Close() return nil, errors.New("Mail Error on Auth: " + err.Error()) } } } return c, nil } type smtpConnectErrorChannel struct { client *smtp.Client err error } // send does the low level sending of the email func send(host string, port string, from string, to []string, msg string, auth smtp.Auth, encryption encryption, config *tls.Config, connectTimeout int) error { var smtpConnectChannel chan smtpConnectErrorChannel var c *smtp.Client var err error // set the timeout value timeout := time.Duration(connectTimeout) * time.Second // if there is a timeout, setup the channel and do the connect under a goroutine if timeout != 0 { smtpConnectChannel = make(chan smtpConnectErrorChannel, 2) go func() { c, err = smtpConnect(host, port, from, to, msg, auth, encryption, config) // send the result smtpConnectChannel <- smtpConnectErrorChannel{ client: c, err: err, } }() } if timeout == 0 { // no timeout, just fire the connect c, err = smtpConnect(host, port, from, to, msg, auth, encryption, config) } else { // get the connect result or timeout result, which ever happens first select { case result := <-smtpConnectChannel: c = result.client err = result.err case <-time.After(timeout): return errors.New("Mail Error: SMTP Connection timed out") } } // check for connect error if err != nil { return err } defer c.Close() // Set the sender if err := c.Mail(from); err != nil { return err } // Set the recipients for _, address := range to { if err := c.Rcpt(address); err != nil { return err } } // Send the data command w, err := c.Data() if err != nil { return err } // write the message _, err = fmt.Fprint(w, msg) if err != nil { return err } err = w.Close() if err != nil { return err } return c.Quit() } |