mailer 2.3.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 93

mailer #

mailer is an easy to use library for composing and sending emails in Dart.

Mailer supports file attachments and HTML emails.

mailer2 and mailer3 #

mailer2 and mailer3 on pub.dart are forks of this project.

mailer had some issues and we only recently (dart2 support) started to work on issues / PRs.

Currently mailer should include all known bug-fixes and AFAIK there is no reason to use mailer2 or mailer3.

Dart2 support #

Support for dart2 has been added in version ^1.2.0

Version ^2.0.0 is a rewrite (it too supports dart1.x and dart2).

Even though the API for ^2.0.0 has slightly changed, most programs will probably continue to work with deprecation warnings.

SMTP definitions #

Mailer provides configurations for a few common SMTP servers.

Please create merge requests for missing configurations.

  • Copy lib/smtp_server/gmail.dart to lib/smtp_server/xxx.dart
  • Adapt the code. (See lib/smtp_server.dart for possible arguments)
  • Export the newly created SMTP server in lib/smtp_server.dart
  • Create a pull request.

In a lot of cases you will find a configuration in legacy.dart

Features #

  • Plaintext and HTML emails
  • Unicode support
  • Attachments
  • Secure (filters and sanitizes all fields context-wise)
  • Use any SMTP server like Gmail, Live, SendGrid, Amazon SES
  • SSL/TLS support
  • Pre-configured services (Gmail, Yahoo, Hotmail, etc.). Just fill in your username and password.

TODO HELP WANTED

  • Correct encoding of non ASCII mail addresses.
  • Reintegrate address validation from version 1.*
  • Improve Header types. (see ir_header.dart)
    We should choose the correct header based on the header name.
    Known headers (list-unsubscribe,...) should have their own subclass.
  • Improve documentation.

Examples #

Sending an email with SMTP #

See gmail example.

import 'dart:io';

import 'package:mailer/mailer.dart';
import 'package:mailer/smtp_server.dart';

main() async {
  String username = 'username@gmail.com';
  String password = 'password';

  final smtpServer = gmail(username, password);
  // Use the SmtpServer class to configure an SMTP server:
  // final smtpServer = new SmtpServer('smtp.domain.com');
  // See the named arguments of SmtpServer for further configuration
  // options.  
  
  // Create our message.
  final message = new Message()
    ..from = new Address(username, 'Your name')
    ..recipients.add('destination@example.com')
    ..ccRecipients.addAll(['destCc1@example.com', 'destCc2@example.com'])
    ..bccRecipients.add(new Address('bccAddress@example.com'))
    ..subject = 'Test Dart Mailer library :: 😀 :: ${new DateTime.now()}'
    ..text = 'This is the plain text.\nThis is line 2 of the text part.'
    ..html = "<h1>Test</h1>\n<p>Hey! Here's some HTML content</p>";

  // Use [catchExceptions]: true to prevent [send] from throwing.
  // Note that the default for [catchExceptions] will change from true to false
  // in the future!
  final sendReports = await send(message, smtpServer, catchExceptions: false);
  
  // DONE
  
  
  // Let's send another message using a slightly different syntax:
  //
  // Addresses without a name part can be set directly.
  // For instance `..recipients.add('destination@example.com')`
  // If you want to display a name part you have to create an
  // Address object: `new Address('destination@example.com', 'Display name part')`
  // Creating and adding an Address object without a name part
  // `new Address('destination@example.com')` is equivalent to
  // adding the mail address as `String`.
  final equivalentMessage = new Message()
      ..from = new Address(username, 'Your name')
      ..recipients.add(new Address('destination@example.com'))
      ..ccRecipients.addAll([new Address('destCc1@example.com'), 'destCc2@example.com'])
      ..bccRecipients.add('bccAddress@example.com')
      ..subject = 'Test Dart Mailer library :: 😀 :: ${new DateTime.now()}'
      ..text = 'This is the plain text.\nThis is line 2 of the text part.'
      ..html = "<h1>Test</h1>\n<p>Hey! Here's some HTML content</p>";
    
  final sendReports2 = await send(equivalentMessage, smtpServer, catchExceptions: false);
}

License #

This library is licensed under MIT.

