EmailMailbox Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents an email mailbox located on a remote email server.
public ref class EmailMailbox sealed/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class EmailMailbox final[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class EmailMailboxPublic NotInheritable Class EmailMailbox- Inheritance
- Attributes
Windows requirements
| Device family |
Windows 10 (introduced in 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
| App capabilities |
email
emailSystem
|
Remarks
The functionality described in this topic is not available to all UWP apps. As part of the store app submission process, Microsoft must approve your use of these APIs and provision your developer account before you can publish an app that uses them.
Version history
| Windows version | SDK version | Value added |
|---|---|---|
| 1511 | 10586 | ResolveRecipientsAsync |
| 1511 | 10586 | TryCreateFolderAsync |
| 1511 | 10586 | TryDeleteFolderAsync |
| 1511 | 10586 | TryEmptyFolderAsync |
| 1511 | 10586 | ValidateCertificatesAsync |
| 1607 | 14393 | RegisterSyncManagerAsync |
| 1709 | 16299 | GetChangeTracker |
Properties
| Capabilities |
Gets the capabilities associated with the mailbox. |
| ChangeTracker |
Gets the EmailMailboxChangeTracker for this mailbox. |
| DisplayName |
Gets or sets the name for this mailbox that is suitable for displaying. |
| Id |
Gets the ID for this mailbox. |
| IsDataEncryptedUnderLock |
Gets a Boolean value that indicates if email data is encrypted when the device is locked. |
| IsOwnedByCurrentApp |
Gets a Boolean value that indicates if this mailbox is owned by the current app. |
| LinkedMailboxId |
Gets the identifier for a mailbox linked to this one. |
| MailAddress |
Gets or sets the email address for the mailbox. |
| MailAddressAliases |
Gets the list of email aliases associated with this mailbox. |
| NetworkAccountId |
Gets the identifier of the email mailbox account within its network. |
| NetworkId |
Gets the identifier of the network associated with this email mailbox. |
| OtherAppReadAccess |
Gets or sets the read access level to this mailbox for other apps. |
| OtherAppWriteAccess |
Gets or sets the write access level to this mailbox for other apps. |
| Policies |
Gets the security policies for attachments in this mailbox. |
| SourceDisplayName |
Gets the display name of the source mailbox. |
| SyncManager |
Gets the sync manager for the mailbox. |
| UserDataAccountId |
Gets the ID of the user data account for the mailbox. |
Methods
| ChangeMessageFlagStateAsync(String, EmailFlagState) |
Asynchronously changes the flag state of an email message. |
| CreateResponseMessageAsync(String, EmailMessageResponseKind, String, EmailMessageBodyKind, String) |
Creates a new response email such as Reply, Reply All, Forward, and so on. |
| DeleteAsync() |
Asynchronously deletes the mailbox. |
| DeleteMessageAsync(String) |
Asynchronously deletes an email message from the mailbox. |
| DownloadAttachmentAsync(String) |
Asynchronously downloads an email attachment. |
| DownloadMessageAsync(String) |
Asynchronously downloads the specified email message. |
| GetChangeTracker(String) |
Gets a EmailMailboxChangeTracker that provides functionality for monitoring changes to items in the EmailMailbox. |
| GetConversationAsync(String) |
Asynchronously gets the specified email conversation. |
| GetConversationReader() |
Gets or creates an email conversation reader for this mailbox if one does not already exist. |
| GetConversationReader(EmailQueryOptions) |
Gets or creates an email conversation reader for this mailbox using the specified query options. |
| GetFolderAsync(String) |
Asynchronously gets the specified email folder. |
| GetMessageAsync(String) |
Asynchronously gets the specified email message. |
| GetMessageReader() |
Gets or creates an email message reader for this mailbox if one does not already exist. |
| GetMessageReader(EmailQueryOptions) |
Gets or creates an email conversation reader for this mailbox using the specified query options. |
| GetSpecialFolderAsync(EmailSpecialFolderKind) |
Asynchronously get a special email folder such as Inbox, Outbox, Drafts and so on. |
| MarkFolderAsSeenAsync(String) |
Asynchronously marks all the messages in a folder as seen. |
| MarkFolderSyncEnabledAsync(String, Boolean) |
Asynchronously marks a folder as sync enabled or disabled. |
| MarkMessageAsSeenAsync(String) |
Asynchronously marks an email message as seen. |
| MarkMessageReadAsync(String, Boolean) |
Asynchronously marks an email message as read or unread. |
| RegisterSyncManagerAsync() |
Asynchronously registers this mailbox as a sync provider. |
| ResolveRecipientsAsync(IIterable<String>) |
Resolves a list of one or more email addresses. |
| SaveAsync() |
Asynchronously saves the mailbox to the email store. |
| SaveDraftAsync(EmailMessage) |
Asynchronously saves a draft email message. |
| SendMessageAsync(EmailMessage, Boolean) |
Asynchronously sends the specified email message. |
| SendMessageAsync(EmailMessage) |
Asynchronously sends the specified email message. |
| TryCreateFolderAsync(String, String) |
Asynchronously attempts to create a new email folder. |
| TryDeleteFolderAsync(String) |
Asynchronously attempts to delete an email folder. |
| TryEmptyFolderAsync(String) |
Asynchronously attempt to delete the contents of an email folder. |
| TryForwardMeetingAsync(EmailMessage, IIterable<EmailRecipient>, String, EmailMessageBodyKind, String, String) |
Asynchronously attempts to forward a meeting request. |
| TryGetAutoReplySettingsAsync(EmailMailboxAutoReplyMessageResponseKind) |
Asynchronously attempts to get the auto-reply settings for the mailbox. |
| TryMoveFolderAsync(String, String, String) |
Asynchronously attempts to move the specified email folder and rename it in the process. |
| TryMoveFolderAsync(String, String) |
Asynchronously attempts to move the specified email folder. |
| TryMoveMessageAsync(String, String) |
Asynchronously attempts to move the specified email message. |
| TryProposeNewTimeForMeetingAsync(EmailMessage, DateTime, TimeSpan, String, String) |
Asynchronously attempts to send a meeting request proposing a new time. |
| TrySetAutoReplySettingsAsync(EmailMailboxAutoReplySettings) |
Asynchronously attempts to set the auto-reply settings for the mailbox. |
| TryUpdateMeetingResponseAsync(EmailMessage, EmailMeetingResponseType, String, String, Boolean) |
Asynchronously attempts to respond to a meeting request. |
| ValidateCertificatesAsync(IIterable<Certificate>) |
Validates the certificate against the sync provider service. |
Events
| MailboxChanged |
Occurs when the mailbox has changed. |