Pop 3ClientGet Messages(Int 32, Int 32, Cancellation Token, ITransfer Progress) Method
Get the messages within the specified range.
Definition
Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The messages.
IMailSpoolGetMessages(Int32, Int32, CancellationToken, ITransferProgress)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override IList<MimeMessage> GetMessages(
int startIndex,
int count,
CancellationToken cancellationToken = default,
ITransferProgress? progress = null
)Parameters
- startIndex Int32
- The index of the first message to get.
- count Int32
- The number of messages to get.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
- progress ITransferProgress (Optional)
- The progress reporting mechanism.
Return Value
IListMimeMessageThe messages.
Implements
IMailSpoolGetMessages(Int32, Int32, CancellationToken, ITransferProgress)IMailSpoolGetMessages(Int32, Int32, CancellationToken, ITransferProgress)
Remarks
Gets the messages within the specified range.
When the POP3 server supports the Pipelining extension, this method will likely be more efficient than using GetMessage(Int32, CancellationToken, ITransferProgress) for each message because it will batch the commands to reduce latency.
Example
C#
public static void DownloadMessages ()
{
using (var client = new Pop3Client ()) {
client.Connect ("pop.gmail.com", 995, SecureSocketOptions.SslOnConnect);
client.Authenticate ("username", "password");
int count = client.Count;
var messages = client.GetMessages (0, count);
for (int i = 0; i < messages.Count; i++) {
// write the message to a file
messages[i].WriteTo (string.Format ("{0}.eml", i));
}
client.DeleteMessages (0, count);
client.Disconnect (true);
}
}
Exceptions
| ArgumentOutOfRangeException | startIndex and count do not specify a valid range of messages. |
| ObjectDisposedException | The Pop3Client has been disposed. |
| ServiceNotConnectedException | The Pop3Client is not connected. |
| ServiceNotAuthenticatedException | The Pop3Client is not authenticated. |
| NotSupportedException | The POP3 server does not support the UIDL extension. |
| OperationCanceledException | The operation was canceled via the cancellation token. |
| IOException | An I/O error occurred. |
| Pop3CommandException | The POP3 command failed. |
| Pop3ProtocolException | A POP3 protocol error occurred. |