2.3.0 #

  • add timeout option. (https://github.com/pjkroll)
  • add catchExceptions flag (currently true, but default will change to false) improve exceptions.
  • remove username from authentication failure exception (see issue #79)

2.2.1 #

  • fix regular expression which is used to validate the name of an email address.

2.2.0 #

  • add qq smtp server definition

2.1.2 #

  • improve exception when server response does not match.

2.1.1 #

  • if a header value is null send empty string instead.
  • if mime library fails to identify content use text/plain and application/octet-stream
    as defaults.
  • mention mailer2 and mailer3 in README

2.1.0 #

  • provide smtp_servers in smtp_server.dart

2.0.2 #

  • added smtp configuration for mailgun.org

>1.1.4 <2.0.2

Please see README and commits.

1.1.4 #

  • Remove extra trailing \r\n from messages as some servers may interpret it as an empty command and send back an error code after success code

1.1.3 #

  • Fix occasional issue with completer already completed. Due to an error with SMTP server closing connection after sending the email.

1.1.2 #

  • Fix new lines sent to server to be proper \r\n format

1.1.1 #

  • loosen crypto dependency to '>=0.9.0 <3.0.0' as suggested in the crypto changelog

1.1.0 #

  • merge crypto util fix and update example
  • upgrade unittest to test and move it to dev_dependencies
  • added OpenMailBoxSmtpOptions
  • improve address parsing and sanitization (from hoylen)
  • cleanup chunkEncodedBytes and associated test
  • update example to allow CC and BCC

1.0.1 #

  • add simple example/send_gmail.data
  • fix pubspec to pull crypto 0.9.0

1.0.0 - Oct 4, 2015 #

  • initial release

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  mailer: ^2.3.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:mailer/mailer.dart';
  
Version Uploaded Documentation Archive
2.3.0 Apr 1, 2019 Go to the documentation of mailer 2.3.0 Download mailer 2.3.0 archive
2.2.1 Feb 4, 2019 Go to the documentation of mailer 2.2.1 Download mailer 2.2.1 archive
2.2.0 Jan 21, 2019 Go to the documentation of mailer 2.2.0 Download mailer 2.2.0 archive
2.1.2 Jan 9, 2019 Go to the documentation of mailer 2.1.2 Download mailer 2.1.2 archive
2.1.1 Nov 29, 2018 Go to the documentation of mailer 2.1.1 Download mailer 2.1.1 archive
2.1.0 Nov 17, 2018 Go to the documentation of mailer 2.1.0 Download mailer 2.1.0 archive
2.0.2 Oct 8, 2018 Go to the documentation of mailer 2.0.2 Download mailer 2.0.2 archive
2.0.1 Sep 24, 2018 Go to the documentation of mailer 2.0.1 Download mailer 2.0.1 archive
2.0.0 Sep 20, 2018 Go to the documentation of mailer 2.0.0 Download mailer 2.0.0 archive
1.2.3 Aug 20, 2018 Go to the documentation of mailer 1.2.3 Download mailer 1.2.3 archive

All 31 versions...

Popularity:
Describes how popular the package is relative to other packages. [more]
92
Health:
Code health derived from static analysis. [more]
94
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
95
Overall:
Weighted score of the above. [more]
93
Learn more about scoring.

We analyzed this package on Apr 22, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.2.0
  • pana: 0.12.14

Platforms

Detected platforms: Flutter, other

Primary library: package:mailer/mailer.dart with components: io.

Health suggestions

Fix lib/smtp_server.dart. (-1.99 points)

Analysis of lib/smtp_server.dart reported 4 hints:

line 21 col 17: Use = to separate a named parameter from its default value.

line 23 col 32: Use = to separate a named parameter from its default value.

line 24 col 15: Use = to separate a named parameter from its default value.

line 25 col 25: Use = to separate a named parameter from its default value.

Fix lib/src/smtp/connection.dart. (-1.99 points)

Analysis of lib/src/smtp/connection.dart reported 4 hints:

line 13 col 1: Prefer using /// for doc comments.

line 40 col 7: Don't explicitly initialize variables to null.

line 40 col 20: Use = to separate a named parameter from its default value.

line 41 col 27: Use = to separate a named parameter from its default value.

Fix lib/src/entities/attachment.dart. (-0.50 points)

Analysis of lib/src/entities/attachment.dart reported 1 hint:

line 16 col 1: Prefer using /// for doc comments.

Fix additional 6 files with analysis or formatting issues. (-1.50 points)

Additional issues in the following files:

  • lib/src/entities/message.dart (1 hint)
  • lib/src/smtp/internal_representation/ir_content.dart (1 hint)
  • lib/src/smtp/smtp_client.dart (1 hint)
  • lib/mailer.dart (Run dartfmt to format lib/mailer.dart.)
  • lib/src/smtp/internal_representation/ir_header.dart (Run dartfmt to format lib/src/smtp/internal_representation/ir_header.dart.)
  • lib/src/smtp/internal_representation/ir_message.dart (Run dartfmt to format lib/src/smtp/internal_representation/ir_message.dart.)

Maintenance suggestions

Homepage URL is insecure. (-5 points)

Update the homepage field and use a secure (https) URL.

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

Common filename patterns include main.dart, example.dart, and mailer.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.24.0 <3.0.0
async ^2.0.0 2.2.0
dart2_constant ^1.0.0 1.0.2+dart2
intl >0.9.0 <1.0.0 0.15.8
logging >0.0.1 <1.0.0 0.11.3+2
mime >0.9.0 <1.0.0 0.9.6+2
path >0.9.0 <2.0.0 1.6.2
Transitive dependencies
collection 1.14.11
Dev dependencies
args ^1.5.0
test ^1.5.1