From ae349d7a05fb8c11a07cd13134f3587b2963e067 Mon Sep 17 00:00:00 2001 From: jefim Date: Fri, 3 Nov 2023 10:11:48 +0200 Subject: [PATCH] Fix #20 Added missing metadata file; updated README.md. --- Frends.SMTP.SendEmail/CHANGELOG.md | 3 + .../Frends.Smtp.SendEmail.csproj | 8 +- .../FrendsTaskMetadata.json | 5 ++ Frends.SMTP.SendEmail/README.md | 74 +------------------ 4 files changed, 16 insertions(+), 74 deletions(-) create mode 100644 Frends.SMTP.SendEmail/Frends.Smtp.SendEmail/FrendsTaskMetadata.json diff --git a/Frends.SMTP.SendEmail/CHANGELOG.md b/Frends.SMTP.SendEmail/CHANGELOG.md index 5e91210..155dd0f 100644 --- a/Frends.SMTP.SendEmail/CHANGELOG.md +++ b/Frends.SMTP.SendEmail/CHANGELOG.md @@ -1,5 +1,8 @@ # Changelog +## [1.0.2] - 2023-11-03 +- Fix bug #20 - Missing Frends tasks metadata file + ## [1.0.1] - 2023-05-15 - Fix bug #14 - NullReferenceException when field with 'Expression' type is empty diff --git a/Frends.SMTP.SendEmail/Frends.Smtp.SendEmail/Frends.Smtp.SendEmail.csproj b/Frends.SMTP.SendEmail/Frends.Smtp.SendEmail/Frends.Smtp.SendEmail.csproj index e81e508..656f830 100644 --- a/Frends.SMTP.SendEmail/Frends.Smtp.SendEmail/Frends.Smtp.SendEmail.csproj +++ b/Frends.SMTP.SendEmail/Frends.Smtp.SendEmail/Frends.Smtp.SendEmail.csproj @@ -3,7 +3,7 @@ netstandard2.0;net6.0 - 1.0.1 + 1.0.2 Frends Frends Frends @@ -19,4 +19,10 @@ + + + PreserveNewest + + + diff --git a/Frends.SMTP.SendEmail/Frends.Smtp.SendEmail/FrendsTaskMetadata.json b/Frends.SMTP.SendEmail/Frends.Smtp.SendEmail/FrendsTaskMetadata.json new file mode 100644 index 0000000..26ffbfc --- /dev/null +++ b/Frends.SMTP.SendEmail/Frends.Smtp.SendEmail/FrendsTaskMetadata.json @@ -0,0 +1,5 @@ +{ + "Tasks": [ + { "TaskMethod": "Frends.SMTP.SendEmail.SMTP.SendEmail" } + ] +} \ No newline at end of file diff --git a/Frends.SMTP.SendEmail/README.md b/Frends.SMTP.SendEmail/README.md index b24850f..6d8de4e 100644 --- a/Frends.SMTP.SendEmail/README.md +++ b/Frends.SMTP.SendEmail/README.md @@ -2,7 +2,6 @@ [![Frends.Smtp.SendEmail Main](https://github.com/FrendsPlatform/Frends.Smtp/actions/workflows/SendEmail_main.yml/badge.svg)](https://github.com/FrendsPlatform/Frends.Regex/actions/workflows/IsMatch_build_and_test_on_main.yml) -![MyGet](https://img.shields.io/myget/frends-tasks/v/Frends.Smtp.SendEmail?label=NuGet) ![GitHub](https://img.shields.io/github/license/FrendsPlatform/Frends.Smtp?label=License) ![Coverage](https://app-github-custom-badges.azurewebsites.net/Badge?key=FrendsPlatform/Frends.Smtp/Frends.Smtp.SendEmail|main) @@ -10,67 +9,10 @@ Frends task for sending emails with SMTP. Task sends emails via SMTP protocol an ## Installing -You can install the Task via frends UI Task View or you can find the NuGet package from the following NuGet feed -https://www.myget.org/F/frends-tasks/api/v2. - -## Task Parameters - -### Message -Settings for message properties - -| Property | Type | Description | Example | -| ---------------------| ---------------------| ------------------------------------ | ----- | -| To | string | Recipient addresses separated by , or ; | jane.doe@somedomain.com | -| Cc | string | Cc recipient addresses separated by , or ; | jane.doe@somedomain.com | -| Bcc | string | Bcc recipient addresses separated by , or ; | jane.doe@somedomain.com | -| From | string | The email address the message is sent from | john.doe@somedomain.com | -| Sender Name | string | Name of the sender | Frends errors | -| Subject | string | Subject of the message | Hello Jane | -| Message | string | Body of the message | You've got mail! | -| Is message html | bool | Indicates whether the mail message body is in Html | false | -| Message encoding| string | Encoding of message body and subject. Use following table's name column for other options. https://msdn.microsoft.com/en-us/library/system.text.encoding(v=vs.110).aspx#Anchor_5 | utf-8 | - - -### Attachments - -Settings for included attachments - -| Property | Type | Description | Example | -| ---------------------| ---------------------| ------------------------------------ | ----- | -| Attachment type | enum { FileAttachment, AttachmentFromString } | Chooses if the attachment file is created from a string or copied from disk | FileAttachment | -| File content | string | Usable with Attachment type AttachmentFromString. Sets the content of the attachment file | Lorem ipsum... | -| File name | string | Usable with Attachment type AttachmentFromString. Sets the name of the attachment file | error.txt | -| File path | string | Usable with Attachment type FileAttachment. Attachment file's path. Uses Directory.GetFiles(string, string) as a pattern matching technique. See https://msdn.microsoft.com/en-us/library/wz42302f(v=vs.110).aspx. Exception: If the path ends in a directory, all files in that folder are added as attachments. | C:\\temp\\*.csv | -| Throw exception if attachment not found | bool | Usable with Attachment type FileAttachment. If set true and no files match the given path, an exception is thrown | true | -| Send if no attachments found | bool | Usable with Attachment type FileAttachment. If set true and no files match the given path, email will be sent nevertheless | false | - -### SMTP Settings - -Settings for connecting to SMTP server - -| Property | Type | Description | Example | -| ---------------------| ---------------------| ------------------------------------ | ----- | -| SMTP server | string | SMTP server address | smtp.somedomain.com | -| Port | int | SMTP server port | 25 | -| Use ssl| bool | Set this true if SMTP expects to be connected using SSL | false | -| Use windows authentication | bool | Set this true if you want to use windows authentication to authenticate to SMTP server | false | -| User name| string | Usable when windows authentication is set false. Use this username to log in to the SMTP server | user | -| Password | string | Usable when windows authentication is set false. Use this password to log in to the SMTP server | password | - - -## Returns - -| Property | Type | Description | Example | -| ---------------------| ---------------------| ------------------------------------ | ----- | -| EmailSent | bool | Returns true if email message has been sent | true | -| StatusString| string | Contains information about the task's result. | No attachments found matching path \"C:\\temp\\*.csv\". No email sent. | +You can install the Task via frends UI Task View. ## Building -Clone a copy of the repository - -`git clone https://github.com/FrendsPlatform/Frends.SMTP.git` - Rebuild the project `dotnet build` @@ -82,17 +24,3 @@ Run tests Create a NuGet package `dotnet pack --configuration Release` - -# Testing - -## Unit Tests - -Unit tests are run on each push and can be run manually by `dotnet test` command. - -## Integration Tests - -Integration tests in Frends.SMTP are run as part of unit test runs. - -## Performance Tests - -No performance tests are done in Frends.SMTP as the SMTP server itself is the main component during execution.