Skip to content

Temporarily remove obsolete attribute #3320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 11, 2019
Merged

Temporarily remove obsolete attribute #3320

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a5019aa
Temporarily remove obsolete attribute
mairaw Oct 9, 2019
dd01b47
feedback
mairaw Oct 10, 2019
5c99f7e
expand note
mairaw Oct 10, 2019
b4e0abe
fix typo + improvements
mairaw Oct 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions xml/System.Net.Mail/SmtpClient.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,25 @@
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute FrameworkAlternate="xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0">
<AttributeName>System.Obsolete("SmtpClient and its network of types are poorly designed, we strongly recommend you use https://github.com/jstedfast/MailKit and https://github.com/jstedfast/MimeKit instead")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Allows applications to send email by using the Simple Mail Transfer Protocol (SMTP). The <c>SmtpClient</c> type is now obsolete.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The `System.Net.Mail.SmtpClient` class is used to send email to an SMTP server for delivery. The SMTP protocol is defined in RFC 2821, which is available at [https://www.ietf.org](https://www.ietf.org/).
## Remarks

The `SmtpClient` class is used to send email to an SMTP server for delivery. The SMTP protocol is defined in RFC 2821, which is available at [https://www.ietf.org](https://www.ietf.org/).

> [!IMPORTANT]
> We don't recommend that you use the `SmtpClient` class for new development. For more information, see [SmtpClient shouldn't be used](https://github.com/dotnet/platform-compat/blob/master/docs/DE0005.md) on GitHub.
> We don't recommend that you use the `SmtpClient` class for new development because `SmtpClient` doesn't support many modern protocols. Use [MailKit](https://github.com/jstedfast/MailKit) or other libraries instead. For more information, see [SmtpClient shouldn't be used](https://github.com/dotnet/platform-compat/blob/master/docs/DE0005.md) on GitHub.

The `SmtpClient` class is obsolete in Xamarin. However:

- It is included in the .NET Standard 2.0 and later versions and therefore must be part of any .NET implementation that supports those versions.
- It is present and can be used in .NET Framework 4 through .NET Framework 4.8.
- It is usable in .NET Core, but its use isn't recommended.

The classes shown in the following table are used to construct email messages that can be sent using <xref:System.Net.Mail.SmtpClient>.
The classes shown in the following table are used to construct email messages that can be sent using <xref:System.Net.Mail.SmtpClient>.

|Class|Description|
|-----------|-----------------|
Expand Down