Multiple Email Address

Fixes #854
Fixes #884
Fixes #951
Fixes #954

(cherry picked from commit a8b6f70be1860aa502795f0dd30299c87d54dbbe)
pull/1092/head
Taloth Saldono 4 years ago committed by Qstick
parent 214fa4c06e
commit 811c84a845

@ -0,0 +1,103 @@
using System;
using FizzWare.NBuilder;
using FluentAssertions;
using NUnit.Framework;
using NzbDrone.Core.Notifications.Email;
using NzbDrone.Core.Test.Framework;
using NzbDrone.Test.Common;
namespace NzbDrone.Core.Test.NotificationTests.EmailTests
{
[TestFixture]
public class EmailSettingsValidatorFixture : CoreTest<EmailSettingsValidator>
{
private EmailSettings _emailSettings;
private TestValidator<EmailSettings> _validator;
[SetUp]
public void Setup()
{
_validator = new TestValidator<EmailSettings>
{
v => v.RuleFor(s => s).SetValidator(Subject)
};
_emailSettings = Builder<EmailSettings>.CreateNew()
.With(s => s.Server = "someserver")
.With(s => s.Port = 567)
.With(s => s.From = "readarr@readarr.com")
.With(s => s.To = new string[] { "readarr@readarr.com" })
.Build();
}
[Test]
public void should_be_valid_if_all_settings_valid()
{
_validator.Validate(_emailSettings).IsValid.Should().BeTrue();
}
[Test]
public void should_not_be_valid_if_port_is_out_of_range()
{
_emailSettings.Port = 900000;
_validator.Validate(_emailSettings).IsValid.Should().BeFalse();
}
[Test]
public void should_not_be_valid_if_server_is_empty()
{
_emailSettings.Server = "";
_validator.Validate(_emailSettings).IsValid.Should().BeFalse();
}
[Test]
public void should_not_be_valid_if_from_is_empty()
{
_emailSettings.From = "";
_validator.Validate(_emailSettings).IsValid.Should().BeFalse();
}
[TestCase("readarr")]
[TestCase("readarr@readarr")]
[TestCase("readarr.com")]
public void should_not_be_valid_if_to_is_invalid(string email)
{
_emailSettings.To = new string[] { email };
_validator.Validate(_emailSettings).IsValid.Should().BeFalse();
}
[TestCase("readarr")]
[TestCase("readarr@readarr")]
[TestCase("readarr.com")]
public void should_not_be_valid_if_cc_is_invalid(string email)
{
_emailSettings.CC = new string[] { email };
_validator.Validate(_emailSettings).IsValid.Should().BeFalse();
}
[TestCase("readarr")]
[TestCase("readarr@readarr")]
[TestCase("readarr.com")]
public void should_not_be_valid_if_bcc_is_invalid(string email)
{
_emailSettings.Bcc = new string[] { email };
_validator.Validate(_emailSettings).IsValid.Should().BeFalse();
}
[Test]
public void should_not_be_valid_if_to_bcc_cc_are_all_empty()
{
_emailSettings.To = Array.Empty<string>();
_emailSettings.CC = Array.Empty<string>();
_emailSettings.Bcc = Array.Empty<string>();
_validator.Validate(_emailSettings).IsValid.Should().BeFalse();
}
}
}

@ -1,5 +1,4 @@
using FluentMigrator; using FluentMigrator;
using Newtonsoft.Json.Linq;
using NzbDrone.Core.Datastore.Migration.Framework; using NzbDrone.Core.Datastore.Migration.Framework;
namespace NzbDrone.Core.Datastore.Migration namespace NzbDrone.Core.Datastore.Migration

