Skip to content

Commit

Permalink
Fix typos (#1824)
Browse files Browse the repository at this point in the history
  • Loading branch information
NathanBaulch authored Oct 6, 2024
1 parent 1489237 commit 38b39de
Show file tree
Hide file tree
Showing 55 changed files with 171 additions and 171 deletions.
4 changes: 2 additions & 2 deletions Documentation/Content/Frequently-Asked-Questions.aml
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@
</code>
<para>
The downside of the above example is that it requires hard-coding known values for "trusted" mail server
certificates which can quickly become unweildy to deal with if your program is meant to be used with
certificates which can quickly become unwieldy to deal with if your program is meant to be used with
a wide range of mail servers.
</para>
<para>
Expand Down Expand Up @@ -823,7 +823,7 @@ message.WriteTo (options, stream);
The method variant that has a
<codeEntityReference>T:MimeKit.Cryptography.DigitalSignatureCollection</codeEntityReference>
output parameter is useful in cases where the encrypted PGP blurb is also digitally signed,
allowing you to get your hands on the list of digitial signatures in order for you to verify
allowing you to get your hands on the list of digital signatures in order for you to verify
each of them.
</para>
<para>
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Content/Working-With-Messages.aml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
-->

<introduction>
<para>MimeKit provies a number of ways to get the data you want from a message.</para>
<para>MimeKit provides a number of ways to get the data you want from a message.</para>
<autoOutline />
</introduction>

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Content/Working-With-SMime.aml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
database to use for certificate storage.
</para>
<para>
If you are targetting any of the <application>Xamarin</application> platforms
If you are targeting any of the <application>Xamarin</application> platforms
(or Linux), you won't need to do anything (although you certainly can if you want to)
because, by default, MimeKit will automatically use the
<application>Mono.Data.Sqlite</application> binding to
Expand Down Expand Up @@ -124,7 +124,7 @@
</para>
<code language="c#" source="Examples\SMimeExamples.cs" region="MultipartSignWithKey"/>
<para>
You can also choose to digitially sign a
You can also choose to digitally sign a
<codeEntityReference>T:MimeKit.MimeEntity</codeEntityReference> using the
<literal>application/pkcs7-mime</literal> format using
<codeEntityReference autoUpgrade="true" qualifyHint="true">
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Examples/ArcVerifierExample.cs
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ AsymmetricKeyParameter DnsLookup (string domain, string selector, CancellationTo
return DnsLookup (domain, selector, cancellationToken);
}

throw new NotSupportedException (string.Format ("{0} does not include any suported lookup methods.", methods));
throw new NotSupportedException (string.Format ("{0} does not include any supported lookup methods.", methods));
}

public Task<AsymmetricKeyParameter> LocatePublicKeyAsync (string methods, string domain, string selector, CancellationToken cancellationToken = default (CancellationToken))
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Examples/DkimVerifierExample.cs
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ AsymmetricKeyParameter DnsLookup (string domain, string selector, CancellationTo
return DnsLookup (domain, selector, cancellationToken);
}

throw new NotSupportedException (string.Format ("{0} does not include any suported lookup methods.", methods));
throw new NotSupportedException (string.Format ("{0} does not include any supported lookup methods.", methods));
}

public Task<AsymmetricKeyParameter> LocatePublicKeyAsync (string methods, string domain, string selector, CancellationToken cancellationToken = default (CancellationToken))
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Examples/ImapExamples.cs
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ public static void ShowNamespaces ()
// list the folders under the first personal namespace
var subfolders = personal.GetSubfolders ();

Console.WriteLine ("The list of folders that are direct children of the first personmal namespace:");
Console.WriteLine ("The list of folders that are direct children of the first personal namespace:");
foreach (var folder in subfolders)
Console.WriteLine ($"* {folder.Name}");

Expand Down
4 changes: 2 additions & 2 deletions Documentation/Examples/ParameterExamples.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public void OverrideAllParameterEncodings (MimePart part)
#region OverrideAllParameterEncodings
// Some versions of Outlook expect the rfc2047 style of encoding of parameter values.
foreach (var parameter in part.ContentDisposition.Parameters)
parameter.EncodingMehod = ParameerEncodngMethod.Rfc2047;
parameter.EncodingMethod = ParameterEncodingMethod.Rfc2047;
#endregion OverrideAllParameterEncodings
}

