Skip to content

Update ns-System.Net.Mail.xml #2420

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 2 commits into from
May 23, 2019
Merged

Update ns-System.Net.Mail.xml #2420

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15c732a
Update ns-System.Net.Mail.xml
stephenegriffin May 8, 2019
635499d
Update ns-System.Net.Mail.xml
May 22, 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
12 changes: 10 additions & 2 deletions xml/ns-System.Net.Mail.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
<Namespace Name="System.Net.Mail">
<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>The <see cref="N:System.Net.Mail" /> namespace contains classes used to send electronic mail to a Simple Mail Transfer Protocol (SMTP) server for delivery.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Net.Mail.MailMessage> class represents the content of a mail message. The <xref:System.Net.Mail.SmtpClient> class transmits email to the SMTP host that you designate for mail delivery. You can create mail attachments using the <xref:System.Net.Mail.Attachment> class.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The <xref:System.Net.Mail.MailMessage> class represents the content of a mail message. The <xref:System.Net.Mail.SmtpClient> class transmits email to the SMTP host that you designate for mail delivery. You can create mail attachments using the <xref:System.Net.Mail.Attachment> class.
The <xref:System.Net.Mail.MailMessage> class represents the content of a mail message.
You can create mail attachments using the <xref:System.Net.Mail.Attachment> class.



[!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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The formatting here is incorrect to produce a note box. The lines should be preceded by > . But this seems an awkward way of handling the fact that SmtpClient is obsolete in any case. Instead of the note, I'd modify the Remarks section as I've suggested, and also add "(This type is now obsolete.)" to the type summary in dotnet-api-docs/xml/System.Net.Mail/SmtpClient.xml.


]]></format>
</remarks>
<altmember cref="N:System.Net" />
Expand All @@ -20,4 +28,4 @@
<related type="Article" href="~/docs/framework/network-programming/network-tracing.md">Network Tracing in the .NET Framework</related>
<related type="Article" href="~/docs/framework/network-programming/security-in-network-programming.md">Security in Network Programming</related>
</Docs>
</Namespace>
</Namespace>