@ -1,18 +1,24 @@
using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq;
using FluentValidation.Results; using FluentValidation.Results;
using MailKit.Net.Smtp;
using MailKit.Security;
using MimeKit;
using NLog;
using NzbDrone.Common.Extensions; using NzbDrone.Common.Extensions;
namespace NzbDrone.Core.Notifications.Email namespace NzbDrone.Core.Notifications.Email
{ {
public class Email : NotificationBase<EmailSettings> public class Email : NotificationBase<EmailSettings>
{ {
private readonly IEmailService _emailService; private readonly Logger _logger;
public override string Name => "Email"; public override string Name => "Email";
public Email(IEmailService emailService) public Email(Logger logger)
{ {
_emailService = emailService; _logger = logger;
} }
public override string Link => null; public override string Link => null;
@ -21,7 +27,7 @@ namespace NzbDrone.Core.Notifications.Email
{ {
var body = $"{grabMessage.Message} sent to queue."; var body = $"{grabMessage.Message} sent to queue.";
_emailService.SendEmail(Settings, BOOK_GRABBED_TITLE_BRANDED, body); SendEmail(Settings, BOOK_GRABBED_TITLE_BRANDED, body);
} }
public override void OnReleaseImport(BookDownloadMessage message) public override void OnReleaseImport(BookDownloadMessage message)
@ -30,31 +36,144 @@ namespace NzbDrone.Core.Notifications.Email
var paths = Settings.AttachFiles ? message.BookFiles.SelectList(a => a.Path) : null; var paths = Settings.AttachFiles ? message.BookFiles.SelectList(a => a.Path) : null;
_emailService.SendEmail(Settings, BOOK_DOWNLOADED_TITLE_BRANDED, body, false, paths); SendEmail(Settings, BOOK_DOWNLOADED_TITLE_BRANDED, body, paths);
} }
public override void OnHealthIssue(HealthCheck.HealthCheck message) public override void OnHealthIssue(HealthCheck.HealthCheck message)
{ {
_emailService.SendEmail(Settings, HEALTH_ISSUE_TITLE_BRANDED, message.Message); SendEmail(Settings, HEALTH_ISSUE_TITLE_BRANDED, message.Message);
} }
public override void OnDownloadFailure(DownloadFailedMessage message) public override void OnDownloadFailure(DownloadFailedMessage message)
{ {
_emailService.SendEmail(Settings, DOWNLOAD_FAILURE_TITLE_BRANDED, message.Message); SendEmail(Settings, DOWNLOAD_FAILURE_TITLE_BRANDED, message.Message);
} }
public override void OnImportFailure(BookDownloadMessage message) public override void OnImportFailure(BookDownloadMessage message)
{ {
_emailService.SendEmail(Settings, IMPORT_FAILURE_TITLE_BRANDED, message.Message); SendEmail(Settings, IMPORT_FAILURE_TITLE_BRANDED, message.Message);
} }
public override ValidationResult Test() public override ValidationResult Test()
{ {
var failures = new List<ValidationFailure>(); var failures = new List<ValidationFailure>();
failures.AddIfNotNull(_emailService.Test(Settings)); failures.AddIfNotNull(Test(Settings));
return new ValidationResult(failures); return new ValidationResult(failures);
} }
public ValidationFailure Test(EmailSettings settings)
{
const string body = "Success! You have properly configured your email notification settings";
try
{
SendEmail(settings, "Readarr - Test Notification", body);
}
catch (Exception ex)
{
_logger.Error(ex, "Unable to send test email");
return new ValidationFailure("Server", "Unable to send test email");
}
return null;
}
private void SendEmail(EmailSettings settings, string subject, string body, bool htmlBody = false, List<string> attachmentUrls = null)
{
var email = new MimeMessage();
email.From.Add(ParseAddress("From", settings.From));
email.To.AddRange(settings.To.Select(x => ParseAddress("To", x)));
email.Cc.AddRange(settings.CC.Select(x => ParseAddress("CC", x)));
email.Bcc.AddRange(settings.Bcc.Select(x => ParseAddress("BCC", x)));
email.Subject = subject;
email.Body = new TextPart(htmlBody ? "html" : "plain")
{
Text = body
};
_logger.Debug("Sending email Subject: {0}", subject);
if (attachmentUrls != null)
{
foreach (var url in attachmentUrls)
{
email.Attachments.Add(new Attachment(url));
}
}
try
{
Send(email, settings);
_logger.Debug("Email sent. Subject: {0}", subject);
}
catch (Exception ex)
{
_logger.Error("Error sending email. Subject: {0}", email.Subject);
_logger.Debug(ex, ex.Message);
throw;
}
_logger.Debug("Finished sending email. Subject: {0}", email.Subject);
}
private void Send(MimeMessage email, EmailSettings settings)
{
using (var client = new SmtpClient())
{
client.Timeout = 10000;
var serverOption = SecureSocketOptions.Auto;
if (settings.RequireEncryption)
{
if (settings.Port == 465)
{
serverOption = SecureSocketOptions.SslOnConnect;
}
else
{
serverOption = SecureSocketOptions.StartTls;
}
}
_logger.Debug("Connecting to mail server");
client.Connect(settings.Server, settings.Port, serverOption);
if (!string.IsNullOrWhiteSpace(settings.Username))
{
_logger.Debug("Authenticating to mail server");
client.Authenticate(settings.Username, settings.Password);
}
_logger.Debug("Sending to mail server");
client.Send(email);
_logger.Debug("Sent to mail server, disconnecting");
client.Disconnect(true);
_logger.Debug("Disconnecting from mail server");
}
}
private MailboxAddress ParseAddress(string type, string address)
{
try
{
return MailboxAddress.Parse(address);
}
catch (Exception ex)
{
_logger.Error(ex, "{0} email address '{1}' invalid", type, address);
throw;
}
}
} }
} }

