bcoe / nodemailer-mock-transport

mock-mailer for putting tests around services that use node-mailer

nodemailer-mock-transport

Mock nodemailer-transport, for testing services that rely on nodemailer.

describe('mock-transport', function() {
  it('should store configuration options so that they can be asserted against', function() {
    var transport = mockTransport({
      foo: 'bar'
    });
    transport.options.foo.should.equal('bar');
  });

  it('should store emails sent with nodemailer, so that they can be asserted against', function() {
    var transport = mockTransport({
      foo: 'bar'
    });

    var transporter = nodemailer.createTransport(transport);

    transporter.sendMail({
      from: 'sender@address',
      to: 'receiver@address',
      subject: 'hello',
      text: 'hello world!'
    });

    transport.sentMail.length.should.equal(1);
    transport.sentMail[0].data.to.should.equal('receiver@address');
    transport.sentMail[0].message.content.should.equal('hello world!');
  });

  it('should return an error and not send an email if there is no `to` in the mail data object', function () {
    var transport = mockTransport({
      foo: 'bar'
    });

    var transporter = nodemailer.createTransport(transport);

    transporter.sendMail({
      from: 'sender@address',
      subject: 'hello',
      text: 'hello world!'
    });

    transport.sentMail.length.should.equal(0);
  });
});

nodemailer-mock-transport's Issues

Add a reset function to reset mocked results

Hi! thanks a lot for this module.
I'm using it to mock email sending from a module in a jasmine test suite. My module uses a config file for configuration purpose, one of these config properties is the nodemailer transport. So, I can't create new mock transports between tests and actually I'm resetting the sentMail array between test, to be sure to check the correct data.

I think it would be great to have an "official" reset function that basically reset all the transport internals (actually only the sentMail array).

What do you think?

make the mock mailer throw exceptions

It would be great if there was a way to make the mock-mailer throw an exception.

mail.data.to can be an array

According to the nodemailer documentation, "to" can be an array of recipients, but npm-user-validate assumes that it is a string.

sendMail callback does not return an info object

Some info object defaults can be determined - better yet, allow the user to determine the response from the callback - including both the err and info objects.

From nodeMail documentation:

info includes the result, the exact format depends on the transport mechanism used
info.messageId most transports should return the final Message-Id value used with this property
info.envelope includes the envelope object for the message
info.accepted is an array returned by SMTP transports (includes recipient addresses that were accepted by the server)
info.rejected is an array returned by SMTP transports (includes recipient addresses that were rejected by the server)
info.pending is an array returned by Direct SMTP transport. Includes recipient addresses that were temporarily rejected together with the server response
info.response is a string returned by SMTP transports and includes the last SMTP response from the server