270 lines
9.7 KiB
C#
270 lines
9.7 KiB
C#
//
|
|
// MessageFlagsChangedEventArgs.cs
|
|
//
|
|
// Author: Jeffrey Stedfast <jestedfa@microsoft.com>
|
|
//
|
|
// Copyright (c) 2013-2020 .NET Foundation and Contributors
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
//
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
|
|
namespace MailKit {
|
|
/// <summary>
|
|
/// Event args for the <see cref="IMailFolder.MessageFlagsChanged"/> event.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Event args for the <see cref="IMailFolder.MessageFlagsChanged"/> event.
|
|
/// </remarks>
|
|
public class MessageFlagsChangedEventArgs : MessageEventArgs
|
|
{
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="MailKit.MessageFlagsChangedEventArgs"/> class.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a new <see cref="MessageFlagsChangedEventArgs"/>.
|
|
/// </remarks>
|
|
/// <param name="index">The message index.</param>
|
|
internal MessageFlagsChangedEventArgs (int index) : base (index)
|
|
{
|
|
Keywords = new HashSet<string> (StringComparer.OrdinalIgnoreCase);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="MailKit.MessageFlagsChangedEventArgs"/> class.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a new <see cref="MessageFlagsChangedEventArgs"/>.
|
|
/// </remarks>
|
|
/// <param name="index">The message index.</param>
|
|
/// <param name="flags">The message flags.</param>
|
|
public MessageFlagsChangedEventArgs (int index, MessageFlags flags) : base (index)
|
|
{
|
|
Keywords = new HashSet<string> (StringComparer.OrdinalIgnoreCase);
|
|
Flags = flags;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="MailKit.MessageFlagsChangedEventArgs"/> class.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a new <see cref="MessageFlagsChangedEventArgs"/>.
|
|
/// </remarks>
|
|
/// <param name="index">The message index.</param>
|
|
/// <param name="flags">The message flags.</param>
|
|
/// <param name="keywords">The user-defined message flags.</param>
|
|
/// <exception cref="System.ArgumentNullException">
|
|
/// <paramref name="keywords"/> is <c>null</c>.
|
|
/// </exception>
|
|
/// <exception cref="System.ArgumentOutOfRangeException">
|
|
/// <paramref name="index"/> is out of range.
|
|
/// </exception>
|
|
public MessageFlagsChangedEventArgs (int index, MessageFlags flags, HashSet<string> keywords) : base (index)
|
|
{
|
|
if (keywords == null)
|
|
throw new ArgumentNullException (nameof (keywords));
|
|
|
|
Keywords = keywords;
|
|
Flags = flags;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="MailKit.MessageFlagsChangedEventArgs"/> class.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a new <see cref="MessageFlagsChangedEventArgs"/>.
|
|
/// </remarks>
|
|
/// <param name="index">The message index.</param>
|
|
/// <param name="flags">The message flags.</param>
|
|
/// <param name="modseq">The modification sequence value.</param>
|
|
/// <exception cref="System.ArgumentOutOfRangeException">
|
|
/// <paramref name="index"/> is out of range.
|
|
/// </exception>
|
|
public MessageFlagsChangedEventArgs (int index, MessageFlags flags, ulong modseq) : base (index)
|
|
{
|
|
Keywords = new HashSet<string> (StringComparer.OrdinalIgnoreCase);
|
|
ModSeq = modseq;
|
|
Flags = flags;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="MailKit.MessageFlagsChangedEventArgs"/> class.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a new <see cref="MessageFlagsChangedEventArgs"/>.
|
|
/// </remarks>
|
|
/// <param name="index">The message index.</param>
|
|
/// <param name="flags">The message flags.</param>
|
|
/// <param name="keywords">The user-defined message flags.</param>
|
|
/// <param name="modseq">The modification sequence value.</param>
|
|
/// <exception cref="System.ArgumentNullException">
|
|
/// <paramref name="keywords"/> is <c>null</c>.
|
|
/// </exception>
|
|
/// <exception cref="System.ArgumentOutOfRangeException">
|
|
/// <paramref name="index"/> is out of range.
|
|
/// </exception>
|
|
public MessageFlagsChangedEventArgs (int index, MessageFlags flags, HashSet<string> keywords, ulong modseq) : base (index)
|
|
{
|
|
if (keywords == null)
|
|
throw new ArgumentNullException (nameof (keywords));
|
|
|
|
Keywords = keywords;
|
|
ModSeq = modseq;
|
|
Flags = flags;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="MailKit.MessageFlagsChangedEventArgs"/> class.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a new <see cref="MessageFlagsChangedEventArgs"/>.
|
|
/// </remarks>
|
|
/// <param name="index">The message index.</param>
|
|
/// <param name="uid">The unique id of the message.</param>
|
|
/// <param name="flags">The message flags.</param>
|
|
/// <exception cref="System.ArgumentOutOfRangeException">
|
|
/// <paramref name="index"/> is out of range.
|
|
/// </exception>
|
|
public MessageFlagsChangedEventArgs (int index, UniqueId uid, MessageFlags flags) : base (index, uid)
|
|
{
|
|
Keywords = new HashSet<string> (StringComparer.OrdinalIgnoreCase);
|
|
Flags = flags;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="MailKit.MessageFlagsChangedEventArgs"/> class.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a new <see cref="MessageFlagsChangedEventArgs"/>.
|
|
/// </remarks>
|
|
/// <param name="index">The message index.</param>
|
|
/// <param name="uid">The unique id of the message.</param>
|
|
/// <param name="flags">The message flags.</param>
|
|
/// <param name="keywords">The user-defined message flags.</param>
|
|
/// <exception cref="System.ArgumentNullException">
|
|
/// <paramref name="keywords"/> is <c>null</c>.
|
|
/// </exception>
|
|
/// <exception cref="System.ArgumentOutOfRangeException">
|
|
/// <paramref name="index"/> is out of range.
|
|
/// </exception>
|
|
public MessageFlagsChangedEventArgs (int index, UniqueId uid, MessageFlags flags, HashSet<string> keywords) : base (index, uid)
|
|
{
|
|
if (keywords == null)
|
|
throw new ArgumentNullException (nameof (keywords));
|
|
|
|
Keywords = keywords;
|
|
Flags = flags;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="MailKit.MessageFlagsChangedEventArgs"/> class.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a new <see cref="MessageFlagsChangedEventArgs"/>.
|
|
/// </remarks>
|
|
/// <param name="index">The message index.</param>
|
|
/// <param name="uid">The unique id of the message.</param>
|
|
/// <param name="flags">The message flags.</param>
|
|
/// <param name="modseq">The modification sequence value.</param>
|
|
/// <exception cref="System.ArgumentOutOfRangeException">
|
|
/// <paramref name="index"/> is out of range.
|
|
/// </exception>
|
|
public MessageFlagsChangedEventArgs (int index, UniqueId uid, MessageFlags flags, ulong modseq) : base (index, uid)
|
|
{
|
|
Keywords = new HashSet<string> (StringComparer.OrdinalIgnoreCase);
|
|
ModSeq = modseq;
|
|
Flags = flags;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="MailKit.MessageFlagsChangedEventArgs"/> class.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Creates a new <see cref="MessageFlagsChangedEventArgs"/>.
|
|
/// </remarks>
|
|
/// <param name="index">The message index.</param>
|
|
/// <param name="uid">The unique id of the message.</param>
|
|
/// <param name="flags">The message flags.</param>
|
|
/// <param name="keywords">The user-defined message flags.</param>
|
|
/// <param name="modseq">The modification sequence value.</param>
|
|
/// <exception cref="System.ArgumentNullException">
|
|
/// <paramref name="keywords"/> is <c>null</c>.
|
|
/// </exception>
|
|
/// <exception cref="System.ArgumentOutOfRangeException">
|
|
/// <paramref name="index"/> is out of range.
|
|
/// </exception>
|
|
public MessageFlagsChangedEventArgs (int index, UniqueId uid, MessageFlags flags, HashSet<string> keywords, ulong modseq) : base (index, uid)
|
|
{
|
|
if (keywords == null)
|
|
throw new ArgumentNullException (nameof (keywords));
|
|
|
|
Keywords = keywords;
|
|
ModSeq = modseq;
|
|
Flags = flags;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the updated message flags.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Gets the updated message flags.
|
|
/// </remarks>
|
|
/// <value>The updated message flags.</value>
|
|
public MessageFlags Flags {
|
|
get; internal set;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the updated user-defined message flags.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Gets the updated user-defined message flags.
|
|
/// </remarks>
|
|
/// <value>The updated user-defined message flags.</value>
|
|
public HashSet<string> Keywords {
|
|
get; private set;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the updated user-defined message flags.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Gets the updated user-defined message flags.
|
|
/// </remarks>
|
|
/// <value>The updated user-defined message flags.</value>
|
|
[Obsolete ("Use Keywords instead.")]
|
|
public HashSet<string> UserFlags {
|
|
get { return Keywords; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the updated mod-sequence value of the message, if available.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Gets the updated mod-sequence value of the message, if available.
|
|
/// </remarks>
|
|
/// <value>The mod-sequence value.</value>
|
|
public ulong? ModSeq {
|
|
get; internal set;
|
|
}
|
|
}
|
|
}
|