@ -1,92 +0,0 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net.Mail;
using FluentValidation.Results;
using NLog;
using NzbDrone.Common.Http;
namespace NzbDrone.Core.Notifications.Email
{
public interface IEmailService
{
void SendEmail(EmailSettings settings, string subject, string body, bool htmlBody = false, List<string> attachmentUrls = null);
ValidationFailure Test(EmailSettings settings);
}
public class EmailService : IEmailService
{
private readonly Logger _logger;
public EmailService(Logger logger)
{
_logger = logger;
}
public void SendEmail(EmailSettings settings, string subject, string body, bool htmlBody = false, List<string> attachmentUrls = null)
{
var email = new MailMessage();
email.From = new MailAddress(settings.From);
settings.To.ToList().ForEach(x => email.To.Add(x));
settings.CC.ToList().ForEach(x => email.CC.Add(x));
settings.Bcc.ToList().ForEach(x => email.Bcc.Add(x));
email.Subject = subject;
email.Body = body;
email.IsBodyHtml = htmlBody;
if (attachmentUrls != null)
{
foreach (var url in attachmentUrls)
{
email.Attachments.Add(new Attachment(url));
}
}
BasicNetworkCredential credentials = null;
if (!string.IsNullOrWhiteSpace(settings.Username))
{
credentials = new BasicNetworkCredential(settings.Username, settings.Password);
}
try
{
Send(email, settings.Server, settings.Port, settings.Ssl, credentials);
}
catch (Exception ex)
{
_logger.Error("Error sending email. Subject: {0}", email.Subject);
_logger.Debug(ex, ex.Message);
throw;
}
}
private void Send(MailMessage email, string server, int port, bool ssl, BasicNetworkCredential credentials)
{
var smtp = new SmtpClient(server, port);
smtp.EnableSsl = ssl;
smtp.Credentials = credentials;
smtp.Send(email);
}
public ValidationFailure Test(EmailSettings settings)
{
const string body = "Success! You have properly configured your email notification settings";
try
{
SendEmail(settings, "Readarr - Test Notification", body);
}
catch (Exception ex)
{
_logger.Error(ex, "Unable to send test email");
return new ValidationFailure("Server", "Unable to send test email");
}
return null;
}
}
}

