Skip to content

Commit 31e10f9

Browse files
jstedfastjstedfast
committedMar 2, 2025·
Improved docs for ImapFolder.GetBodyPart/GetStream wrt partSpecifiers
·
4.11.0
1 parent 5f236cb commit 31e10f9

File tree

2 files changed

+40
-24
lines changed

2 files changed

+40
-24
lines changed
 

‎MailKit/Net/Imap/IImapFolder.cs

+12-4
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,9 @@ public interface IImapFolder : IMailFolder
235235
/// Get the specified body part.
236236
/// </summary>
237237
/// <remarks>
238-
/// Gets the specified body part.
238+
/// <para>Gets the specified body part.</para>
239+
/// <note type="note">For more information about how to construct the <paramref name="partSpecifier"/>,
240+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
239241
/// </remarks>
240242
/// <returns>The body part.</returns>
241243
/// <param name="uid">The UID of the message.</param>
@@ -281,7 +283,9 @@ public interface IImapFolder : IMailFolder
281283
/// Asynchronously get the specified body part.
282284
/// </summary>
283285
/// <remarks>
284-
/// Gets the specified body part.
286+
/// <para>Gets the specified body part.</para>
287+
/// <note type="note">For more information about how to construct the <paramref name="partSpecifier"/>,
288+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
285289
/// </remarks>
286290
/// <returns>The body part.</returns>
287291
/// <param name="uid">The UID of the message.</param>
@@ -327,7 +331,9 @@ public interface IImapFolder : IMailFolder
327331
/// Get the specified body part.
328332
/// </summary>
329333
/// <remarks>
330-
/// Gets the specified body part.
334+
/// <para>Gets the specified body part.</para>
335+
/// <note type="note">For more information about how to construct the <paramref name="partSpecifier"/>,
336+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
331337
/// </remarks>
332338
/// <returns>The body part.</returns>
333339
/// <param name="index">The index of the message.</param>
@@ -373,7 +379,9 @@ public interface IImapFolder : IMailFolder
373379
/// Asynchronously get the specified body part.
374380
/// </summary>
375381
/// <remarks>
376-
/// Gets the specified body part.
382+
/// <para>Gets the specified body part.</para>
383+
/// <note type="note">For more information about how to construct the <paramref name="partSpecifier"/>,
384+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
377385
/// </remarks>
378386
/// <returns>The body part.</returns>
379387
/// <param name="index">The index of the message.</param>

‎MailKit/Net/Imap/ImapFolderFetch.cs

