cake-contrib / cake.email

Cake Addin that exends Cake with ability to send email.

Cake.Email

Cake.Email is an Addin for Cake which allows sending of email from your build scripts.

Usage

First, include a reference to this addin in your script like this:

#addin nuget:?package=Cake.Email&version=0.8.0&loaddependencies=true

Second, we highly recommend that you add the following 'using' statement in your script. Technically, this is not necessary, but it simplifies dealing with attachements:

using Cake.Email.Common;

Also, this addin is designed to take advantage of some of the new features released in CakeBuild version 0.33.0 therefore your tools\package.config should look like this:

<packages>
    <package id="Cake" version="0.33.0" />
</packages>

Information

	Stable	Pre-release
GitHub Release	-
Package

Build Status

Develop	Master

Code Coverage

Quick Links

• Documentation

Chat Room

Please do not hesitate to reach out in the GitHub discussions if you have any issues using this addin.

cake.email's Issues

Add cake-addin tag to Cake.Email NuGet package

The NuGet Gallery will soon include a "Cake" tab with instructions on how to use NuGet packages in Cake build scripts. I'd like to suggest that you include the tag cake-addin in the NuGet package of this addin, so that the NuGet Gallery can display the correct instructions to install this addin.

The UI will look similar to this:

Documentation on best practices on tags for Cake addins: https://cakebuild.net/docs/extending/addins/best-practices#tags

Downgrade Cake to 0.21.1

To ensure our build script (which is based on Cake.Recipe) completes successfully

Allow email to be sent to multiple recipients

This idea was suggested by @vijaysync and @phillipsj in a Gitter conversation

XML Documentation examples use incorrect method name

xmldoc examples use the Send method rather than the SendEmail method.

Add Wyam Documentation generation

Support Cake 0.33.0

Make tools folder invalidation dependent on setup.cake

Correct AppVeyor Skip Regular Expression

Send multi-part emails

Currently we send either html or text content. It would be great to send both (just like SendGrid, CakeMail and all other ESPs).

Recommended changes resulting from automated audit

We performed an automated audit of your Cake addin and found that it does not follow all the best practices.

We encourage you to make the following modifications:

• You are currently referencing Cake.Core 0.26.1. Please upgrade to 0.28.0

Apologies if this is already being worked on, or if there are existing open issues, this issue was created based on what is currently published for this package on NuGet.org and in the project on github.

Do not distribute unneccessary dependencies

As stated here, addins should not distribute Cake.Common and Cake.Core.

Switch away from System.Net.Mail

System.Net.Mail is not available in netstandard1.6 therefore we need an alternative in order to ensure we can multi-target net46 and netstandard1.6

MailKit is an excellent alternative

Use the new Cake.Email.Common nuget package

This new nuget package contains classes like Attachment and MailAddress that can be reused by Cake.Email, Cake.SendGrid and Cake.CakeMail

Upgrade to Cake 0.26.0 and target netstandard2.0

We performed an automated audit of your Cake addin and found that it does not follow all the best practices.

We encourage you to make the following modifications:

• You are currently referencing Cake.Core 0.22.2. Please upgrade to 0.26.0
• You are currently referencing Cake.Common 0.22.2. Please upgrade to 0.26.0
• Your addin should target netstandard2.0
  (Please note: there is no need to multi-target. As of Cake 0.26.0, netstandard2.0 is sufficient)

Code sample in Index.md is missing parameter

The 'sendAsHtml' Boolean parameter is missing from the code sample in Index.md

Replace Gitter with GitHub Discussions