@ -1,4 +1,6 @@
using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq;
using FluentValidation; using FluentValidation;
using NzbDrone.Core.Annotations; using NzbDrone.Core.Annotations;
using NzbDrone.Core.ThingiProvider; using NzbDrone.Core.ThingiProvider;
@ -13,7 +15,14 @@ namespace NzbDrone.Core.Notifications.Email
RuleFor(c => c.Server).NotEmpty(); RuleFor(c => c.Server).NotEmpty();
RuleFor(c => c.Port).InclusiveBetween(1, 65535); RuleFor(c => c.Port).InclusiveBetween(1, 65535);
RuleFor(c => c.From).NotEmpty(); RuleFor(c => c.From).NotEmpty();
RuleFor(c => c.To).NotEmpty(); RuleForEach(c => c.To).EmailAddress();
RuleForEach(c => c.CC).EmailAddress();
RuleForEach(c => c.Bcc).EmailAddress();
// Only require one of three send fields to be set
RuleFor(c => c.To).NotEmpty().Unless(c => c.Bcc.Any() || c.CC.Any());
RuleFor(c => c.CC).NotEmpty().Unless(c => c.To.Any() || c.Bcc.Any());
RuleFor(c => c.Bcc).NotEmpty().Unless(c => c.To.Any() || c.CC.Any());
} }
} }
@ -23,11 +32,12 @@ namespace NzbDrone.Core.Notifications.Email
public EmailSettings() public EmailSettings()
{ {
Port = 25; Server = "smtp.gmail.com";
Port = 587;
To = new string[] { }; To = Array.Empty<string>();
CC = new string[] { }; CC = Array.Empty<string>();
Bcc = new string[] { }; Bcc = Array.Empty<string>();
} }
[FieldDefinition(0, Label = "Server", HelpText = "Hostname or IP of Email server")] [FieldDefinition(0, Label = "Server", HelpText = "Hostname or IP of Email server")]
@ -36,8 +46,8 @@ namespace NzbDrone.Core.Notifications.Email
[FieldDefinition(1, Label = "Port")] [FieldDefinition(1, Label = "Port")]
public int Port { get; set; } public int Port { get; set; }
[FieldDefinition(2, Label = "SSL", Type = FieldType.Checkbox)] [FieldDefinition(2, Label = "Require Encryption", HelpText = "Require SSL (Port 465 only) or StartTLS (any other port)", Type = FieldType.Checkbox)]
public bool Ssl { get; set; } public bool RequireEncryption { get; set; }
[FieldDefinition(3, Label = "Username", Privacy = PrivacyLevel.UserName)] [FieldDefinition(3, Label = "Username", Privacy = PrivacyLevel.UserName)]
public string Username { get; set; } public string Username { get; set; }
@ -48,13 +58,13 @@ namespace NzbDrone.Core.Notifications.Email
[FieldDefinition(5, Label = "From Address")] [FieldDefinition(5, Label = "From Address")]
public string From { get; set; } public string From { get; set; }
[FieldDefinition(6, Label = "Recipient Address(es)", HelpText = "Comma separated list of email recipients")] [FieldDefinition(6, Label = "Recipient Address(es)", HelpText = "Comma seperated list of email recipients")]
public IEnumerable<string> To { get; set; } public IEnumerable<string> To { get; set; }
[FieldDefinition(7, Label = "CC Address(es)", HelpText = "Comma separated list of email cc recipients", Advanced = true)] [FieldDefinition(7, Label = "CC Address(es)", HelpText = "Comma seperated list of email cc recipients", Advanced = true)]
public IEnumerable<string> CC { get; set; } public IEnumerable<string> CC { get; set; }
[FieldDefinition(8, Label = "BCC Address(es)", HelpText = "Comma separated list of email bcc recipients", Advanced = true)] [FieldDefinition(8, Label = "BCC Address(es)", HelpText = "Comma seperated list of email bcc recipients", Advanced = true)]
public IEnumerable<string> Bcc { get; set; } public IEnumerable<string> Bcc { get; set; }
[FieldDefinition(9, Label = "Attach Books", HelpText = "Add books as an attachment on import", Type = FieldType.Checkbox)] [FieldDefinition(9, Label = "Attach Books", HelpText = "Add books as an attachment on import", Type = FieldType.Checkbox)]

Loading…
Cancel
Save