+28-20
Original file line numberDiff line numberDiff line change
@@ -3603,7 +3603,9 @@ void RemoveMessageHeaders (MimeEntity entity)
36033603
/// Get the specified body part.
36043604
/// </summary>
36053605
/// <remarks>
3606-
/// Gets the specified body part.
3606+
/// <para>Gets the specified body part.</para>
3607+
/// <note type="note">For more information about how to construct the <paramref name="partSpecifier"/>,
3608+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
36073609
/// </remarks>
36083610
/// <example>
36093611
/// <code language="c#" source="Examples\ImapBodyPartExamples.cs" region="GetBodyPartsByUniqueIdAndSpecifier"/>
@@ -3672,7 +3674,9 @@ public virtual MimeEntity GetBodyPart (UniqueId uid, string partSpecifier, Cance
36723674
/// Asynchronously get the specified body part.
36733675
/// </summary>
36743676
/// <remarks>
3675-
/// Gets the specified body part.
3677+
/// <para>Gets the specified body part.</para>
3678+
/// <note type="note">For more information about how to construct the <paramref name="partSpecifier"/>,
3679+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
36763680
/// </remarks>
36773681
/// <example>
36783682
/// <code language="c#" source="Examples\ImapBodyPartExamples.cs" region="GetBodyPartsByUniqueIdAndSpecifier"/>
@@ -3902,7 +3906,9 @@ void ProcessGetBodyPartResponse (ImapCommand ic, FetchStreamContext ctx, int ind
39023906
/// Get the specified body part.
39033907
/// </summary>
39043908
/// <remarks>
3905-
/// Gets the specified body part.
3909+
/// <para>Gets the specified body part.</para>
3910+
/// <note type="note">For more information about how to construct the <paramref name="partSpecifier"/>,
3911+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
39063912
/// </remarks>
39073913
/// <returns>The body part.</returns>
39083914
/// <param name="index">The index of the message.</param>
@@ -3968,7 +3974,9 @@ public virtual MimeEntity GetBodyPart (int index, string partSpecifier, Cancella
39683974
/// Asynchronously get the specified body part.
39693975
/// </summary>
39703976
/// <remarks>
3971-
/// Gets the specified body part.
3977+
/// <para>Gets the specified body part.</para>
3978+
/// <note type="note">For more information about how to construct the <paramref name="partSpecifier"/>,
3979+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
39723980
/// </remarks>
39733981
/// <returns>The body part.</returns>
39743982
/// <param name="index">The index of the message.</param>
@@ -4521,8 +4529,8 @@ void ProcessGetStreamResponse (ImapCommand ic, FetchStreamContext ctx, UniqueId
45214529
/// </summary>
45224530
/// <remarks>
45234531
/// <para>Gets a substream of the specified message.</para>
4524-
/// <para>For more information about how to construct the <paramref name="section"/>,
4525-
/// see Section 6.4.5 of RFC3501.</para>
4532+
/// <note type="note">For more information about how to construct the <paramref name="section"/>,
4533+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
45264534
/// </remarks>
45274535
/// <example>
45284536
/// <code language="c#" source="Examples\ImapBodyPartExamples.cs" region="GetBodyPartStreamsByUniqueIdAndSpecifier"/>
@@ -4586,8 +4594,8 @@ public override Stream GetStream (UniqueId uid, string section, CancellationToke
45864594
/// </summary>
45874595
/// <remarks>
45884596
/// <para>Gets a substream of the specified message.</para>
4589-
/// <para>For more information about how to construct the <paramref name="section"/>,
4590-
/// see Section 6.4.5 of RFC3501.</para>
4597+
/// <note type="note">For more information about how to construct the <paramref name="section"/>,
4598+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
45914599
/// </remarks>
45924600
/// <example>
45934601
/// <code language="c#" source="Examples\ImapBodyPartExamples.cs" region="GetBodyPartStreamsByUniqueIdAndSpecifier"/>
@@ -4686,8 +4694,8 @@ ImapCommand QueueGetStreamCommand (UniqueId uid, string section, int offset, int
46864694
/// the end of the specified section of the message, an empty stream is returned. If
46874695
/// the number of bytes desired extends beyond the end of the section, a truncated
46884696
/// stream will be returned.</para>
4689-
/// <para>For more information about how to construct the <paramref name="section"/>,
4690-
/// see Section 6.4.5 of RFC3501.</para>
4697+
/// <note type="note">For more information about how to construct the <paramref name="section"/>,
4698+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
46914699
/// </remarks>
46924700
/// <returns>The stream.</returns>
46934701
/// <param name="uid">The UID of the message.</param>
@@ -4762,8 +4770,8 @@ public override Stream GetStream (UniqueId uid, string section, int offset, int
47624770
/// the end of the specified section of the message, an empty stream is returned. If
47634771
/// the number of bytes desired extends beyond the end of the section, a truncated
47644772
/// stream will be returned.</para>
4765-
/// <para>For more information about how to construct the <paramref name="section"/>,
4766-
/// see Section 6.4.5 of RFC3501.</para>
4773+
/// <note type="note">For more information about how to construct the <paramref name="section"/>,
4774+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
47674775
/// </remarks>
47684776
/// <returns>The stream.</returns>
47694777
/// <param name="uid">The UID of the message.</param>
@@ -4864,8 +4872,8 @@ void ProcessGetStreamResponse (ImapCommand ic, FetchStreamContext ctx, int index
48644872
/// </summary>
48654873
/// <remarks>
48664874
/// <para>Gets a substream of the specified message.</para>
4867-
/// <para>For more information about how to construct the <paramref name="section"/>,
4868-
/// see Section 6.4.5 of RFC3501.</para>
4875+
/// <note type="note">For more information about how to construct the <paramref name="section"/>,
4876+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
48694877
/// </remarks>
48704878
/// <returns>The stream.</returns>
48714879
/// <param name="index">The index of the message.</param>
@@ -4926,8 +4934,8 @@ public override Stream GetStream (int index, string section, CancellationToken c
49264934
/// </summary>
49274935
/// <remarks>
49284936
/// <para>Gets a substream of the specified message.</para>
4929-
/// <para>For more information about how to construct the <paramref name="section"/>,
4930-
/// see Section 6.4.5 of RFC3501.</para>
4937+
/// <note type="note">For more information about how to construct the <paramref name="section"/>,
4938+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
49314939
/// </remarks>
49324940
/// <returns>The stream.</returns>
49334941
/// <param name="index">The index of the message.</param>
@@ -5025,8 +5033,8 @@ ImapCommand QueueGetStreamCommand (int index, string section, int offset, int co
50255033
/// the end of the specified section of the message, an empty stream is returned. If
50265034
/// the number of bytes desired extends beyond the end of the section, a truncated
50275035
/// stream will be returned.</para>
5028-
/// <para>For more information about how to construct the <paramref name="section"/>,
5029-
/// see Section 6.4.5 of RFC3501.</para>
5036+
/// <note type="note">For more information about how to construct the <paramref name="section"/>,
5037+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
50305038
/// </remarks>
50315039
/// <returns>The stream.</returns>
50325040
/// <param name="index">The index of the message.</param>
@@ -5100,8 +5108,8 @@ public override Stream GetStream (int index, string section, int offset, int cou
51005108
/// the end of the specified section of the message, an empty stream is returned. If
51015109
/// the number of bytes desired extends beyond the end of the section, a truncated
51025110
/// stream will be returned.</para>
5103-
/// <para>For more information about how to construct the <paramref name="section"/>,
5104-
/// see Section 6.4.5 of RFC3501.</para>
5111+
/// <note type="note">For more information about how to construct the <paramref name="section"/>,
5112+
/// see <a href="https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.5">RFC3501, Section 6.4.5</a>.</note>
51055113
/// </remarks>
51065114
/// <returns>The stream.</returns>
51075115
/// <param name="index">The index of the message.</param>

0 commit comments

Comments
 (0)
Please sign in to comment.