From e0a6615b52e3dad83207246578b76ebc0c6bd894 Mon Sep 17 00:00:00 2001 From: muhammedaltug Date: Wed, 16 Feb 2022 17:13:20 +0300 Subject: [PATCH 01/32] replace languageChange$ property to currentLang$ property of localization service at LocalizationService provide --- .../theme-basic/src/lib/tests/lazy-style.handler.spec.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/npm/ng-packs/packages/theme-basic/src/lib/tests/lazy-style.handler.spec.ts b/npm/ng-packs/packages/theme-basic/src/lib/tests/lazy-style.handler.spec.ts index dec4744a6c..dd0591f9fd 100644 --- a/npm/ng-packs/packages/theme-basic/src/lib/tests/lazy-style.handler.spec.ts +++ b/npm/ng-packs/packages/theme-basic/src/lib/tests/lazy-style.handler.spec.ts @@ -4,7 +4,7 @@ import { createServiceFactory, SpectatorService } from '@ngneat/spectator/jest'; import { of } from 'rxjs'; import { BOOTSTRAP, createLazyStyleHref, LazyStyleHandler } from '../handlers'; -const languageChange$ = of({ payload: 'en' }); +const currentLang$ = of({ payload: 'en' }); describe('LazyStyleHandler', () => { let spectator: SpectatorService; @@ -17,7 +17,7 @@ describe('LazyStyleHandler', () => { DocumentDirHandlerService, { provide: LocalizationService, - useValue: { currentLang: 'en', languageChange$ }, + useValue: { currentLang: 'en', currentLang$ }, }, ], }); From 7b44562c181aa08318d9a24b82cf15ad4f657572 Mon Sep 17 00:00:00 2001 From: Engincan VESKE Date: Wed, 16 Feb 2022 17:44:50 +0300 Subject: [PATCH 02/32] Add new localizations for admin.abp.io --- .../Admin/Localization/Resources/en.json | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/abp_io/AbpIoLocalization/AbpIoLocalization/Admin/Localization/Resources/en.json b/abp_io/AbpIoLocalization/AbpIoLocalization/Admin/Localization/Resources/en.json index 1db05cebaf..e5df75125e 100644 --- a/abp_io/AbpIoLocalization/AbpIoLocalization/Admin/Localization/Resources/en.json +++ b/abp_io/AbpIoLocalization/AbpIoLocalization/Admin/Localization/Resources/en.json @@ -365,6 +365,23 @@ "Amount": "Amount", "GenerateCustomPaymentLink": "Generate Custom Payment Link", "GeneratedPaymentLink": "Generated Payment Link", - "CopyText": "Copy Text" + "CopyText": "Copy Text", + "Permission:CommunityEvents": "Events", + "Menu:Events": "Events", + "Events": "Events", + "EventType": "Event Type", + "Number": "Number", + "RegistrationURL": "Registration URL", + "URL": "URL", + "EventDeletionConfirmationMessage": "Are you sure you want to delete this event?", + "Enum:EventType:0": "Community Talks", + "CreateAnEvent": "Create an event", + "Permission:CommunitySpeakers": "Speakers", + "CreateASpeaker": "Create a speaker", + "Speakers": "Speakers", + "Image": "Image", + "GithubURL": "Github URL", + "SpeakerDeletionConfirmationMessage": "Are you sure you want to delete this speaker?", + "Menu:Speakers": "Speakers" } } From f0689a3a8f70fc1f37539eaad55889bcce302381 Mon Sep 17 00:00:00 2001 From: Engincan VESKE Date: Fri, 18 Feb 2022 10:04:14 +0300 Subject: [PATCH 03/32] Add new localizations to base resources --- .../AbpIoLocalization/Base/Localization/Resources/en.json | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/abp_io/AbpIoLocalization/AbpIoLocalization/Base/Localization/Resources/en.json b/abp_io/AbpIoLocalization/AbpIoLocalization/Base/Localization/Resources/en.json index 8b84c3512e..85f764cac5 100644 --- a/abp_io/AbpIoLocalization/AbpIoLocalization/Base/Localization/Resources/en.json +++ b/abp_io/AbpIoLocalization/AbpIoLocalization/Base/Localization/Resources/en.json @@ -98,6 +98,10 @@ "EULA": "EULA", "ABPCommercialIntroductionMessage": "Pre-built application modules, advanced startup templates, rapid application development tooling, professional UI themes and premium support.", "MasteringAbpFrameworkEBook": "Mastering ABP Framework", - "MasteringTheABPFrameworkExplanation": "Written by the creator of the ABP Framework, this book will help you gain a complete understanding of the framework and modern web application development techniques." + "MasteringTheABPFrameworkExplanation": "Written by the creator of the ABP Framework, this book will help you gain a complete understanding of the framework and modern web application development techniques.", + "Speakers": "Speakers", + "PreviousEvents": "Previous Events", + "WatchTheEvent": "Watch the Event", + "RegisterNow": "Register Now" } } From b344154c6c41641a2a43a77f3b679a5604eb1415 Mon Sep 17 00:00:00 2001 From: liangshiwei Date: Fri, 18 Feb 2022 15:38:01 +0800 Subject: [PATCH 04/32] Fix Blazor-server depoly to sub app problem --- .../Themes/Basic/Components/Menu/Default.cshtml | 2 +- .../Themes/Basic/Components/Menu/_MenuItem.cshtml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/basic-theme/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic/Themes/Basic/Components/Menu/Default.cshtml b/modules/basic-theme/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic/Themes/Basic/Components/Menu/Default.cshtml index 0c73d85bb3..1ffdf2595e 100644 --- a/modules/basic-theme/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic/Themes/Basic/Components/Menu/Default.cshtml +++ b/modules/basic-theme/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic/Themes/Basic/Components/Menu/Default.cshtml @@ -5,7 +5,7 @@ var elementId = string.IsNullOrEmpty(menuItem.ElementId) ? string.Empty : $"id=\"{menuItem.ElementId}\""; var cssClass = string.IsNullOrEmpty(menuItem.CssClass) ? string.Empty : menuItem.CssClass; var disabled = menuItem.IsDisabled ? "disabled" : string.Empty; - var url = string.IsNullOrEmpty(menuItem.Url) ? "#" : Url.Content(menuItem.Url); + var url = string.IsNullOrEmpty(menuItem.Url) ? "#" : Url.IsLocalUrl(menuItem.Url) ? Url.Content(menuItem.Url.EnsureStartsWith('~')) : menuItem.Url; if (menuItem.IsLeaf) { if (menuItem.Url != null) diff --git a/modules/basic-theme/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic/Themes/Basic/Components/Menu/_MenuItem.cshtml b/modules/basic-theme/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic/Themes/Basic/Components/Menu/_MenuItem.cshtml index 8e9de286e5..2dc72b8e58 100644 --- a/modules/basic-theme/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic/Themes/Basic/Components/Menu/_MenuItem.cshtml +++ b/modules/basic-theme/src/Volo.Abp.AspNetCore.Mvc.UI.Theme.Basic/Themes/Basic/Components/Menu/_MenuItem.cshtml @@ -4,7 +4,7 @@ var elementId = string.IsNullOrEmpty(Model.ElementId) ? string.Empty : $"id=\"{Model.ElementId}\""; var cssClass = string.IsNullOrEmpty(Model.CssClass) ? string.Empty : Model.CssClass; var disabled = Model.IsDisabled ? "disabled" : string.Empty; - var url = string.IsNullOrEmpty(Model.Url) ? "#" : Url.Content(Model.Url); + var url = string.IsNullOrEmpty(Model.Url) ? "#" : Url.IsLocalUrl(Model.Url) ? Url.Content(Model.Url.EnsureStartsWith('~')) : Model.Url; } @if (Model.IsLeaf) { From c2d8e12fe44a6873f12a2ee0cda3acd862b68504 Mon Sep 17 00:00:00 2001 From: enisn Date: Fri, 18 Feb 2022 13:50:04 +0300 Subject: [PATCH 05/32] Updating PageLayout to notify when one of its members changed --- .../Layout/PageHeader.razor.cs | 6 +++-- .../Layout/PageLayout.cs | 23 +++++++++++++++---- 2 files changed, 22 insertions(+), 7 deletions(-) diff --git a/framework/src/Volo.Abp.AspNetCore.Components.Web.Theming/Layout/PageHeader.razor.cs b/framework/src/Volo.Abp.AspNetCore.Components.Web.Theming/Layout/PageHeader.razor.cs index 10fbc3bfb7..e69bd7437a 100644 --- a/framework/src/Volo.Abp.AspNetCore.Components.Web.Theming/Layout/PageHeader.razor.cs +++ b/framework/src/Volo.Abp.AspNetCore.Components.Web.Theming/Layout/PageHeader.razor.cs @@ -4,6 +4,8 @@ using System.Collections.Generic; using System.Threading.Tasks; using Volo.Abp.AspNetCore.Components.Web.Theming.PageToolbars; using Volo.Abp.BlazoriseUI; +using System.Linq; +using System.Collections.ObjectModel; namespace Volo.Abp.AspNetCore.Components.Web.Theming.Layout; @@ -30,8 +32,8 @@ public partial class PageHeader : ComponentBase [Parameter] // TODO: Consider removing this property in future and use only PageLayout. public List BreadcrumbItems { - get => PageLayout.BreadcrumbItems; - set => PageLayout.BreadcrumbItems = value; + get => PageLayout.BreadcrumbItems.ToList(); + set => PageLayout.BreadcrumbItems = new ObservableCollection(value); } [Parameter] diff --git a/framework/src/Volo.Abp.AspNetCore.Components.Web.Theming/Layout/PageLayout.cs b/framework/src/Volo.Abp.AspNetCore.Components.Web.Theming/Layout/PageLayout.cs index 9c0d89f70a..618445bd83 100644 --- a/framework/src/Volo.Abp.AspNetCore.Components.Web.Theming/Layout/PageLayout.cs +++ b/framework/src/Volo.Abp.AspNetCore.Components.Web.Theming/Layout/PageLayout.cs @@ -1,16 +1,29 @@ -using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.ComponentModel; using Volo.Abp.AspNetCore.Components.Web.Theming.PageToolbars; using Volo.Abp.BlazoriseUI; using Volo.Abp.DependencyInjection; namespace Volo.Abp.AspNetCore.Components.Web.Theming.Layout; -public class PageLayout : IScopedDependency +public class PageLayout : IScopedDependency, INotifyPropertyChanged { + private string title; + // TODO: Consider using this property for setting Page Title too. - public virtual string Title { get; set; } + public virtual string Title + { + get => title; + set + { + title = value; + PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(Title))); + } + } + + public virtual ObservableCollection BreadcrumbItems { get; set; } = new(); - public virtual List BreadcrumbItems { get; set; } = new(); + public virtual ObservableCollection ToolbarItems { get; set; } = new(); - public virtual List ToolbarItems { get; set; } = new(); + public event PropertyChangedEventHandler PropertyChanged; } \ No newline at end of file From a733fc27eb222746caa3a43b53239bfe0c9e226f Mon Sep 17 00:00:00 2001 From: enisn Date: Fri, 18 Feb 2022 14:05:19 +0300 Subject: [PATCH 06/32] Replace AddRange with foreach --- .../Layout/PageHeader.razor.cs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/framework/src/Volo.Abp.AspNetCore.Components.Web.Theming/Layout/PageHeader.razor.cs b/framework/src/Volo.Abp.AspNetCore.Components.Web.Theming/Layout/PageHeader.razor.cs index e69bd7437a..f38f433fa3 100644 --- a/framework/src/Volo.Abp.AspNetCore.Components.Web.Theming/Layout/PageHeader.razor.cs +++ b/framework/src/Volo.Abp.AspNetCore.Components.Web.Theming/Layout/PageHeader.razor.cs @@ -55,7 +55,10 @@ public partial class PageHeader : ComponentBase if (!Options.Value.RenderToolbar) { PageLayout.ToolbarItems.Clear(); - PageLayout.ToolbarItems.AddRange(toolbarItems); + foreach (var item in toolbarItems) + { + PageLayout.ToolbarItems.Add(item); + } return; } From dc67e836e0003ff0508ba8179d4ac9055533ae22 Mon Sep 17 00:00:00 2001 From: XiangYang <1029589450@qq.com> Date: Sun, 20 Feb 2022 00:46:51 +0800 Subject: [PATCH 07/32] Update Emailing.md --- docs/zh-Hans/Emailing.md | 258 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 256 insertions(+), 2 deletions(-) diff --git a/docs/zh-Hans/Emailing.md b/docs/zh-Hans/Emailing.md index d285e5bde2..23d62c5a20 100644 --- a/docs/zh-Hans/Emailing.md +++ b/docs/zh-Hans/Emailing.md @@ -1,3 +1,257 @@ -# Emailing +# 邮件发送系统 -待添加 \ No newline at end of file +ABP 框架为发送电子邮件提供各种服务、设置和集成; + +* 提供用于发送电子邮件的`IEmailSender`服务. +* 定义 [settings](Settings.md)来配置电子邮件发送. +* 集成到[后台作业系统](Background-Jobs.md)以通过后台作业发送电子邮件. +* 提供[MailKit 集成](MailKit.md)包. + +## 安装 + +> 如果您使用的是[应用程序启动模板](Startup-Templates/Application.md)，则该软件包已安装。 +> +建议使用 [ABP CLI](CLI.md) 安装此包。在项目文件夹（.csproj 文件）中打开命令行窗口并键入以下命令： + +````bash +abp add-package Volo.Abp.Emailing +```` +如果你还没有做到这一点，您首先需要安装 ABP CLI。有关其他安装选项，请参阅 [包描述页面](https://abp.io/package-detail/Volo.Abp.Emailing)。 + +## 发送电子邮件 + +### IEmailSender + +[Inject](Dependency-Injection.md) 将 `IEmailSender` 注入任何服务并使用 `SendAsync` 方法发送电子邮件。 +**Example** + +````csharp +using System.Threading.Tasks; +using Volo.Abp.DependencyInjection; +using Volo.Abp.Emailing; + +namespace MyProject +{ + public class MyService : ITransientDependency + { + private readonly IEmailSender _emailSender; + + public MyService(IEmailSender emailSender) + { + _emailSender = emailSender; + } + + public async Task DoItAsync() + { + await _emailSender.SendAsync( + "target@domain.com", // target email address + "Email subject", // subject + "This is email body..." // email body + ); + } + } +} +```` + +`SendAsync` 方法具有重载以提供更多参数，例如； + +* **from**:您可以将其设置为设置发件人电子邮件地址。如果未提供，则使用默认发件人地址（请参阅下面的电子邮件设置） +* **isBodyHtml**: 表示邮件正文是否可以包含HTML标签。**默认：true**。 + +> `IEmailSender` 是建议的发送邮件的方式，因为它使你的代码提供者独立。 + +#### 邮件消息 + +除了原始参数之外，您还可以传递一个**标准的 `MailMessage` 对象**（[参见](https://docs.microsoft.com/en-us/dotnet/api/system.net.mail.mailmessage) ) 到 `SendAsync` 方法以设置更多选项，例如添加附件。 + +### ISmtpEmailSender + +默认情况下，发送电子邮件由标准的 `SmtpClient` 类（[参见](https://docs.microsoft.com/en-us/dotnet/api/system.net.mail.smtpclient)）实现。实现类是`SmtpEmailSender`。此类还公开了 `ISmtpEmailSender` 服务（除了 `IEmailSender`）。 + +大多数时候你想直接使用`IEmailSender`来让你的代码提供者独立。但是，如果要创建具有相同电子邮件设置的 `SmtpClient` 对象，可以注入 `ISmtpEmailSender` 并使用其 `BuildClientAsync` 方法获取 `SmtpClient` 对象并自己发送电子邮件。 + +## 发送邮件任务队列/后台作业 + +`IEmailSender`有一个`QueueAsync`方法，可以用来将邮件添加到后台作业队列中，在后台线程中发送。通过这种方式，你不会因为等待发送邮件而占用用户的时间。`QueueAsync`方法得到的参数与`SendAsync`方法相同。 + +发送邮件任务队列可以容忍错误，因为后台作业系统具有重试机制来克服临时网络/服务器问题。 + +有关后台作业系统的更多信息，请参阅[后台作业文档](Background-Jobs.md)。 + +## 电子邮件设置 + +电子邮件发送使用 [设置系统](Settings.md) 来定义设置并在运行时获取这些设置的值。 `Volo.Abp.Emailing.EmailSettingNames` 定义了设置名称的常量，如下所示： + +* **Abp.Mailing.DefaultFromAddress**: 当您在发送电子邮件时未指定发件人时,用作发件人的电子邮件地址（就像上面的示例一样）. +* **Abp.Mailing.DefaultFromDisplayName**: 当您在发送电子邮件时未指定发件人时,用作发件人的显示名称（就像在上面的示例中一样）. +* **Abp.Mailing.Smtp.Host**: SMTP 服务器的 IP/域（默认值：127.0.0.1）。 +* **Abp.Mailing.Smtp.Port**: SMTP 服务器的端口（默认值：25）. +* **Abp.Mailing.Smtp.UserName**: 用户名，如果 SMTP 服务器需要身份验证需要。 +* **Abp.Mailing.Smtp.Password**: 密码，如果 SMTP 服务器需要身份验证需要。 **此值已加密**（请参阅下面的部分）. +* **Abp.Mailing.Smtp.Domain**: 账号域，如果 SMTP 服务器需要身份验证需要. +* **Abp.Mailing.Smtp.EnableSsl**: 指示 SMTP 服务器是否使用 SSL 的值（“true”或“false”。默认值：“false”）. +* **Abp.Mailing.Smtp.UseDefaultCredentials**:如果为 true，则使用默认凭据,而不是提供的用户名和密码（“true”或“false”。默认值：“true”）。. + +可以从[设置管理](Modules/Setting-Management.md)模块的*设置页面*管理电子邮件设置： + +![email-settings](images/email-settings.png) + +>如果您已从 ABP 启动模板创建解决方案，则已安装设置管理模块。 + +如果您不使用设置管理模块，您可以简单地在 `appsettings.json` 文件中定义设置： + +````json +"Settings": { + "Abp.Mailing.Smtp.Host": "127.0.0.1", + "Abp.Mailing.Smtp.Port": "25", + "Abp.Mailing.Smtp.UserName": "", + "Abp.Mailing.Smtp.Password": "", + "Abp.Mailing.Smtp.Domain": "", + "Abp.Mailing.Smtp.EnableSsl": "false", + "Abp.Mailing.Smtp.UseDefaultCredentials": "true", + "Abp.Mailing.DefaultFromAddress": "noreply@abp.io", + "Abp.Mailing.DefaultFromDisplayName": "ABP application" +} +```` + +You can set/change these settings programmatically using the `ISettingManager` and store values in a database. See the [setting system document](Settings.md) to understand the setting system better. +您可以使用 `ISettingManager` 以编程方式设置/更改这些设置，并将值存储在数据库中。请参阅 [设置系统文档](Settings.md)更好地了解设置系统。 + +### 加密 SMTP 密码 + +*Abp.Mailing.Smtp.Password* 必须是一个**加密**值。如果您使用 `ISettingManager` 设置密码，您不必担心。它在内部加密 set 上的值并在 get 上解密。 + +如果使用 `appsettings.json` 存储密码，则应手动注入 `ISettingEncryptionService` 并使用其 `Encrypt` 方法获取加密值。这可以通过在您的应用程序中创建一个简单的代码来完成。然后你可以删除代码。更好的是，您可以在应用程序中创建一个 UI 来配置电子邮件设置。在这种情况下，您可以直接使用 `ISettingManager` 而不用担心加密。 + +### ISmtpEmailSenderConfiguration + +如果您不想使用设置系统来存储电子邮件发送配置，您可以将 `ISmtpEmailSenderConfiguration` 服务替换为您自己的实现，以从任何其他来源获取配置。 `ISmtpEmailSenderConfiguration` 默认由 `SmtpEmailSenderConfiguration` 实现，如上所述，它从设置系统中获取配置。 + +## 文本模板集成 + +ABP 框架提供了一个强大而灵活的[文本模板系统](Text-Templating.md)。您可以使用文本模板系统来创建动态电子邮件内容。注入 `ITemplateRenderer` 并使用 `RenderAsync` 渲染模板。然后将结果用作电子邮件正文。 + +虽然您可以定义和使用自己的文本模板，但电子邮件发送系统提供了两个简单的内置文本模板。 + +**示例：使用标准和简单的消息模板发送电子邮件** + +````csharp +using System.Threading.Tasks; +using Volo.Abp.DependencyInjection; +using Volo.Abp.Emailing; +using Volo.Abp.Emailing.Templates; +using Volo.Abp.TextTemplating; + +namespace Acme.BookStore.Web +{ + public class MyService : ITransientDependency + { + private readonly IEmailSender _emailSender; + private readonly ITemplateRenderer _templateRenderer; + + public MyService( + IEmailSender emailSender, + ITemplateRenderer templateRenderer) + { + _emailSender = emailSender; + _templateRenderer = templateRenderer; + } + + public async Task DoItAsync() + { + var body = await _templateRenderer.RenderAsync( + StandardEmailTemplates.Message, + new + { + message = "This is email body..." + } + ); + + await _emailSender.SendAsync( + "target-address@domain.com", + "Email subject", + body + ); + } + } +} +```` + +生成的电子邮件正文将如下所示： + +````html + + + + + + + This is email body... + + +```` + +电子邮件系统定义了具有给定名称的内置文本模板： + +"**Abp.StandardEmailTemplates.Message**" 是最简单的带有文本消息的模板： + +````html +{%{{{model.message}}}%} +```` + +此模板使用“Abp.StandardEmailTemplates.Layout”作为其布局. + +"**Abp.StandardEmailTemplates.Layout**" 是一个提供 HTML 文档布局的简单模板： + +````html + + + + + + + {%{{{content}}}%} + + +```` + +最终呈现的消息如上所示。 + +> 这些模板名称是在 `Volo.Abp.Emailing.Templates.StandardEmailTemplates` 类中定义的。 + +### 覆盖/替换标准模板 + +You typically want to replace the standard templates with your own ones, so you can prepare a branded email messages. To do that, you can use the power of the [virtual file system](Virtual-File-System.md) (VFS) or replace them in your own template definition provider. +您希望用自己的模板替换标准模板，这样您就可以准备电子邮件模板文件。您可以使用 [虚拟文件系统](Virtual-File-System.md) (VFS),或在您自己的模板定义提供程序中替换它们。 + +虚拟文件系统中模板的路径如下图所示： + +* `/Volo/Abp/Emailing/Templates/Layout.tpl` +* `/Volo/Abp/Emailing/Templates/Message.tpl` + +如果您将文件添加到虚拟文件系统中的相同位置，您的文件将覆盖它们。 + +模板是内联本地化的，这意味着您可以利用 [本地化系统](Localization.md) 的强大功能使您的模板具有多元文化。 + +详见[文本模板系统](Text-Templating.md) 文档。 + +> 请注意，您可以为应用程序定义和使用自己的模板，而不是使用标准的简单模板。这些标准模板主要用于可重用的模块，它们不定义自己的模板，而是依赖内置的模板。只需覆盖标准的电子邮件布局模板，就可以轻松自定义使用的模块发送的电子邮件。 + +## NullEmailSender + +`NullEmailSender` 是实现 `IEmailSender` 的内置类，但将电子邮件内容写入 [标准日志系统](Logging.md)，而不是实际发送电子邮件。 + +这个类特别有用，尤其是在您开发是不想发送真实电子邮件。 [应用启动模板](Startup-Templates/Application.md)已经在**DEBUG模式**中使用了这个类，在领域层配置如下： + +````csharp +#if DEBUG + context.Services.Replace(ServiceDescriptor.Singleton()); +#endif +```` + +So, don't confuse if you don't receive emails on DEBUG mode. Emails will be sent as expected on production (RELEASE mode). Remove these lines if you want to send real emails on DEBUG too. +因此，如果您在 DEBUG 模式下没有收到电子邮件，请不要紧张。电子邮件将在生产时按预期发送（RELEASE 模式）。如果您也想在 DEBUG 上发送真实电子邮件，请删除这些行。 + +## 其他 + +* [用于发送电子邮件的MailKit集成](MailKit.md) From 119e1098815ad8d9e143906561a80ec6ab1ef522 Mon Sep 17 00:00:00 2001 From: Cyril-hcj <31679398+Cyril-hcj@users.noreply.github.com> Date: Sun, 20 Feb 2022 14:15:49 +0800 Subject: [PATCH 08/32] Fix namespace --- docs/zh-Hans/Tutorials/Part-1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh-Hans/Tutorials/Part-1.md b/docs/zh-Hans/Tutorials/Part-1.md index 3ff216fb76..e006c2ab15 100644 --- a/docs/zh-Hans/Tutorials/Part-1.md +++ b/docs/zh-Hans/Tutorials/Part-1.md @@ -285,7 +285,7 @@ namespace Acme.BookStore using System; using Volo.Abp.Application.Dtos; -namespace Acme.BookStore +namespace Acme.BookStore.Books { public class BookDto : AuditedEntityDto { From 14ef89c881d419161512b68a17518f92da935479 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Halil=20=C4=B0brahim=20Kalkan?= Date: Sun, 20 Feb 2022 19:51:50 +0300 Subject: [PATCH 09/32] Update Previews.md --- docs/en/Previews.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/Previews.md b/docs/en/Previews.md index 5d52a4ad69..61cf1c9226 100644 --- a/docs/en/Previews.md +++ b/docs/en/Previews.md @@ -1,6 +1,6 @@ # Preview Releases -The preview versions are released **~2 weeks before** releasing a major or feature version of the ABP Framework. They are released for developers to try and provide feedback to have more stable versions. +The preview versions are released **~4 weeks before** releasing a major or feature version of the ABP Framework. They are released for developers to try and provide feedback to have more stable versions. Versioning of a preview release is like that: @@ -37,4 +37,4 @@ abp switch-to-stable ## Providing Feedback -You can open an issue on the [GitHub repository](https://github.com/abpframework/abp/issues/new), if you find a bug or want to provide any kind of feedback. \ No newline at end of file +You can open an issue on the [GitHub repository](https://github.com/abpframework/abp/issues/new), if you find a bug or want to provide any kind of feedback. From 39272f385230abd59f909c51c6e887ad8b0b4293 Mon Sep 17 00:00:00 2001 From: maliming Date: Mon, 21 Feb 2022 08:39:45 +0800 Subject: [PATCH 10/32] Update Emailing.md --- docs/zh-Hans/Emailing.md | 41 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/docs/zh-Hans/Emailing.md b/docs/zh-Hans/Emailing.md index 23d62c5a20..22edc50301 100644 --- a/docs/zh-Hans/Emailing.md +++ b/docs/zh-Hans/Emailing.md @@ -9,14 +9,14 @@ ABP 框架为发送电子邮件提供各种服务、设置和集成; ## 安装 -> 如果您使用的是[应用程序启动模板](Startup-Templates/Application.md)，则该软件包已安装。 +> 如果你使用的是[应用程序启动模板](Startup-Templates/Application.md)，则该软件包已安装。 > 建议使用 [ABP CLI](CLI.md) 安装此包。在项目文件夹（.csproj 文件）中打开命令行窗口并键入以下命令： ````bash abp add-package Volo.Abp.Emailing ```` -如果你还没有做到这一点，您首先需要安装 ABP CLI。有关其他安装选项，请参阅 [包描述页面](https://abp.io/package-detail/Volo.Abp.Emailing)。 +如果你还没有做到这一点，你首先需要安装 ABP CLI。有关其他安装选项，请参阅 [包描述页面](https://abp.io/package-detail/Volo.Abp.Emailing)。 ## 发送电子邮件 @@ -55,14 +55,14 @@ namespace MyProject `SendAsync` 方法具有重载以提供更多参数，例如； -* **from**:您可以将其设置为设置发件人电子邮件地址。如果未提供，则使用默认发件人地址（请参阅下面的电子邮件设置） +* **from**: 你可以将其设置为设置发件人电子邮件地址。如果未提供，则使用默认发件人地址（请参阅下面的电子邮件设置） * **isBodyHtml**: 表示邮件正文是否可以包含HTML标签。**默认：true**。 > `IEmailSender` 是建议的发送邮件的方式，因为它使你的代码提供者独立。 #### 邮件消息 -除了原始参数之外，您还可以传递一个**标准的 `MailMessage` 对象**（[参见](https://docs.microsoft.com/en-us/dotnet/api/system.net.mail.mailmessage) ) 到 `SendAsync` 方法以设置更多选项，例如添加附件。 +除了原始参数之外，你还可以传递一个**标准的 `MailMessage` 对象**（[参见](https://docs.microsoft.com/en-us/dotnet/api/system.net.mail.mailmessage) ) 到 `SendAsync` 方法以设置更多选项，例如添加附件。 ### ISmtpEmailSender @@ -82,8 +82,8 @@ namespace MyProject 电子邮件发送使用 [设置系统](Settings.md) 来定义设置并在运行时获取这些设置的值。 `Volo.Abp.Emailing.EmailSettingNames` 定义了设置名称的常量，如下所示： -* **Abp.Mailing.DefaultFromAddress**: 当您在发送电子邮件时未指定发件人时,用作发件人的电子邮件地址（就像上面的示例一样）. -* **Abp.Mailing.DefaultFromDisplayName**: 当您在发送电子邮件时未指定发件人时,用作发件人的显示名称（就像在上面的示例中一样）. +* **Abp.Mailing.DefaultFromAddress**: 当你在发送电子邮件时未指定发件人时,用作发件人的电子邮件地址（就像上面的示例一样）. +* **Abp.Mailing.DefaultFromDisplayName**: 当你在发送电子邮件时未指定发件人时,用作发件人的显示名称（就像在上面的示例中一样）. * **Abp.Mailing.Smtp.Host**: SMTP 服务器的 IP/域（默认值：127.0.0.1）。 * **Abp.Mailing.Smtp.Port**: SMTP 服务器的端口（默认值：25）. * **Abp.Mailing.Smtp.UserName**: 用户名，如果 SMTP 服务器需要身份验证需要。 @@ -96,9 +96,9 @@ namespace MyProject ![email-settings](images/email-settings.png) ->如果您已从 ABP 启动模板创建解决方案，则已安装设置管理模块。 +>如果你已从 ABP 启动模板创建解决方案，则已安装设置管理模块。 -如果您不使用设置管理模块，您可以简单地在 `appsettings.json` 文件中定义设置： +如果你不使用设置管理模块，你可以简单地在 `appsettings.json` 文件中定义设置： ````json "Settings": { @@ -115,23 +115,23 @@ namespace MyProject ```` You can set/change these settings programmatically using the `ISettingManager` and store values in a database. See the [setting system document](Settings.md) to understand the setting system better. -您可以使用 `ISettingManager` 以编程方式设置/更改这些设置，并将值存储在数据库中。请参阅 [设置系统文档](Settings.md)更好地了解设置系统。 +你可以使用 `ISettingManager` 以编程方式设置/更改这些设置，并将值存储在数据库中。请参阅 [设置系统文档](Settings.md)更好地了解设置系统。 ### 加密 SMTP 密码 -*Abp.Mailing.Smtp.Password* 必须是一个**加密**值。如果您使用 `ISettingManager` 设置密码，您不必担心。它在内部加密 set 上的值并在 get 上解密。 +*Abp.Mailing.Smtp.Password* 必须是一个**加密**值。如果你使用 `ISettingManager` 设置密码，你不必担心。它在内部加密 set 上的值并在 get 上解密。 -如果使用 `appsettings.json` 存储密码，则应手动注入 `ISettingEncryptionService` 并使用其 `Encrypt` 方法获取加密值。这可以通过在您的应用程序中创建一个简单的代码来完成。然后你可以删除代码。更好的是，您可以在应用程序中创建一个 UI 来配置电子邮件设置。在这种情况下，您可以直接使用 `ISettingManager` 而不用担心加密。 +如果使用 `appsettings.json` 存储密码，则应手动注入 `ISettingEncryptionService` 并使用其 `Encrypt` 方法获取加密值。这可以通过在你的应用程序中创建一个简单的代码来完成。然后你可以删除代码。更好的是，你可以在应用程序中创建一个 UI 来配置电子邮件设置。在这种情况下，你可以直接使用 `ISettingManager` 而不用担心加密。 ### ISmtpEmailSenderConfiguration -如果您不想使用设置系统来存储电子邮件发送配置，您可以将 `ISmtpEmailSenderConfiguration` 服务替换为您自己的实现，以从任何其他来源获取配置。 `ISmtpEmailSenderConfiguration` 默认由 `SmtpEmailSenderConfiguration` 实现，如上所述，它从设置系统中获取配置。 +如果你不想使用设置系统来存储电子邮件发送配置，你可以将 `ISmtpEmailSenderConfiguration` 服务替换为你自己的实现，以从任何其他来源获取配置。 `ISmtpEmailSenderConfiguration` 默认由 `SmtpEmailSenderConfiguration` 实现，如上所述，它从设置系统中获取配置。 ## 文本模板集成 -ABP 框架提供了一个强大而灵活的[文本模板系统](Text-Templating.md)。您可以使用文本模板系统来创建动态电子邮件内容。注入 `ITemplateRenderer` 并使用 `RenderAsync` 渲染模板。然后将结果用作电子邮件正文。 +ABP 框架提供了一个强大而灵活的[文本模板系统](Text-Templating.md)。你可以使用文本模板系统来创建动态电子邮件内容。注入 `ITemplateRenderer` 并使用 `RenderAsync` 渲染模板。然后将结果用作电子邮件正文。 -虽然您可以定义和使用自己的文本模板，但电子邮件发送系统提供了两个简单的内置文本模板。 +虽然你可以定义和使用自己的文本模板，但电子邮件发送系统提供了两个简单的内置文本模板。 **示例：使用标准和简单的消息模板发送电子邮件** @@ -222,26 +222,26 @@ namespace Acme.BookStore.Web ### 覆盖/替换标准模板 You typically want to replace the standard templates with your own ones, so you can prepare a branded email messages. To do that, you can use the power of the [virtual file system](Virtual-File-System.md) (VFS) or replace them in your own template definition provider. -您希望用自己的模板替换标准模板，这样您就可以准备电子邮件模板文件。您可以使用 [虚拟文件系统](Virtual-File-System.md) (VFS),或在您自己的模板定义提供程序中替换它们。 +你希望用自己的模板替换标准模板，这样你就可以准备电子邮件模板文件。你可以使用 [虚拟文件系统](Virtual-File-System.md) (VFS),或在你自己的模板定义提供程序中替换它们。 虚拟文件系统中模板的路径如下图所示： * `/Volo/Abp/Emailing/Templates/Layout.tpl` * `/Volo/Abp/Emailing/Templates/Message.tpl` -如果您将文件添加到虚拟文件系统中的相同位置，您的文件将覆盖它们。 +如果你将文件添加到虚拟文件系统中的相同位置，你的文件将覆盖它们。 -模板是内联本地化的，这意味着您可以利用 [本地化系统](Localization.md) 的强大功能使您的模板具有多元文化。 +模板是内联本地化的，这意味着你可以利用 [本地化系统](Localization.md) 的强大功能使你的模板具有多元文化。 详见[文本模板系统](Text-Templating.md) 文档。 -> 请注意，您可以为应用程序定义和使用自己的模板，而不是使用标准的简单模板。这些标准模板主要用于可重用的模块，它们不定义自己的模板，而是依赖内置的模板。只需覆盖标准的电子邮件布局模板，就可以轻松自定义使用的模块发送的电子邮件。 +> 请注意，你可以为应用程序定义和使用自己的模板，而不是使用标准的简单模板。这些标准模板主要用于可重用的模块，它们不定义自己的模板，而是依赖内置的模板。只需覆盖标准的电子邮件布局模板，就可以轻松自定义使用的模块发送的电子邮件。 ## NullEmailSender `NullEmailSender` 是实现 `IEmailSender` 的内置类，但将电子邮件内容写入 [标准日志系统](Logging.md)，而不是实际发送电子邮件。 -这个类特别有用，尤其是在您开发是不想发送真实电子邮件。 [应用启动模板](Startup-Templates/Application.md)已经在**DEBUG模式**中使用了这个类，在领域层配置如下： +这个类特别有用，尤其是在你开发是不想发送真实电子邮件。 [应用启动模板](Startup-Templates/Application.md)已经在**DEBUG模式**中使用了这个类，在领域层配置如下： ````csharp #if DEBUG @@ -249,8 +249,7 @@ You typically want to replace the standard templates with your own ones, so you #endif ```` -So, don't confuse if you don't receive emails on DEBUG mode. Emails will be sent as expected on production (RELEASE mode). Remove these lines if you want to send real emails on DEBUG too. -因此，如果您在 DEBUG 模式下没有收到电子邮件，请不要紧张。电子邮件将在生产时按预期发送（RELEASE 模式）。如果您也想在 DEBUG 上发送真实电子邮件，请删除这些行。 +因此，你在 DEBUG 模式下不会收到电子邮件。电子邮件将在生产时按预期发送（RELEASE 模式）。如果你也想在 DEBUG 上发送电子邮件，请删除这些行。 ## 其他 From a919f8aa9221cf610e5f44fb30e93dd2f93e806d Mon Sep 17 00:00:00 2001 From: liangshiwei Date: Mon, 21 Feb 2022 09:42:39 +0800 Subject: [PATCH 11/32] Update document --- docs/en/Tutorials/Part-1.md | 2 +- docs/en/Tutorials/Part-10.md | 2 +- docs/en/Tutorials/Part-7.md | 2 +- docs/zh-Hans/Tutorials/Part-1.md | 2 +- docs/zh-Hans/Tutorials/Part-7.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/en/Tutorials/Part-1.md b/docs/en/Tutorials/Part-1.md index 93bf3d4a0b..ef1c58346a 100644 --- a/docs/en/Tutorials/Part-1.md +++ b/docs/en/Tutorials/Part-1.md @@ -202,7 +202,7 @@ This will add a new migration class to the project: ![bookstore-efcore-migration](./images/bookstore-efcore-migration.png) -> If you are using Visual Studio, you may want to use the `Add-Migration Created_Book_Entity -c BookStoreMigrationsDbContext` and `Update-Database -c BookStoreMigrationsDbContext` commands in the *Package Manager Console (PMC)*. In this case, ensure that {{if UI=="MVC"}}`Acme.BookStore.Web`{{else if UI=="BlazorServer"}}`Acme.BookStore.Blazor`{{else if UI=="Blazor" || UI=="NG"}}`Acme.BookStore.HttpApi.Host`{{end}} is the startup project and `Acme.BookStore.EntityFrameworkCore` is the *Default Project* in PMC. +> If you are using Visual Studio, you may want to use the `Add-Migration Created_Book_Entity -c BookStoreDbContext` and `Update-Database -ContextBookStoreDbContext` commands in the *Package Manager Console (PMC)*. In this case, ensure that {{if UI=="MVC"}}`Acme.BookStore.Web`{{else if UI=="BlazorServer"}}`Acme.BookStore.Blazor`{{else if UI=="Blazor" || UI=="NG"}}`Acme.BookStore.HttpApi.Host`{{end}} is the startup project and `Acme.BookStore.EntityFrameworkCore` is the *Default Project* in PMC. {{end}} diff --git a/docs/en/Tutorials/Part-10.md b/docs/en/Tutorials/Part-10.md index 58ed534746..9cac74f872 100644 --- a/docs/en/Tutorials/Part-10.md +++ b/docs/en/Tutorials/Part-10.md @@ -126,7 +126,7 @@ migrationBuilder.AddForeignKey( * Creates an index on the `AuthorId` field. * Declares the foreign key to the `AppAuthors` table. -> If you are using Visual Studio, you may want to use `Add-Migration Added_AuthorId_To_Book -c BookStoreMigrationsDbContext` and `Update-Database -c BookStoreMigrationsDbContext` commands in the *Package Manager Console (PMC)*. In this case, ensure that {{if UI=="MVC"}}`Acme.BookStore.Web`{{else if UI=="BlazorServer"}}`Acme.BookStore.Blazor`{{else if UI=="Blazor" || UI=="NG"}}`Acme.BookStore.HttpApi.Host`{{end}} is the startup project and `Acme.BookStore.EntityFrameworkCore` is the *Default Project* in PMC. +> If you are using Visual Studio, you may want to use `Add-Migration Added_AuthorId_To_Book -c BookStoreDbContext` and `Update-Database -ContextBookStoreDbContext` commands in the *Package Manager Console (PMC)*. In this case, ensure that {{if UI=="MVC"}}`Acme.BookStore.Web`{{else if UI=="BlazorServer"}}`Acme.BookStore.Blazor`{{else if UI=="Blazor" || UI=="NG"}}`Acme.BookStore.HttpApi.Host`{{end}} is the startup project and `Acme.BookStore.EntityFrameworkCore` is the *Default Project* in PMC. {{end}} diff --git a/docs/en/Tutorials/Part-7.md b/docs/en/Tutorials/Part-7.md index 3284ae98d4..06f06e3f72 100644 --- a/docs/en/Tutorials/Part-7.md +++ b/docs/en/Tutorials/Part-7.md @@ -93,7 +93,7 @@ You can apply changes to the database using the following command, in the same c dotnet ef database update ```` -> If you are using Visual Studio, you may want to use `Add-Migration Added_Authors -c BookStoreMigrationsDbContext` and `Update-Database -c BookStoreMigrationsDbContext` commands in the *Package Manager Console (PMC)*. In this case, ensure that {{if UI=="MVC"}}`Acme.BookStore.Web`{{else if UI=="BlazorServer"}}`Acme.BookStore.Blazor`{{else if UI=="Blazor" || UI=="NG"}}`Acme.BookStore.HttpApi.Host`{{end}} is the startup project and `Acme.BookStore.EntityFrameworkCore` is the *Default Project* in PMC. +> If you are using Visual Studio, you may want to use `Add-Migration Added_Authors -c BookStoreDbContext` and `Update-Database -ContextBookStoreDbContext` commands in the *Package Manager Console (PMC)*. In this case, ensure that {{if UI=="MVC"}}`Acme.BookStore.Web`{{else if UI=="BlazorServer"}}`Acme.BookStore.Blazor`{{else if UI=="Blazor" || UI=="NG"}}`Acme.BookStore.HttpApi.Host`{{end}} is the startup project and `Acme.BookStore.EntityFrameworkCore` is the *Default Project* in PMC. {{else if DB=="Mongo"}} diff --git a/docs/zh-Hans/Tutorials/Part-1.md b/docs/zh-Hans/Tutorials/Part-1.md index 99f9939f30..b06643c7c0 100644 --- a/docs/zh-Hans/Tutorials/Part-1.md +++ b/docs/zh-Hans/Tutorials/Part-1.md @@ -202,7 +202,7 @@ dotnet ef migrations add Created_Book_Entity ![bookstore-efcore-migration](./images/bookstore-efcore-migration.png) -> 如果你使用Visual Studio, 你也许想要在*包管理控制台(PMC)*中使用 `Add-Migration Created_Book_Entity -c BookStoreMigrationsDbContext` 和 `Update-Database -c BookStoreMigrationsDbContext` 命令. 确保 {{if UI=="MVC"}}`Acme.BookStore.Web`{{else if UI=="BlazorServer"}}`Acme.BookStore.Blazor`{{else if UI=="Blazor" || UI=="NG"}}`Acme.BookStore.HttpApi.Host`{{end}} 是启动项目并且 `Acme.BookStore.EntityFrameworkCore.DbMigrations` 是 PMC 的*默认项目*. +> 如果你使用Visual Studio, 你也许想要在*包管理控制台(PMC)*中使用 `Add-Migration Created_Book_Entity -c BookStoreDbContext` 和 `Update-Database -Context BookStoreDbContext` 命令. 确保 {{if UI=="MVC"}}`Acme.BookStore.Web`{{else if UI=="BlazorServer"}}`Acme.BookStore.Blazor`{{else if UI=="Blazor" || UI=="NG"}}`Acme.BookStore.HttpApi.Host`{{end}} 是启动项目并且 `Acme.BookStore.EntityFrameworkCore.DbMigrations` 是 PMC 的*默认项目*. {{end}} diff --git a/docs/zh-Hans/Tutorials/Part-7.md b/docs/zh-Hans/Tutorials/Part-7.md index 95b016e451..d799b9ab4f 100644 --- a/docs/zh-Hans/Tutorials/Part-7.md +++ b/docs/zh-Hans/Tutorials/Part-7.md @@ -93,7 +93,7 @@ dotnet ef migrations add Added_Authors dotnet ef database update ```` -> 如果你使用 Visual Studio, 可能希望在 *Package Manager Console (PMC)* 使用 `Add-Migration Added_Authors -c BookStoreMigrationsDbContext` 和 `Update-Database -c BookStoreMigrationsDbContext` 命令. 如果这样, 保证 {{if UI=="MVC"}}`Acme.BookStore.Web`{{else if UI=="BlazorServer"}}`Acme.BookStore.Blazor`{{else if UI=="Blazor" || UI=="NG"}}`Acme.BookStore.HttpApi.Host`{{end}} 是启动项目并且在PMC中 `Acme.BookStore.EntityFrameworkCore` 是 *默认项目* . +> 如果你使用 Visual Studio, 可能希望在 *Package Manager Console (PMC)* 使用 `Add-Migration Added_Authors -c BookStoreDbContext` 和 `Update-Database -Context BookStoreDbContext` 命令. 如果这样, 保证 {{if UI=="MVC"}}`Acme.BookStore.Web`{{else if UI=="BlazorServer"}}`Acme.BookStore.Blazor`{{else if UI=="Blazor" || UI=="NG"}}`Acme.BookStore.HttpApi.Host`{{end}} 是启动项目并且在PMC中 `Acme.BookStore.EntityFrameworkCore` 是 *默认项目* . {{else if DB=="Mongo"}} From 1e222594d782b4c15995a791dcd863328636cd1b Mon Sep 17 00:00:00 2001 From: XiangYang <1029589450@qq.com> Date: Mon, 21 Feb 2022 10:23:31 +0800 Subject: [PATCH 12/32] Update MailKit.md --- docs/zh-Hans/MailKit.md | 52 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 51 insertions(+), 1 deletion(-) diff --git a/docs/zh-Hans/MailKit.md b/docs/zh-Hans/MailKit.md index cb82a640d5..aa486cdee4 100644 --- a/docs/zh-Hans/MailKit.md +++ b/docs/zh-Hans/MailKit.md @@ -1 +1,51 @@ -TODO... \ No newline at end of file +# MailKit 集成 + +[MailKit](http://www.mimekit.net/) 是一个用于 .net 的跨平台、流行的开源邮件客户端库。ABP 框架提供了一个集成包来使用 MailKit 作为[邮件发送系统](Emailing.md)的收发组件. + +## 安装 + +建议使用 [ABP CLI](CLI.md) 安装此包。在项目文件夹（.csproj 文件）中打开命令行窗口并键入以下命令： + +````bash +abp add-package Volo.Abp.MailKit +```` + +If you haven't done it yet, you first need to install the ABP CLI. For other installation options, see [the package description page](https://abp.io/package-detail/Volo.Abp.MailKit). + +如果执行失败,您首先需要安装 ABP CLI。有关其他安装选项，请参阅 [包描述页面](https://abp.io/package-detail/Volo.Abp.MailKit)。 + +## 发送电子邮件 + +### IEmailSender + +[注入](Dependency-Injection.md) 标准的 `IEmailSender` 到任何服务并使用 `SendAsync` 方法发送电子邮件。详见 [邮件发送文档](Emailing.md). + +> `IEmailSender` 是建议的发送邮件的方式，即使你使用MailKit，因为它使你的代码独立. + +### IMailKitSmtpEmailSender + +`BuildClientAsync()` 方法扩展了`IEmailSender`。此方法可用于获取可用于执行 MailKit 特定操作的“MailKit.Net.Smtp.SmtpClient”对象。 + +## 配置 + +MailKit 集成包使用电子邮件发送系统相同配置选项。请参阅[电子邮件发送文档](Emailing.md) 进行配置。 + +In addition to the standard settings, this package defines `AbpMailKitOptions` as a simple [options](Options.md) class. This class defines only one options: +除了标准设置之外，这个包还定义了 `AbpMailKitOptions` 作为一个简单的 [选项](Options.md) 类。此类仅定义一个选项： + +* **SecureSocketOption**:用于设置“SecureSocketOptions” . Default：`null`（使用默认值） + +**示例: 使用 *SecureSocketOptions.SslOnConnect*** + +````csharp +Configure(options => +{ + options.SecureSocketOption = SecureSocketOptions.SslOnConnect; +}); +```` + +请参阅 [MailKit 文档](http://www.mimekit.net/) 以了解有关此选项的更多信息。 + +## 也可以看看 + +* [电子邮件发送系统](Emailing.md) From 3d21e9db9a13ae5aea2d908ac241f601447d2643 Mon Sep 17 00:00:00 2001 From: liangshiwei Date: Mon, 21 Feb 2022 16:20:50 +0800 Subject: [PATCH 13/32] Update document --- docs/zh-Hans/Tutorials/Part-10.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh-Hans/Tutorials/Part-10.md b/docs/zh-Hans/Tutorials/Part-10.md index e6170dba9e..170e3106a1 100644 --- a/docs/zh-Hans/Tutorials/Part-10.md +++ b/docs/zh-Hans/Tutorials/Part-10.md @@ -126,7 +126,7 @@ migrationBuilder.AddForeignKey( * 根据 `AuthorId` 字段新建一个索引. * 声明到 `AppAuthors` 表的外键. -> 如果你使用 Visual Studio, 可能希望在 *Package Manager Console (PMC)* 使用 `Add-Migration Added_AuthorId_To_Book -c BookStoreMigrationsDbContext` 和 `Update-Database -c BookStoreMigrationsDbContext` 命令. 如果这样, 保证 {{if UI=="MVC"}}`Acme.BookStore.Web`{{else if UI=="BlazorServer"}}`Acme.BookStore.Blazor`{{else if UI=="Blazor" || UI=="NG"}}`Acme.BookStore.HttpApi.Host`{{end}} 是启动项目并且在PMC中 `Acme.BookStore.EntityFrameworkCore` 是 *默认项目* . +> 如果你使用 Visual Studio, 可能希望在 *Package Manager Console (PMC)* 使用 `Add-Migration Added_AuthorId_To_Book -c BookStoreDbContext` 和 `Update-Database -Context BookStoreDbContext` 命令. 如果这样, 保证 {{if UI=="MVC"}}`Acme.BookStore.Web`{{else if UI=="BlazorServer"}}`Acme.BookStore.Blazor`{{else if UI=="Blazor" || UI=="NG"}}`Acme.BookStore.HttpApi.Host`{{end}} 是启动项目并且在PMC中 `Acme.BookStore.EntityFrameworkCore` 是 *默认项目* . {{end}} From e76e4883912c0adbb2e438270a3bff7f337f75e3 Mon Sep 17 00:00:00 2001 From: liangshiwei Date: Mon, 21 Feb 2022 16:27:23 +0800 Subject: [PATCH 14/32] Update MailKit.md --- docs/zh-Hans/MailKit.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/docs/zh-Hans/MailKit.md b/docs/zh-Hans/MailKit.md index aa486cdee4..0adb88c85f 100644 --- a/docs/zh-Hans/MailKit.md +++ b/docs/zh-Hans/MailKit.md @@ -1,37 +1,34 @@ # MailKit 集成 -[MailKit](http://www.mimekit.net/) 是一个用于 .net 的跨平台、流行的开源邮件客户端库。ABP 框架提供了一个集成包来使用 MailKit 作为[邮件发送系统](Emailing.md)的收发组件. +[MailKit](http://www.mimekit.net/) 是一个用于 .net 的跨平台、流行的开源邮件客户端库.ABP 框架提供了一个集成包来使用 MailKit 作为[邮件发送系统](Emailing.md)的收发组件. ## 安装 -建议使用 [ABP CLI](CLI.md) 安装此包。在项目文件夹（.csproj 文件）中打开命令行窗口并键入以下命令： +建议使用 [ABP CLI](CLI.md) 安装包.在项目文件夹（.csproj 文件）中打开命令行窗口并键入以下命令： ````bash abp add-package Volo.Abp.MailKit ```` -If you haven't done it yet, you first need to install the ABP CLI. For other installation options, see [the package description page](https://abp.io/package-detail/Volo.Abp.MailKit). - -如果执行失败,您首先需要安装 ABP CLI。有关其他安装选项，请参阅 [包描述页面](https://abp.io/package-detail/Volo.Abp.MailKit)。 +如果执行失败,你首先需要安装 ABP CLI.有关其他安装选项,请参阅 [包描述页面](https://abp.io/package-detail/Volo.Abp.MailKit). ## 发送电子邮件 ### IEmailSender -[注入](Dependency-Injection.md) 标准的 `IEmailSender` 到任何服务并使用 `SendAsync` 方法发送电子邮件。详见 [邮件发送文档](Emailing.md). +[注入](Dependency-Injection.md) 标准的 `IEmailSender` 到任何服务并使用 `SendAsync` 方法发送电子邮件.详见 [邮件发送文档](Emailing.md). -> `IEmailSender` 是建议的发送邮件的方式，即使你使用MailKit，因为它使你的代码独立. +> `IEmailSender` 是建议的发送邮件的方式,即使你使用MailKit,因为它使你的代码独立. ### IMailKitSmtpEmailSender -`BuildClientAsync()` 方法扩展了`IEmailSender`。此方法可用于获取可用于执行 MailKit 特定操作的“MailKit.Net.Smtp.SmtpClient”对象。 +`BuildClientAsync()` 方法扩展了`IEmailSender`.此方法可用于获取可用于执行 MailKit 特定操作的`MailKit.Net.Smtp.SmtpClient`对象. ## 配置 -MailKit 集成包使用电子邮件发送系统相同配置选项。请参阅[电子邮件发送文档](Emailing.md) 进行配置。 +MailKit 集成包使用电子邮件发送系统相同配置选项.请参阅[电子邮件发送文档](Emailing.md) 进行配置. -In addition to the standard settings, this package defines `AbpMailKitOptions` as a simple [options](Options.md) class. This class defines only one options: -除了标准设置之外，这个包还定义了 `AbpMailKitOptions` 作为一个简单的 [选项](Options.md) 类。此类仅定义一个选项： +除了标准设置之外,这个包还定义了 `AbpMailKitOptions` 作为一个简单的 [选项](Options.md) 类.此类仅定义一个选项： * **SecureSocketOption**:用于设置“SecureSocketOptions” . Default：`null`（使用默认值） @@ -44,7 +41,7 @@ Configure(options => }); ```` -请参阅 [MailKit 文档](http://www.mimekit.net/) 以了解有关此选项的更多信息。 +请参阅 [MailKit 文档](http://www.mimekit.net/) 了解更多信息. ## 也可以看看 From 08c2488de4dbe15d985aed487a0926a05e9992ec Mon Sep 17 00:00:00 2001 From: enisn Date: Mon, 21 Feb 2022 17:19:37 +0300 Subject: [PATCH 15/32] Add class parameter to AbpExtensibleDataGrid --- .../Components/AbpExtensibleDataGrid.razor | 3 ++- .../Components/AbpExtensibleDataGrid.razor.cs | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/framework/src/Volo.Abp.BlazoriseUI/Components/AbpExtensibleDataGrid.razor b/framework/src/Volo.Abp.BlazoriseUI/Components/AbpExtensibleDataGrid.razor index 39a86456b8..114e140f03 100644 --- a/framework/src/Volo.Abp.BlazoriseUI/Components/AbpExtensibleDataGrid.razor +++ b/framework/src/Volo.Abp.BlazoriseUI/Components/AbpExtensibleDataGrid.razor @@ -9,7 +9,8 @@ TotalItems="@TotalItems" ShowPager="@ShowPager" CurrentPage="@CurrentPage" - PageSize="@PageSize"> + PageSize="@PageSize" + Class="@Class"> diff --git a/framework/src/Volo.Abp.BlazoriseUI/Components/AbpExtensibleDataGrid.razor.cs b/framework/src/Volo.Abp.BlazoriseUI/Components/AbpExtensibleDataGrid.razor.cs index 568a9eff3a..346efdae52 100644 --- a/framework/src/Volo.Abp.BlazoriseUI/Components/AbpExtensibleDataGrid.razor.cs +++ b/framework/src/Volo.Abp.BlazoriseUI/Components/AbpExtensibleDataGrid.razor.cs @@ -34,6 +34,8 @@ public partial class AbpExtensibleDataGrid : ComponentBase [Parameter] public int CurrentPage { get; set; } = 1; + [Parameter] public string Class { get; set; } + [Inject] public IStringLocalizerFactory StringLocalizerFactory { get; set; } From ac3453a13f44257eb3ca377e364ac19554bfb624 Mon Sep 17 00:00:00 2001 From: enisn Date: Tue, 22 Feb 2022 08:26:27 +0300 Subject: [PATCH 16/32] Add "Integrating MAUI Client via using OpenID Connect" Community Article --- .../README.md | 600 ++++++++++++++++++ .../art/android-login-demo.gif | Bin 0 -> 1311083 bytes .../art/compiler-select.png | Bin 0 -> 39492 bytes .../art/identity-users-request-result.png | Bin 0 -> 115598 bytes .../art/ios-login-demo.gif | Bin 0 -> 520566 bytes .../art/macos-login-demo.gif | Bin 0 -> 661738 bytes .../art/openid-configuration.png | Bin 0 -> 41790 bytes 7 files changed, 600 insertions(+) create mode 100644 docs/en/Community-Articles/2022-02-22-Integrating-MAUI-Client-via-using-OpenID-Connect/README.md create mode 100644 docs/en/Community-Articles/2022-02-22-Integrating-MAUI-Client-via-using-OpenID-Connect/art/android-login-demo.gif create mode 100644 docs/en/Community-Articles/2022-02-22-Integrating-MAUI-Client-via-using-OpenID-Connect/art/compiler-select.png create mode 100644 docs/en/Community-Articles/2022-02-22-Integrating-MAUI-Client-via-using-OpenID-Connect/art/identity-users-request-result.png create mode 100644 docs/en/Community-Articles/2022-02-22-Integrating-MAUI-Client-via-using-OpenID-Connect/art/ios-login-demo.gif create mode 100644 docs/en/Community-Articles/2022-02-22-Integrating-MAUI-Client-via-using-OpenID-Connect/art/macos-login-demo.gif create mode 100644 docs/en/Community-Articles/2022-02-22-Integrating-MAUI-Client-via-using-OpenID-Connect/art/openid-configuration.png diff --git a/docs/en/Community-Articles/2022-02-22-Integrating-MAUI-Client-via-using-OpenID-Connect/README.md b/docs/en/Community-Articles/2022-02-22-Integrating-MAUI-Client-via-using-OpenID-Connect/README.md new file mode 100644 index 0000000000..c702820bb2 --- /dev/null +++ b/docs/en/Community-Articles/2022-02-22-Integrating-MAUI-Client-via-using-OpenID-Connect/README.md @@ -0,0 +1,600 @@ +# Integrating MAUI Client via using OpenID Connect + This is a demonstration for connecting ABP backend from MAUI app via using openid connect. + + In this flow, a web browser will be opened when user tries to log in and user will perform login operation in the browser. Then IdentityServer will redirect user to application with login credentials (state, token etc.) will be handled by application. + +> This is by intent. The code flow does not allow the user to log in using a native view in the app. The reason being that this flow ensures that the username and password are never seen by the client (except the browser, which is part of the OS system - aka we trust it). You could enable using a native login view with the Resource Owner Password Credentials (ROPC) flow. But this is also an attack vector. Suppose someone makes a fraud duplicate of your application and tricking users into entering their credentials. The fraudulent app could store those credentials in-between. You just got to enjoy those tin-foil-hat moments when doing security. In other words, using the code flow does not give an attacker that opportunity and therefore is the recommended option for mobile clients. +> +> - [@Mark Allibone](https://mallibone.com/post/xamarin-oidc) + +By the way, my motivation for building this sample is presenting just another way for authentication. **Resource Owner Password Credentials** authentication is already provided and it's more common way to do. This is yet another way to authenticate users. + +## Source Code +You can also find source code on GitHub in ABP-Samples. +- [abpframework/abp-samples/MAUI-OpenId](https://github.com/abpframework/abp-samples/tree/master/MAUI-OpenId) + +## Creating projects +- Create an ABP project without UI + +```bash +abp new Acme.BookStore -t app --no-ui -d mongodb --no-random-ports +``` + +- Create a maui application + +```bash +mkdir maui +cd maui +dotnet new maui -n Acme.BookStore.MauiClient +``` + +There is a long way for configuring scopes and callback urls for both server and clients. We'll use [WebAuthenticator](https://docs.microsoft.com/en-us/xamarin/essentials/web-authenticator?tabs=android) to perform this operation. + +## Configuring IdentityServer + +- Go to DbMigrator folder and MAUI client in **appsettings.json**. Add following client code in **IdentityServer:Clients** path: + +```json + "BookStore_Maui": { + "ClientId": "BookStore_Maui", + "ClientSecret": "1q2w3e*", + "RootUrl": "bookstore://" + } +``` + +- Go to **IdentityServerDataSeedContributor** in Domain project under IdentityServer folder. Append following code section into **CreateClientsAsync()** method. + +```csharp +// Maui Client +var mauiClientId = configurationSection["BookStore_Maui:ClientId"]; +if (!mauiClientId.IsNullOrWhiteSpace()) +{ + var mauiRootUrl = configurationSection["BookStore_Maui:RootUrl"]; + + await CreateClientAsync( + name: mauiClientId, + scopes: commonScopes, + grantTypes: new[] { "authorization_code" }, + secret: configurationSection["BookStore_Maui:ClientSecret"]?.Sha256(), + requireClientSecret: false, + redirectUri: $"{mauiRootUrl}" + ); +} +``` + +- Run DbMigrator + +- Then run HttpApi.Host + +### Configuring NGROK +Client will check configuration from `/.well-known/openid-configuration` path and it must be a secured connection between client & server. I prefer to use ngrok to open my backend app to entire web. + +- Go to [getting started](https://dashboard.ngrok.com/get-started/setup) page of ngrok _(login or register first)_ and download the ngrok tool. + +- Don't forget to login from tool: + + ```bash + ngrok authtoken XXX + ``` + + _A sample command is being displayed at dashboard where you download ngrok from_ + +- Open your HttpApi.Host with ngrok + + ```bash + .\ngrok.exe http https://localhost:44350 + ``` + +- You'll see a generated xxx.ngrok.io url. Navigate to `/.well-known/openid-configuration` to check if it's working right. + + You should see something like that: + ![](art/openid-configuration.png) + Issuer must be your URL, not localhost! If you see still localhost, try to disable host header rewrite. + + +- Also, ValidIssuers must be defined to validate tokens. + + - Add **ValidIssuers** section to your `appsettings.json` of HttpApi.Host + + ```js + "AuthServer": { + "Authority": "https://localhost:44350", + "RequireHttpsMetadata": "false", + "SwaggerClientId": "BookStore_Swagger", + "SwaggerClientSecret": "1q2w3e*", + "ValidIssuers": [ + "https://46fd-45-156-29-175.ngrok.io" + ] + }, + ``` + + - Then define it in **ConfigureAuthentication** method in Module class + + ```csharp + private void ConfigureAuthentication(ServiceConfigurationContext context, IConfiguration configuration) + { + context.Services.AddAuthentication() + .AddJwtBearer(options => + { + // ... + options.TokenValidationParameters.ValidIssuers = configuration.GetSection("AuthServer:ValidIssuers").Get(); + }); + } + ``` + +We're done with backend. Let's continue with MAUI app. + + +## Developing MAUI App + +Before we go, there is something to do like configuring dependency injection to get rid of unnecessary huge class coupling. + +### Configuring Dependency Injection + +- Go to **MauiApplication** class and add `MainPage` in services. + + ```csharp + public static MauiApp CreateMauiApp() + { + var builder = MauiApp.CreateBuilder(); + builder + .UseMauiApp() + .ConfigureFonts(fonts => + { + fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular"); + }); + + builder.Services.AddTransient(); + + return builder.Build(); + } + ``` + +- And inject MainPage from constructor in **App.xaml.cs** + + ```csharp + public App(MainPage mainPage) + { + InitializeComponent(); + + MainPage = mainPage; + } + ``` + +Now MainPage is ready for injecting dependencies to it. + + +### Configuring OIDC + +- Add `IdentityModel.OidcClient` package to project + + ```xml + + + + ``` + +- Create **WebAuthenticatorBrowser** + + ```csharp + internal class WebAuthenticatorBrowser : IBrowser + { + public async Task InvokeAsync(BrowserOptions options, CancellationToken cancellationToken = default) + { + try + { + WebAuthenticatorResult authResult = + await WebAuthenticator.AuthenticateAsync(new Uri(options.StartUrl), new Uri(options.EndUrl)); + var authorizeResponse = ToRawIdentityUrl(options.EndUrl, authResult); + + return new BrowserResult + { + Response = authorizeResponse + }; + } + catch (Exception ex) + { + Debug.WriteLine(ex); + return new BrowserResult() + { + ResultType = BrowserResultType.UnknownError, + Error = ex.ToString() + }; + } + } + + public string ToRawIdentityUrl(string redirectUrl, WebAuthenticatorResult result) + { + IEnumerable parameters = result.Properties.Select(pair => $"{pair.Key}={pair.Value}"); + var values = string.Join("&", parameters); + + return $"{redirectUrl}#{values}"; + } + } + ``` + +- Configure **OidcClient** in **MauiProgram** + + ```csharp + builder.Services.AddTransient(); + + builder.Services.AddTransient(sp => + new OidcClient(new OidcClientOptions + { + // Use your own ngrok url: + Authority = "https://46fd-45-156-29-175.ngrok.io", + ClientId = "BookStore_Maui", + RedirectUri = "bookstore://", + Scope = "openid email profile role BookStore", + ClientSecret = "1q2w3E*", + Browser = sp.GetRequiredService(), + }) + ); + ``` + +- Go to **MainPage.xaml**, remove everyting and add a button for login + + ```xml + + + + + +