The Discussion platform for Cake-Contrib has been moved from Gitter to GitHub Discussion (see cake-build/website#1470).
Please check this repo for references to Gitte and replace them accordingly.

Search suggests that references could be in

• README.md
• docs/input/blog/new-release-0.3.0.md
• docs/input/blog/new-release-0.4.0.md
• docs/input/blog/new-release-0.5.0.md
• docs/input/blog/new-release-0.2.0.md
• docs/input/blog/new-release-0.7.0.md
• docs/input/blog/new-release-0.8.0.md
• docs/input/blog/new-release-0.6.0.md
• docs/input/blog/new-release-0.5.4.md

Remove Gitter Configuration from yml file

Support Cake 0.22.2

Doesn't allow to send mail with empty password

Doesn't work if the SMTP password is blank. I tested the same thing with using native .NET SmtpClient and not passing the password, that is how the credentials are setup, was able to send mail

mailClient.EnableSsl = false;
mailClient.Host = "<my smtp server>";
mailClient.Port = 25;
mailClient.Credentials = new NetworkCredential("<my username>", string.Empty);

Only send email to recipients with an email address

Make sure we exclude null recipients and recipients with empty email address when attempting to send an email

Multi-target net46 and netstandard1.6

• Convert solution to VS217
• Add netstandard1.6 target
• Upgrade netfull target to 4.6
• Bump Cake to 0.22.2

Use this pull request as guideline

MimeTypesMap is not included in the NuGet package

Currently, MimeTypesMap is not included in the NuGet package for Cake.Email. This results in a file not found assembly loading failure when running.

This would need any of:

• Including MimeTypesMap in the Nuget package (assuming Recipe can do this @gep13 ?)
• Try ILMerge/ILRepack'ing MimeTypesMap.dll into Cake.Email.dll
• Update documentation to include #nuget:?package=MimeTypesMap (wrong TFM)

Update docs for Cake 0.23.0

Failed to send email

Hello. I am trying to use latest version of Cake.Email.0.8.0 but cannot send email via code like this :

var result = Email.SendEmail(
	senderName: "Deployment Agent",
	subject: "Report Deploy " + DateTime.Now.ToString("yyyy-MM-dd-HH:mm"),		
	senderAddress: "****@***",
	recipients: recipientsAresses,
	htmlContent: "<html><body>" + message + "</body></html>",
	textContent: message,
	attachments: null,
	settings: new EmailSettings 
	{
		SmtpHost = "****",
		Port = 587, 
		EnableSsl = true,
		Username = "****",
		Password = "****"
	});
	if (result.Ok)
	{
		Information("Email succcessfully sent");
	}
	else
	{
		Error("Failed to send email: {0}", result.Error);
	}

Error I had always got :
Failed to send email: The handshake failed due to an unexpected packet format.
I don't understand - problem in my code, either on recipient server side, or my own server.

I also tried to use telnet to sending email, and it was success :

Telnet
Set localecho
Set logfile
open **** 587
HELO *****
mail from :****@*****
rcpt to: ******
Data
Subject: Test

test message

.
Quit

MIME type is not set when enbedding an attachment

Nuget package not published

The package for the addin is no longer published to nuget

Attach files option not availble in cake mail addin

I am using Cake.Email addin for sending mail to multiple recipents but i need to attach some documents while sending mail.
I think we don't have this feature .So please add this option in Cake.Email addin .It will be very useful too

Update nuspec with Cake Contrib Icon

Add ability to send emails via a SMTP server

Update Cake.Email add-in to target Cake v2.0.0

Cake 2.0.0 has been released 🎉

Update Cake.Email NuGet package icon to the new Cake-Contrib logo for Cake modules

We've recently released new icons for Cake extensions, to help more easily differentiate Cake Addins, Modules, Recipes, etc.

More information: https://github.com/cake-contrib/graphics

Upgrade to Cake.Recipe 2.2.0

Instructions: https://cake-contrib.github.io/Cake.Recipe/docs/upgrading/1.x-to-2.x

Update to latest Cake

Upgrade MailKit to latest

Update Cake.Email to target Cake v1.0.0

https://cakebuild.net/blog/2021/02/cake-v1.0.0-released

Switch away from using gep13.DefaultBuild and use Cake.Recipe instead

Correct missing packages.config file

Change PackageIconUrl to PackageIcon

PackageIconUrl is being deprecated and the new recommendation is to embed your icon in the package.

Given path format not supported

We could not use path format like below in LocalFile method

var attachments = new[]
{
    Email.CreateAttachmentFromLocalFile("‪D:\\error.zip")
};

Error: The given path's format is not supported.

Tried like below

Email.CreateAttachmentFromLocalFile("‪./error.zip")

but shows

Error :Unble to locate local file

Add lib folder structure to NuGet package

Currently, the Cake.Email NuGet Package places all files into the root of the NuGet package:

This needs to be corrected to place them into the appropriate lib folder. In this case lib\net45\

See here: http://docs.nuget.org/ndocs/schema/nuspec#examples

Fix minor issue with NuGet metadata