Expand All @@ -20,7 +20,7 @@ public void OverrideFileNameParameterEncodings (MimePart part)
#region OverrideFileNameParameterEncoding
// Some versions of Outlook expect the rfc2047 style of encoding for the filename parameter value.
if (part.ContentDisposition.Parameters.TryGetValue ("filename", out var parameter))
parameter.EncodingMehod = ParameerEncodngMethod.Rfc2047;
parameter.EncodingMethod = ParameterEncodingMethod.Rfc2047;
#endregion OverrideFileNameParameterEncoding
}
}
Expand Down
12 changes: 6 additions & 6 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* [How can I save attachments?](#save-attachments)
* [How can I get the email addresses in the From, To, and Cc headers?](#address-headers)
* [Why do attachments with unicode filenames appear as "ATT0####.dat" in Outlook?](#untitled-attachments)
* [How can I decrypt PGP messages that are embedded in the main message text?](#decyrpt-inline-pgp)
* [How can I decrypt PGP messages that are embedded in the main message text?](#decrypt-inline-pgp)
* [How can I reply to a message?](#reply-message)
* [How can I forward a message?](#forward-message)
* [Why does text show up garbled in my ASP.NET Core / .NET Core / .NET 5 app?](#garbled-text)
Expand Down Expand Up @@ -59,7 +59,7 @@ Yes. MimeKit and MailKit are both completely free and open source. They are both
In .NET Core, Microsoft decided to split out the non-Unicode text encodings into a separate NuGet package called
[System.Text.Encoding.CodePages](https://www.nuget.org/packages/System.Text.Encoding.CodePages).

MimeKit already pulls in a reference to this NuGet package, so you shsouldn't need to add a reference to it in
MimeKit already pulls in a reference to this NuGet package, so you shouldn't need to add a reference to it in
your project. That said, you will still need to register the encoding provider. It is recommended that you add
the following line of code to your program initialization (e.g. the beginning of your program's Main() method):

Expand Down Expand Up @@ -193,7 +193,7 @@ bool MyServerCertificateValidationCallback (object sender, X509Certificate certi
```

The downside of the above example is that it requires hard-coding known values for "trusted" mail server
certificates which can quickly become unweildy to deal with if your program is meant to be used with
certificates which can quickly become unwieldy to deal with if your program is meant to be used with
a wide range of mail servers.

The best approach would be to prompt the user with a dialog explaining that the certificate is
Expand Down Expand Up @@ -1031,7 +1031,7 @@ foreach (var param in attachment.ContentDisposition.Parameters) {
}
```

### <a id="decyrpt-inline-pgp">Q: How can I decrypt PGP messages that are embedded in the main message text?</a>
### <a id="decrypt-inline-pgp">Q: How can I decrypt PGP messages that are embedded in the main message text?</a>

Some PGP-enabled mail clients, such as Thunderbird, embed encrypted PGP blurbs within the `text/plain` body
of the message rather than using the PGP/MIME format that MimeKit prefers.
Expand Down Expand Up @@ -1088,7 +1088,7 @@ public Stream GetDecryptedStream (Stream encryptedData)
```

The first variant is useful in cases where the encrypted PGP blurb is also digitally signed, allowing you to get
your hands on the list of digitial signatures in order for you to verify each of them.
your hands on the list of digital signatures in order for you to verify each of them.

To decrypt the content of the message, you'll want to locate the `TextPart` (in this case, it'll just be
`message.Body`) and then do this:
Expand Down Expand Up @@ -1671,7 +1671,7 @@ folder.RemoveFlags (uids, MessageFlags.Seen, true);

### <a id="imap-folder-resync">Q: How can I re-synchronize the cache for an IMAP folder?</a>

Assuming your IMAP server does not support the `QRESYNC` extension (which simplifies this proceedure a ton),
Assuming your IMAP server does not support the `QRESYNC` extension (which simplifies this procedure a ton),
here is some simple code to illustrate how to go about re-synchronizing your cache with the remote IMAP
server.

Expand Down
2 changes: 1 addition & 1 deletion MailKit/AnnotationEntry.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Annotationentry.cs
// AnnotationEntry.cs
//
// Author: Jeffrey Stedfast <jestedfa@microsoft.com>
//
Expand Down
16 changes: 8 additions & 8 deletions MailKit/CompressedStream.cs
Original file line number Diff line number Diff line change
Expand Up @@ -94,19 +94,19 @@ public override bool CanTimeout {
}

/// <summary>
/// Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
/// Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
/// </summary>
/// <returns>A value, in miliseconds, that determines how long the stream will attempt to read before timing out.</returns>
/// <returns>A value, in milliseconds, that determines how long the stream will attempt to read before timing out.</returns>
/// <value>The read timeout.</value>
public override int ReadTimeout {
get { return InnerStream.ReadTimeout; }
set { InnerStream.ReadTimeout = value; }
}

/// <summary>
/// Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
/// Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
/// </summary>
/// <returns>A value, in miliseconds, that determines how long the stream will attempt to write before timing out.</returns>
/// <returns>A value, in milliseconds, that determines how long the stream will attempt to write before timing out.</returns>
/// <value>The write timeout.</value>
public override int WriteTimeout {
get { return InnerStream.WriteTimeout; }
Expand Down Expand Up @@ -171,7 +171,7 @@ void CheckDisposed ()
/// <exception cref="System.ArgumentOutOfRangeException">
/// <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
/// <para>-or-</para>
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes starting
/// at the specified <paramref name="offset"/>.</para>
/// </exception>
/// <exception cref="System.ObjectDisposedException">
Expand Down Expand Up @@ -232,7 +232,7 @@ public override int Read (byte[] buffer, int offset, int count)
/// <exception cref="System.ArgumentOutOfRangeException">
/// <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
/// <para>-or-</para>
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes starting
/// at the specified <paramref name="offset"/>.</para>
/// </exception>
/// <exception cref="System.ObjectDisposedException">
Expand Down Expand Up @@ -292,7 +292,7 @@ public override async Task<int> ReadAsync (byte[] buffer, int offset, int count,
/// <exception cref="System.ArgumentOutOfRangeException">
/// <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
/// <para>-or-</para>
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes starting
/// at the specified <paramref name="offset"/>.</para>
/// </exception>
/// <exception cref="System.ObjectDisposedException">
Expand Down Expand Up @@ -343,7 +343,7 @@ public override void Write (byte[] buffer, int offset, int count)
/// <exception cref="System.ArgumentOutOfRangeException">
/// <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
/// <para>-or-</para>
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes starting
/// at the specified <paramref name="offset"/>.</para>
/// </exception>
/// <exception cref="System.ObjectDisposedException">
Expand Down
2 changes: 1 addition & 1 deletion MailKit/DeliveryStatusNotification.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ namespace MailKit {
/// <remarks>
/// A set of flags that may be bitwise-or'd together to specify
/// when a delivery status notification should be sent for a
/// particlar recipient.
/// particular recipient.
/// </remarks>
/// <example>
/// <code language="c#" source="Examples\SmtpExamples.cs" region="DeliveryStatusNotification"/>
Expand Down
16 changes: 8 additions & 8 deletions MailKit/DuplexStream.cs
Original file line number Diff line number Diff line change
Expand Up @@ -108,19 +108,19 @@ public override bool CanTimeout {
}

/// <summary>
/// Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
/// Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
/// </summary>
/// <returns>A value, in miliseconds, that determines how long the stream will attempt to read before timing out.</returns>
/// <returns>A value, in milliseconds, that determines how long the stream will attempt to read before timing out.</returns>
/// <value>The read timeout.</value>
public override int ReadTimeout {
get { return InputStream.ReadTimeout; }
set { InputStream.ReadTimeout = value; }
}

/// <summary>
/// Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
/// Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
/// </summary>
/// <returns>A value, in miliseconds, that determines how long the stream will attempt to write before timing out.</returns>
/// <returns>A value, in milliseconds, that determines how long the stream will attempt to write before timing out.</returns>
/// <value>The write timeout.</value>
public override int WriteTimeout {
get { return OutputStream.WriteTimeout; }
Expand Down Expand Up @@ -185,7 +185,7 @@ void CheckDisposed ()
/// <exception cref="System.ArgumentOutOfRangeException">
/// <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
/// <para>-or-</para>
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes starting
/// at the specified <paramref name="offset"/>.</para>
/// </exception>
/// <exception cref="System.ObjectDisposedException">
Expand Down Expand Up @@ -219,7 +219,7 @@ public override int Read (byte[] buffer, int offset, int count)
/// <exception cref="System.ArgumentOutOfRangeException">
/// <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
/// <para>-or-</para>
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes starting
/// at the specified <paramref name="offset"/>.</para>
/// </exception>
/// <exception cref="System.ObjectDisposedException">
Expand Down Expand Up @@ -250,7 +250,7 @@ public override Task<int> ReadAsync (byte[] buffer, int offset, int count, Cance
/// <exception cref="System.ArgumentOutOfRangeException">
/// <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
/// <para>-or-</para>
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes starting
/// at the specified <paramref name="offset"/>.</para>
/// </exception>
/// <exception cref="System.ObjectDisposedException">
Expand Down Expand Up @@ -286,7 +286,7 @@ public override void Write (byte[] buffer, int offset, int count)
/// <exception cref="System.ArgumentOutOfRangeException">
/// <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
/// <para>-or-</para>
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
/// <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes starting
/// at the specified <paramref name="offset"/>.</para>
/// </exception>
/// <exception cref="System.ObjectDisposedException">
Expand Down
6 changes: 3 additions & 3 deletions MailKit/FolderNamespaceCollection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,12 @@ public bool Contains (FolderNamespace @namespace)
}

/// <summary>
/// Removes the first occurance of the specified namespace.
/// Removes the first occurrence of the specified namespace.
/// </summary>
/// <remarks>
/// Removes the first occurance of the specified namespace.
/// Removes the first occurrence of the specified namespace.
/// </remarks>
/// <returns><value>true</value> if the frst occurance of the specified
/// <returns><value>true</value> if the first occurrence of the specified
/// namespace was removed; otherwise <value>false</value>.</returns>
/// <param name="namespace">The namespace.</param>
/// <exception cref="System.ArgumentNullException">
Expand Down
10 changes: 5 additions & 5 deletions MailKit/IMailFolder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -831,7 +831,7 @@ public interface IMailFolder : IEnumerable<MimeMessage>
void SetAccessRights (string name, AccessRights rights, CancellationToken cancellationToken = default);

/// <summary>
/// Asynchronously set the access rights for the sepcified identity.
/// Asynchronously set the access rights for the specified identity.
/// </summary>
/// <remarks>
/// Asynchronously sets the access rights for the specified identity.
Expand Down Expand Up @@ -2603,7 +2603,7 @@ public interface IMailFolder : IEnumerable<MimeMessage>
/// Search the subset of UIDs in the folder for messages matching the specified query.
/// </summary>
/// <remarks>
/// Searches the fsubset of UIDs in the folder for messages matching the specified query,
/// Searches the subset of UIDs in the folder for messages matching the specified query,
/// returning only the specified search results.
/// </remarks>
/// <returns>The search results.</returns>
Expand All @@ -2617,7 +2617,7 @@ public interface IMailFolder : IEnumerable<MimeMessage>
/// Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
/// </summary>
/// <remarks>
/// Asynchronously searches the fsubset of UIDs in the folder for messages matching the specified query,
/// Asynchronously searches the subset of UIDs in the folder for messages matching the specified query,
/// returning only the specified search results.
/// </remarks>
/// <returns>The search results.</returns>
Expand Down Expand Up @@ -2899,8 +2899,8 @@ public interface IMailFolder : IEnumerable<MimeMessage>
/// <note type="note">The <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
/// methods will return a list of all message summaries that any information was
/// retrieved for, regardless of whether or not all of the requested items were fetched,
/// therefore there may be a discrepency between the number of times this event is
/// emitetd and the number of summary items returned from the Fetch method.</note>
/// therefore there may be a discrepancy between the number of times this event is
/// emitted and the number of summary items returned from the Fetch method.</note>
/// </remarks>
event EventHandler<MessageSummaryFetchedEventArgs> MessageSummaryFetched;

Expand Down
Loading

0 comments on commit 38b39de

Please sign in to comment.