Skip to content

Latest commit

 

History

History
126 lines (107 loc) · 3.74 KB

README.md

File metadata and controls

126 lines (107 loc) · 3.74 KB
Raw

NSG.MimeKit

Overview

This solution contains .Net Standard projects as follows:

  • A collection of support functions for MimeKit (NSG.MimeKit.Extensions)
  • A collection of support functions for MimeKit and SendGrid (NSG.MimeKit.SendGrid.Extensions)

NSG.MimeKit.Extensions

MailKit/MimeKit libraries are commonly use in a .Net Core application. NSG.MimeKit.Extensions library uses the MimeKit namespace and fluently extends the MimeMessage and BodyBuilder classes.

Example from unit tests:

Task<MimeMessage> _email = (new MimeMessage())
    .From(_fromAddress).To(_toAddress)
    .Subject(_subject).Body(
        Extensions.TextBody(_message)
            .Attachment(_buffer, "Text.txt", "text/plain;charset=utf-8")
    ).SendAsync(); // "localhost", 25, false, "", "");

NSG.MimeKit.EmailSettings

EmailSettings is a class that maps the appSettings.json configuration. I've implemented the appSettings.json mapping as a Dictionary, so the application can have multiple configurations based on the company. The appSettings.json can be implemented as a simple single class. If you use gmail or yahoo or at&t mail server you will need to use an App Password instead of the email account's password. Since the configuration contains passwords I've stored the values in secrets.json.

Example from of secrets.json:

{
  "EmailSettings": {
    "Default": {
      "SmtpHost": "smtp.gmail.com",
      "SmtpPort": 587,
      "SmtpSecureOption": "StartTls",
      "IMapHost": "imap.gmail.com",
      "IMapPort": 993,
      "IMapSecureOption": "StartTlsWhenAvailable",
      "InBox": "INBOX",
      "SentBox": "[Gmail]/Sent Mail",
      "UserName": "Administrator",
      "UserEmail": "nsg@gmail.com",
      "Password": "iiii vvvv uuuu dbdb"
    },
    "NSG": {
      "SmtpHost": "smtp.gmail.com",
      "SmtpPort": 587,
      "SmtpSecureOption": "StartTls",
      "IMapHost": "imap.gmail.com",
      "IMapPort": 993,
      "IMapSecureOption": "StartTlsWhenAvailable",
      "InBox": "INBOX",
      "SentBox": "[Gmail]/Sent Mail",
      "UserName": "Phil (Gmail)",
      "UserEmail": "nsg@gmail.com",
      "Password": "iiii vvvv uuuu dbdb"
    },
    "Cmp1": {
      "SmtpHost": "smtp.mail.yahoo.com",
      "SmtpPort": 587,
      "SmtpSecureOption": "StartTls",
      "IMapHost": "imap.mail.yahoo.com",
      "IMapPort": 993,
      "IMapSecureOption": "StartTlsWhenAvailable",
      "InBox": "Inbox",
      "SentBox": "Sent",
      "UserName": "Bill (Yahoo)",
      "UserEmail": "Company1@yahoo.com",
      "Password": "ououwwwwkkkjjjj"
    }
  }
}

In the tests project, I've also hidden email accounts in the secrets.json as follows:

{
  "EmailSettings": {
    ...
  },
  "gmail": {
    "UserName": "Phil (gmail)",
    "UserEmail": "Phil@gmail.com"
  },
  "yahoo": {
    "UserName": "Phil (Yahoo)",
    "UserEmail": "Phil@yahoo.com"
  }
}

NSG.MimeKit.SendGrid.Extensions

Translation of SendGridMessage to MimeMessage.

NSG.MimeKit_Tests

NSG.MimeKit_Tests is a project of MS unit tests for the library. One can view the tests for examples in using the functions.

Also, I used a fake SMTP server to build and test the library. The fake SMTP server is an NPM install. It is globally installed by the following command:

npm install -g fake-smtp-server

The following launches the server on port 25:

fake-smtp-server --smtp-port 25 --http-port 10080 --max 10

The Fake SMTP Server documentation is located here.

You can use your own SMTP solution to the problem of testing.

Docs

Currently having problems getting Sandcastle Help Builder to work with .Net Standard 2.1.

Wiki

The Wiki pages were created by cs2media_wiki.py python script. The mediwiki scripts are located here.