Method ResolveAlias

Namespace: MailFathom.Application.Folders

Assembly: MailFathom.Application.dll

ResolveAlias(MailAccountId, MailFolderReference)

Resolves what a caller named into the alias every later read and write of the folder is expressed in.

public MailFolderAlias ResolveAlias(MailAccountId accountId, MailFolderReference reference)

Parameters

accountId MailAccountId: The account the folder belongs to.
reference MailFolderReference: The alias or role the caller named.

Returns

MailFolderAlias: The alias of the folder the reference means.

Remarks

An alias configuration does not map is returned unchanged rather than refused, which keeps a folder filter naming an unknown folder answering with nothing. Every caller that only needs the name uses this, so nothing has to decide for itself what an unmapped alias means.

Exceptions

ArgumentException: Thrown when reference is the unspecified struct default.
MailFolderRoleUnmappedException: Thrown when the reference names a role no folder of the account plays.