Class UserMailCollection

Namespace

Tharga.Team.MongoDB

Assembly

Tharga.Team.MongoDB.dll

Queued mail to users, default collection name UserMail.

public class UserMailCollection : DiskRepositoryCollectionBase<UserMailEntity>, IUserMailCollection, IDiskRepositoryCollection<UserMailEntity>, IDiskRepositoryCollection<UserMailEntity, ObjectId>, IRepositoryCollection<UserMailEntity, ObjectId>, IReadOnlyRepositoryCollection<UserMailEntity, ObjectId>, IRepositoryCollection, IReadOnlyRepositoryCollection

Inheritance

object

RepositoryCollectionBase

RepositoryCollectionBase<UserMailEntity, ObjectId>

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>

DiskRepositoryCollectionBase<UserMailEntity>

UserMailCollection

Implements

IUserMailCollection

IDiskRepositoryCollection<UserMailEntity>

IDiskRepositoryCollection<UserMailEntity, ObjectId>

IRepositoryCollection<UserMailEntity, ObjectId>

IReadOnlyRepositoryCollection<UserMailEntity, ObjectId>

IRepositoryCollection

IReadOnlyRepositoryCollection

Inherited Members

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.ExecuteAsync<T>(string, Func<IMongoCollection<UserMailEntity>, IClientSessionHandle, CancellationToken, Task<(T Data, int Count)>>, Operation, CancellationToken, FilterDefinition<UserMailEntity>, IClientSessionHandle)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetAsync(Expression<Func<UserMailEntity, bool>>, Options<UserMailEntity>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetAsync(FilterDefinition<UserMailEntity>, Options<UserMailEntity>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetProjectionAsync<T>(Expression<Func<UserMailEntity, bool>>, Options<UserMailEntity>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetProjectionAsync<T>(FilterDefinition<UserMailEntity>, Options<UserMailEntity>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.QueryAsync(Expression<Func<UserMailEntity, bool>>, Options<UserMailEntity>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetManyAsync(Expression<Func<UserMailEntity, bool>>, Options<UserMailEntity>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.QueryAsync(FilterDefinition<UserMailEntity>, Options<UserMailEntity>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetManyAsync(FilterDefinition<UserMailEntity>, Options<UserMailEntity>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetManyProjectionAsync<T>(Expression<Func<UserMailEntity, bool>>, Options<UserMailEntity>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetManyProjectionAsync<T>(FilterDefinition<UserMailEntity>, Options<UserMailEntity>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetOneAsync(ObjectId, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetOneAsync(Expression<Func<UserMailEntity, bool>>, OneOption<UserMailEntity>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetOneAsync(FilterDefinition<UserMailEntity>, OneOption<UserMailEntity>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.CountAsync(Expression<Func<UserMailEntity, bool>>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.CountAsync(FilterDefinition<UserMailEntity>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.EstimatedCountAsync(CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.SumAsync(Expression<Func<UserMailEntity, decimal>>, Expression<Func<UserMailEntity, bool>>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.AvgAsync(Expression<Func<UserMailEntity, decimal>>, Expression<Func<UserMailEntity, bool>>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.MinAsync<TField>(Expression<Func<UserMailEntity, TField>>, Expression<Func<UserMailEntity, bool>>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.MaxAsync<TField>(Expression<Func<UserMailEntity, TField>>, Expression<Func<UserMailEntity, bool>>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetSizeAsync(CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetPageAsync(int, PagePosition, Expression<Func<UserMailEntity, bool>>, Expression<Func<UserMailEntity, object>>, bool, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetPageProjectionAsync<T>(int, PagePosition, Expression<Func<UserMailEntity, T>>, Expression<Func<UserMailEntity, bool>>, Expression<Func<UserMailEntity, object>>, bool, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.AddAsync(UserMailEntity, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.TryAddAsync(UserMailEntity, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.AddManyAsync(IEnumerable<UserMailEntity>, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.AddOrReplaceAsync(UserMailEntity, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.ReplaceOneAsync(UserMailEntity, OneOption<UserMailEntity>, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.ReplaceOneAsync(UserMailEntity, FilterDefinition<UserMailEntity>, OneOption<UserMailEntity>, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.UpdateOneAsync(ObjectId, UpdateDefinition<UserMailEntity>, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.UpdateOneAsync(Expression<Func<UserMailEntity, bool>>, UpdateDefinition<UserMailEntity>, OneOption<UserMailEntity>, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.UpdateOneAsync(FilterDefinition<UserMailEntity>, UpdateDefinition<UserMailEntity>, OneOption<UserMailEntity>, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.UpdateManyAsync(Expression<Func<UserMailEntity, bool>>, UpdateDefinition<UserMailEntity>, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.UpdateManyAsync(FilterDefinition<UserMailEntity>, UpdateDefinition<UserMailEntity>, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.DeleteOneAsync(ObjectId, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.DeleteOneAsync(Expression<Func<UserMailEntity, bool>>, OneOption<UserMailEntity>, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.DeleteOneAsync(FilterDefinition<UserMailEntity>, OneOption<UserMailEntity>, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.DeleteManyAsync(Expression<Func<UserMailEntity, bool>>, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.DeleteManyAsync(FilterDefinition<UserMailEntity>, IClientSessionHandle, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetCollection()

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.ExecuteAsync<T>(Func<IMongoCollection<UserMailEntity>, Task<T>>, Operation)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.ExecuteAsync<T>(Func<IMongoCollection<UserMailEntity>, CancellationToken, Task<T>>, Operation, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.ExecuteManyAsync<T>(Func<IMongoCollection<UserMailEntity>, CancellationToken, Task<IAsyncCursor<T>>>, CancellationToken)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.DropCollectionAsync()

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetDirtyAsync()

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.GetFailedIndices()

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.DropEmptyAsync(IMongoCollection<UserMailEntity>)

DiskRepositoryCollectionBase<UserMailEntity, ObjectId>.FetchSize

RepositoryCollectionBase<UserMailEntity, ObjectId>._mongoDbServiceFactory

RepositoryCollectionBase<UserMailEntity, ObjectId>._logger

RepositoryCollectionBase<UserMailEntity, ObjectId>._databaseContext

RepositoryCollectionBase<UserMailEntity, ObjectId>._mongoDbService

RepositoryCollectionBase<UserMailEntity, ObjectId>.GetExceptionLogLevel(Exception, string)

RepositoryCollectionBase<UserMailEntity, ObjectId>.InitAsync(IMongoCollection<UserMailEntity>)

RepositoryCollectionBase<UserMailEntity, ObjectId>.ProtectedCollectionName

RepositoryCollectionBase<UserMailEntity, ObjectId>.CollectionName

RepositoryCollectionBase<UserMailEntity, ObjectId>.DatabasePart

RepositoryCollectionBase<UserMailEntity, ObjectId>.ConfigurationName

RepositoryCollectionBase<UserMailEntity, ObjectId>.AutoClean

RepositoryCollectionBase<UserMailEntity, ObjectId>.CleanOnStartup

RepositoryCollectionBase<UserMailEntity, ObjectId>.CreateCollectionStrategy

RepositoryCollectionBase<UserMailEntity, ObjectId>.Indices

RepositoryCollectionBase<UserMailEntity, ObjectId>.CoreIndices

RepositoryCollectionBase<UserMailEntity, ObjectId>.Types

RepositoryCollectionBase.ConfigurationName

RepositoryCollectionBase.ActionEvent

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Due mail is found by status and due time; a deduplication key is unique where one was given; a batch's mail by its batch and status; a user's history by their key or address, newest first; the mail about a team by the team, newest first, the rest of the global log being read newest first by id; a sent mail by the Message-ID a bounce report names; how often each category was sent by status, completion, category and recipient, read from the index alone, and how often each contact category was by kind, status, completion, category and address, read from an index of its own; and a mail that is done expires after UserMailRetention, while a queued one never does.

Constructors

UserMailCollection(IMongoDbServiceFactory, ILogger<UserMailCollection>, IOptions<ThargaTeamOptions>)

Creates the collection under the configured name and retention.

public UserMailCollection(IMongoDbServiceFactory mongoDbServiceFactory, ILogger<UserMailCollection> logger, IOptions<ThargaTeamOptions> options = null)

Parameters

mongoDbServiceFactory IMongoDbServiceFactory

logger ILogger<UserMailCollection>

options IOptions<ThargaTeamOptions>

Properties

CollectionName

public override string CollectionName { get; }

Property Value

string

Indices

public override IEnumerable<CreateIndexModel<UserMailEntity>> Indices { get; }

Property Value

IEnumerable<CreateIndexModel<UserMailEntity>>

Retention

How long a mail is kept once it is done.

public TimeSpan Retention { get; }

Property Value

TimeSpan

Methods

CountSentByCategoryAsync(DateTime, CancellationToken)

For each category, the mails sent or bounced to a user since since, and to how many users, in one aggregation on the server.

public Task<IReadOnlyList<UserMailCategorySent>> CountSentByCategoryAsync(DateTime since, CancellationToken cancellationToken = default)

Parameters

since DateTime

cancellationToken CancellationToken

Returns

Task<IReadOnlyList<UserMailCategorySent>>

CountSentToContactsByCategoryAsync(DateTime, CancellationToken)

For each contact category, the contact mails sent or bounced since since, and to how many distinct addresses, in one aggregation on the server.

public Task<IReadOnlyList<UserMailCategorySent>> CountSentToContactsByCategoryAsync(DateTime since, CancellationToken cancellationToken = default)

Parameters

since DateTime

cancellationToken CancellationToken

Returns

Task<IReadOnlyList<UserMailCategorySent>>