EmailMailbox
EmailMailbox
EmailMailbox
EmailMailbox
Class
Definition
Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Prerelease APIs are identified by a Prerelease label.
[Contains prerelease APIs.]
Represents an email mailbox located on a remote email server.
public : sealed class EmailMailbox : IEmailMailbox, IEmailMailbox2, IEmailMailbox3, IEmailMailbox4public sealed class EmailMailbox : IEmailMailbox, IEmailMailbox2, IEmailMailbox3, IEmailMailbox4Public NotInheritable Class EmailMailbox Implements IEmailMailbox, IEmailMailbox2, IEmailMailbox3, IEmailMailbox4// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime.
Properties
Capabilities Capabilities Capabilities Capabilities
Gets the capabilities associated with the mailbox.
public : EmailMailboxCapabilities Capabilities { get; }public EmailMailboxCapabilities Capabilities { get; }Public ReadOnly Property Capabilities As EmailMailboxCapabilities// You can use this property in JavaScript.
- Value
- EmailMailboxCapabilities EmailMailboxCapabilities EmailMailboxCapabilities EmailMailboxCapabilities
The capabilities associated with the mailbox.
ChangeTracker ChangeTracker ChangeTracker ChangeTracker
Gets the EmailMailboxChangeTracker for this mailbox.
public : EmailMailboxChangeTracker ChangeTracker { get; }public EmailMailboxChangeTracker ChangeTracker { get; }Public ReadOnly Property ChangeTracker As EmailMailboxChangeTracker// You can use this property in JavaScript.
- Value
- EmailMailboxChangeTracker EmailMailboxChangeTracker EmailMailboxChangeTracker EmailMailboxChangeTracker
The change tracker for this mailbox.
DisplayName DisplayName DisplayName DisplayName
Gets or sets the name for this mailbox that is suitable for displaying.
public : PlatForm::String DisplayName { get; set; }public string DisplayName { get; set; }Public ReadWrite Property DisplayName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The name for this mailbox that is suitable for displaying.
Id Id Id Id
Gets the ID for this mailbox.
public : PlatForm::String Id { get; }public string Id { get; }Public ReadOnly Property Id As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The ID for this mailbox.
IsDataEncryptedUnderLock IsDataEncryptedUnderLock IsDataEncryptedUnderLock IsDataEncryptedUnderLock
Gets a Boolean value that indicates if email data is encrypted when the device is locked.
public : PlatForm::Boolean IsDataEncryptedUnderLock { get; }public bool IsDataEncryptedUnderLock { get; }Public ReadOnly Property IsDataEncryptedUnderLock As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
Boolean value that indicates if email data is encrypted when the device is locked.
IsOwnedByCurrentApp IsOwnedByCurrentApp IsOwnedByCurrentApp IsOwnedByCurrentApp
Gets a Boolean value that indicates if this mailbox is owned by the current app.
public : PlatForm::Boolean IsOwnedByCurrentApp { get; }public bool IsOwnedByCurrentApp { get; }Public ReadOnly Property IsOwnedByCurrentApp As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
Boolean value that indicates if this mailbox is owned by the current app.
LinkedMailboxId LinkedMailboxId LinkedMailboxId LinkedMailboxId
Gets the identifier for a mailbox linked to this one.
public : PlatForm::String LinkedMailboxId { get; }public string LinkedMailboxId { get; }Public ReadOnly Property LinkedMailboxId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The identifier for a mailbox linked to this one.
MailAddress MailAddress MailAddress MailAddress
Gets or sets the email address for the mailbox.
public : PlatForm::String MailAddress { get; set; }public string MailAddress { get; set; }Public ReadWrite Property MailAddress As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The email address for the mailbox.
MailAddressAliases MailAddressAliases MailAddressAliases MailAddressAliases
Gets the list of email aliases associated with this mailbox.
public : IVector<string> MailAddressAliases { get; }public IList<string> MailAddressAliases { get; }Public ReadOnly Property MailAddressAliases As IList<string>// You can use this property in JavaScript.
- Value
- IVector<PlatForm::String> IList<string> IList<string> IList<string>
The list of email aliases associated with this mailbox.
NetworkAccountId NetworkAccountId NetworkAccountId NetworkAccountId
Gets the identifier of the email mailbox account within its network.
public : PlatForm::String NetworkAccountId { get; }public string NetworkAccountId { get; }Public ReadOnly Property NetworkAccountId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The identifier of the email mailbox account within its network.
NetworkId NetworkId NetworkId NetworkId
Gets the identifier of the network associated with this email mailbox.
public : PlatForm::String NetworkId { get; }public string NetworkId { get; }Public ReadOnly Property NetworkId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The identifier of the network associated with this email mailbox.
OtherAppReadAccess OtherAppReadAccess OtherAppReadAccess OtherAppReadAccess
Gets or sets the read access level to this mailbox for other apps.
public : EmailMailboxOtherAppReadAccess OtherAppReadAccess { get; set; }public EmailMailboxOtherAppReadAccess OtherAppReadAccess { get; set; }Public ReadWrite Property OtherAppReadAccess As EmailMailboxOtherAppReadAccess// You can use this property in JavaScript.
- Value
- EmailMailboxOtherAppReadAccess EmailMailboxOtherAppReadAccess EmailMailboxOtherAppReadAccess EmailMailboxOtherAppReadAccess
The read access level to this mailbox for other apps.
OtherAppWriteAccess OtherAppWriteAccess OtherAppWriteAccess OtherAppWriteAccess
Gets or sets the write access level to this mailbox for other apps.
public : EmailMailboxOtherAppWriteAccess OtherAppWriteAccess { get; set; }public EmailMailboxOtherAppWriteAccess OtherAppWriteAccess { get; set; }Public ReadWrite Property OtherAppWriteAccess As EmailMailboxOtherAppWriteAccess// You can use this property in JavaScript.
- Value
- EmailMailboxOtherAppWriteAccess EmailMailboxOtherAppWriteAccess EmailMailboxOtherAppWriteAccess EmailMailboxOtherAppWriteAccess
The write access level to this mailbox for other apps.
Policies Policies Policies Policies
Gets the security policies for attachments in this mailbox.
public : EmailMailboxPolicies Policies { get; }public EmailMailboxPolicies Policies { get; }Public ReadOnly Property Policies As EmailMailboxPolicies// You can use this property in JavaScript.
The security policies for attachments in this mailbox.
SourceDisplayName SourceDisplayName SourceDisplayName SourceDisplayName
Gets the display name of the source mailbox.
public : PlatForm::String SourceDisplayName { get; }public string SourceDisplayName { get; }Public ReadOnly Property SourceDisplayName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The display name of the source mailbox.
SyncManager SyncManager SyncManager SyncManager
Gets the sync manager for the mailbox.
public : EmailMailboxSyncManager SyncManager { get; }public EmailMailboxSyncManager SyncManager { get; }Public ReadOnly Property SyncManager As EmailMailboxSyncManager// You can use this property in JavaScript.
- Value
- EmailMailboxSyncManager EmailMailboxSyncManager EmailMailboxSyncManager EmailMailboxSyncManager
The sync manager for the mailbox.
UserDataAccountId UserDataAccountId UserDataAccountId UserDataAccountId
Gets the ID of the user data account for the mailbox.
public : PlatForm::String UserDataAccountId { get; }public string UserDataAccountId { get; }Public ReadOnly Property UserDataAccountId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The ID of the user data account for the mailbox.
Methods
ChangeMessageFlagStateAsync(String, EmailFlagState) ChangeMessageFlagStateAsync(String, EmailFlagState) ChangeMessageFlagStateAsync(String, EmailFlagState) ChangeMessageFlagStateAsync(String, EmailFlagState)
Asynchronously changes the flag state of an email message.
public : IAsyncAction ChangeMessageFlagStateAsync(PlatForm::String messageId, EmailFlagState flagState)public IAsyncAction ChangeMessageFlagStateAsync(String messageId, EmailFlagState flagState)Public Function ChangeMessageFlagStateAsync(messageId As String, flagState As EmailFlagState) As IAsyncAction// You can use this method in JavaScript.
- messageId
- PlatForm::String String String String
The ID of the email message to change.
The new email flag state.
An async action indicating that the operation has completed.
CreateResponseMessageAsync(String, EmailMessageResponseKind, String, EmailMessageBodyKind, String) CreateResponseMessageAsync(String, EmailMessageResponseKind, String, EmailMessageBodyKind, String) CreateResponseMessageAsync(String, EmailMessageResponseKind, String, EmailMessageBodyKind, String) CreateResponseMessageAsync(String, EmailMessageResponseKind, String, EmailMessageBodyKind, String)
Creates a new response email such as Reply, Reply All, Forward, and so on.
public : IAsyncOperation<EmailMessage> CreateResponseMessageAsync(PlatForm::String messageId, EmailMessageResponseKind responseType, PlatForm::String subject, EmailMessageBodyKind responseHeaderType, PlatForm::String responseHeader)public IAsyncOperation<EmailMessage> CreateResponseMessageAsync(String messageId, EmailMessageResponseKind responseType, String subject, EmailMessageBodyKind responseHeaderType, String responseHeader)Public Function CreateResponseMessageAsync(messageId As String, responseType As EmailMessageResponseKind, subject As String, responseHeaderType As EmailMessageBodyKind, responseHeader As String) As IAsyncOperation( Of EmailMessage )// You can use this method in JavaScript.
- messageId
- PlatForm::String String String String
The ID of the message to which to respond.
- responseType
- EmailMessageResponseKind EmailMessageResponseKind EmailMessageResponseKind EmailMessageResponseKind
The type of response such as Reply, Reply All, Forward, and so on.
- subject
- PlatForm::String String String String
The subject for the response message.
- responseHeaderType
- EmailMessageBodyKind EmailMessageBodyKind EmailMessageBodyKind EmailMessageBodyKind
The format of the email body such as plain text or HTML.
- responseHeader
- PlatForm::String String String String
The header for the response message.
The newly created response email message.
DeleteAsync() DeleteAsync() DeleteAsync() DeleteAsync()
Asynchronously deletes the mailbox.
public : IAsyncAction DeleteAsync()public IAsyncAction DeleteAsync()Public Function DeleteAsync() As IAsyncAction// You can use this method in JavaScript.
An async action indicating that the operation has completed.
DeleteMessageAsync(String) DeleteMessageAsync(String) DeleteMessageAsync(String) DeleteMessageAsync(String)
Asynchronously deletes an email message from the mailbox.
public : IAsyncAction DeleteMessageAsync(PlatForm::String messageId)public IAsyncAction DeleteMessageAsync(String messageId)Public Function DeleteMessageAsync(messageId As String) As IAsyncAction// You can use this method in JavaScript.
- messageId
- PlatForm::String String String String
The ID of the email message to delete.
An async action indicating that the operation has completed.
DownloadAttachmentAsync(String) DownloadAttachmentAsync(String) DownloadAttachmentAsync(String) DownloadAttachmentAsync(String)
Asynchronously downloads an email attachment.
public : IAsyncAction DownloadAttachmentAsync(PlatForm::String attachmentId)public IAsyncAction DownloadAttachmentAsync(String attachmentId)Public Function DownloadAttachmentAsync(attachmentId As String) As IAsyncAction// You can use this method in JavaScript.
- attachmentId
- PlatForm::String String String String
The ID of the attachment to download.
An async action indicating that the operation has completed.
DownloadMessageAsync(String) DownloadMessageAsync(String) DownloadMessageAsync(String) DownloadMessageAsync(String)
Asynchronously downloads the specified email message.
public : IAsyncAction DownloadMessageAsync(PlatForm::String messageId)public IAsyncAction DownloadMessageAsync(String messageId)Public Function DownloadMessageAsync(messageId As String) As IAsyncAction// You can use this method in JavaScript.
- messageId
- PlatForm::String String String String
The ID of the message to download.
An async action indicating that the operation has completed.
GetChangeTracker(String) GetChangeTracker(String) GetChangeTracker(String) GetChangeTracker(String)
Prerelease. Gets a EmailMailboxChangeTracker that provides functionality for monitoring changes to items in the EmailMailbox.
public : EmailMailboxChangeTracker GetChangeTracker(PlatForm::String identity)public EmailMailboxChangeTracker GetChangeTracker(String identity)Public Function GetChangeTracker(identity As String) As EmailMailboxChangeTracker// You can use this method in JavaScript.
- identity
- PlatForm::String String String String
A string that identifies the EmailMailboxChangeTracker instance in the EmailMailbox.
A EmailMailboxChangeTracker that provides functionality for monitoring changes to items in the EmailMailbox.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
You can create multiple EmailMailboxChangeTracker instances by using this method. If you pass in a string that identifies a EmailMailboxChangeTracker that already exists in the EmailMailbox, this method returns that instance. If the string that you pass into this method does not identify an existing an existing EmailMailboxChangeTracker, this method returns a new EmailMailboxChangeTracker.
You can use the IsTracking property of the EmailMailboxChangeTracker to determine whether change tracking is enabled for the EmailMailboxChangeTracker.
GetConversationAsync(String) GetConversationAsync(String) GetConversationAsync(String) GetConversationAsync(String)
Asynchronously gets the specified email conversation.
public : IAsyncOperation<EmailConversation> GetConversationAsync(PlatForm::String id)public IAsyncOperation<EmailConversation> GetConversationAsync(String id)Public Function GetConversationAsync(id As String) As IAsyncOperation( Of EmailConversation )// You can use this method in JavaScript.
- id
- PlatForm::String String String String
The ID of the email conversation to retrieve.
Returns the email conversation specified by the id parameter.
GetConversationReader() GetConversationReader() GetConversationReader() GetConversationReader()
Gets or creates an email conversation reader for this mailbox if one does not already exist.
public : EmailConversationReader GetConversationReader()public EmailConversationReader GetConversationReader()Public Function GetConversationReader() As EmailConversationReader// You can use this method in JavaScript.
The email conversation reader.
- See Also
GetConversationReader(EmailQueryOptions) GetConversationReader(EmailQueryOptions) GetConversationReader(EmailQueryOptions) GetConversationReader(EmailQueryOptions)
Gets or creates an email conversation reader for this mailbox using the specified query options.
public : EmailConversationReader GetConversationReader(EmailQueryOptions options)public EmailConversationReader GetConversationReader(EmailQueryOptions options)Public Function GetConversationReader(options As EmailQueryOptions) As EmailConversationReader// You can use this method in JavaScript.
The email query options to use when creating the conversation reader.
The new or existing conversation reader.
- See Also
GetFolderAsync(String) GetFolderAsync(String) GetFolderAsync(String) GetFolderAsync(String)
Asynchronously gets the specified email folder.
public : IAsyncOperation<EmailFolder> GetFolderAsync(PlatForm::String id)public IAsyncOperation<EmailFolder> GetFolderAsync(String id)Public Function GetFolderAsync(id As String) As IAsyncOperation( Of EmailFolder )// You can use this method in JavaScript.
- id
- PlatForm::String String String String
The ID of the folder to retrieve.
The email folder specified in the id parameter.
GetMessageAsync(String) GetMessageAsync(String) GetMessageAsync(String) GetMessageAsync(String)
Asynchronously gets the specified email message.
public : IAsyncOperation<EmailMessage> GetMessageAsync(PlatForm::String id)public IAsyncOperation<EmailMessage> GetMessageAsync(String id)Public Function GetMessageAsync(id As String) As IAsyncOperation( Of EmailMessage )// You can use this method in JavaScript.
- id
- PlatForm::String String String String
The ID of the message to retrieve.
The email message specified in the id parameter.
GetMessageReader() GetMessageReader() GetMessageReader() GetMessageReader()
Gets or creates an email message reader for this mailbox if one does not already exist.
public : EmailMessageReader GetMessageReader()public EmailMessageReader GetMessageReader()Public Function GetMessageReader() As EmailMessageReader// You can use this method in JavaScript.
The new or existing email message reader.
- See Also
GetMessageReader(EmailQueryOptions) GetMessageReader(EmailQueryOptions) GetMessageReader(EmailQueryOptions) GetMessageReader(EmailQueryOptions)
Gets or creates an email conversation reader for this mailbox using the specified query options.
public : EmailMessageReader GetMessageReader(EmailQueryOptions options)public EmailMessageReader GetMessageReader(EmailQueryOptions options)Public Function GetMessageReader(options As EmailQueryOptions) As EmailMessageReader// You can use this method in JavaScript.
The email query options to use when creating the message reader.
The new or existing email message reader.
- See Also
GetSpecialFolderAsync(EmailSpecialFolderKind) GetSpecialFolderAsync(EmailSpecialFolderKind) GetSpecialFolderAsync(EmailSpecialFolderKind) GetSpecialFolderAsync(EmailSpecialFolderKind)
Asynchronously get a special email folder such as Inbox, Outbox, Drafts and so on.
public : IAsyncOperation<EmailFolder> GetSpecialFolderAsync(EmailSpecialFolderKind folderType)public IAsyncOperation<EmailFolder> GetSpecialFolderAsync(EmailSpecialFolderKind folderType)Public Function GetSpecialFolderAsync(folderType As EmailSpecialFolderKind) As IAsyncOperation( Of EmailFolder )// You can use this method in JavaScript.
- folderType
- EmailSpecialFolderKind EmailSpecialFolderKind EmailSpecialFolderKind EmailSpecialFolderKind
The type of folder to retrieve.
The matching special email folder in this mailbox.
MarkFolderAsSeenAsync(String) MarkFolderAsSeenAsync(String) MarkFolderAsSeenAsync(String) MarkFolderAsSeenAsync(String)
Asynchronously marks all the messages in a folder as seen.
public : IAsyncAction MarkFolderAsSeenAsync(PlatForm::String folderId)public IAsyncAction MarkFolderAsSeenAsync(String folderId)Public Function MarkFolderAsSeenAsync(folderId As String) As IAsyncAction// You can use this method in JavaScript.
- folderId
- PlatForm::String String String String
The ID of the folder to mark as seen.
An async action indicating that the operation has completed.
MarkFolderSyncEnabledAsync(String, Boolean) MarkFolderSyncEnabledAsync(String, Boolean) MarkFolderSyncEnabledAsync(String, Boolean) MarkFolderSyncEnabledAsync(String, Boolean)
Asynchronously marks a folder as sync enabled or disabled.
public : IAsyncAction MarkFolderSyncEnabledAsync(PlatForm::String folderId, bool isSyncEnabled)public IAsyncAction MarkFolderSyncEnabledAsync(String folderId, Boolean isSyncEnabled)Public Function MarkFolderSyncEnabledAsync(folderId As String, isSyncEnabled As Boolean) As IAsyncAction// You can use this method in JavaScript.
- folderId
- PlatForm::String String String String
The ID of the folder to mark.
- isSyncEnabled
- bool Boolean Boolean Boolean
True to enable to syncing with the server, false to disable syncing.
An async action indicating that the operation has completed.
MarkMessageAsSeenAsync(String) MarkMessageAsSeenAsync(String) MarkMessageAsSeenAsync(String) MarkMessageAsSeenAsync(String)
Asynchronously marks an email message as seen.
public : IAsyncAction MarkMessageAsSeenAsync(PlatForm::String messageId)public IAsyncAction MarkMessageAsSeenAsync(String messageId)Public Function MarkMessageAsSeenAsync(messageId As String) As IAsyncAction// You can use this method in JavaScript.
- messageId
- PlatForm::String String String String
The ID of the message to mark as seen.
An async action indicating that the operation has completed.
MarkMessageReadAsync(String, Boolean) MarkMessageReadAsync(String, Boolean) MarkMessageReadAsync(String, Boolean) MarkMessageReadAsync(String, Boolean)
Asynchronously marks an email message as read or unread.
public : IAsyncAction MarkMessageReadAsync(PlatForm::String messageId, bool isRead)public IAsyncAction MarkMessageReadAsync(String messageId, Boolean isRead)Public Function MarkMessageReadAsync(messageId As String, isRead As Boolean) As IAsyncAction// You can use this method in JavaScript.
- messageId
- PlatForm::String String String String
The ID of the message to mark.
- isRead
- bool Boolean Boolean Boolean
True to mark the message as read, false to mark it as unread.
An async action indicating that the operation has completed.
RegisterSyncManagerAsync() RegisterSyncManagerAsync() RegisterSyncManagerAsync() RegisterSyncManagerAsync()
Asynchronously registers this mailbox as a sync provider.
public : IAsyncAction RegisterSyncManagerAsync()public IAsyncAction RegisterSyncManagerAsync()Public Function RegisterSyncManagerAsync() As IAsyncAction// You can use this method in JavaScript.
An asynchronous registration operation.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
ResolveRecipientsAsync(IIterable)
ResolveRecipientsAsync(IIterable)
ResolveRecipientsAsync(IIterable)
ResolveRecipientsAsync(IIterable)
Resolves a list of one or more email addresses.
public : IAsyncOperation<IVectorView<EmailRecipientResolutionResult>> ResolveRecipientsAsync(IIterable<PlatForm::String> recipients)public IAsyncOperation<IReadOnlyList<EmailRecipientResolutionResult>> ResolveRecipientsAsync(IEnumerable<String> recipients)Public Function ResolveRecipientsAsync(recipients As IEnumerable<String>) As IAsyncOperation( Of IReadOnlyListEmailRecipientResolutionResult )// You can use this method in JavaScript.
- recipients
- IIterable<PlatForm::String> IEnumerable<String> IEnumerable<String> IEnumerable<String>
The list of email addresses.
A list of resolution results. The result list will be in the same order as the input list. See EmailRecipientResolutionResult for more information.
| Device family |
Windows 10 (introduced v10.0.10586.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v2)
|
SaveAsync() SaveAsync() SaveAsync() SaveAsync()
Asynchronously saves the mailbox to the email store.
public : IAsyncAction SaveAsync()public IAsyncAction SaveAsync()Public Function SaveAsync() As IAsyncAction// You can use this method in JavaScript.
An async action indicating that the operation has completed.
SaveDraftAsync(EmailMessage) SaveDraftAsync(EmailMessage) SaveDraftAsync(EmailMessage) SaveDraftAsync(EmailMessage)
Asynchronously saves a draft email message.
public : IAsyncAction SaveDraftAsync(EmailMessage message)public IAsyncAction SaveDraftAsync(EmailMessage message)Public Function SaveDraftAsync(message As EmailMessage) As IAsyncAction// You can use this method in JavaScript.
The draft email message to save.
An async action indicating that the operation has completed.
SendMessageAsync(EmailMessage) SendMessageAsync(EmailMessage) SendMessageAsync(EmailMessage) SendMessageAsync(EmailMessage)
Asynchronously sends the specified email message.
public : IAsyncAction SendMessageAsync(EmailMessage message)public IAsyncAction SendMessageAsync(EmailMessage message)Public Function SendMessageAsync(message As EmailMessage) As IAsyncAction// You can use this method in JavaScript.
The email message to send.
An async action indicating that the operation has completed.
- See Also
SendMessageAsync(EmailMessage, Boolean) SendMessageAsync(EmailMessage, Boolean) SendMessageAsync(EmailMessage, Boolean) SendMessageAsync(EmailMessage, Boolean)
Asynchronously sends the specified email message.
public : IAsyncAction SendMessageAsync(EmailMessage message, bool smartSend)public IAsyncAction SendMessageAsync(EmailMessage message, Boolean smartSend)Public Function SendMessageAsync(message As EmailMessage, smartSend As Boolean) As IAsyncAction// You can use this method in JavaScript.
The email message to send.
- smartSend
- bool Boolean Boolean Boolean
True to send only the updated text, false to include the full message thread.
An async action indicating that the operation has completed.
- See Also
TryCreateFolderAsync(String, String) TryCreateFolderAsync(String, String) TryCreateFolderAsync(String, String) TryCreateFolderAsync(String, String)
Asynchronously attempts to create a new email folder.
public : IAsyncOperation<EmailMailboxCreateFolderResult> TryCreateFolderAsync(PlatForm::String parentFolderId, PlatForm::String name)public IAsyncOperation<EmailMailboxCreateFolderResult> TryCreateFolderAsync(String parentFolderId, String name)Public Function TryCreateFolderAsync(parentFolderId As String, name As String) As IAsyncOperation( Of EmailMailboxCreateFolderResult )// You can use this method in JavaScript.
- parentFolderId
- PlatForm::String String String String
The Id of the parent email folder.
- name
- PlatForm::String String String String
The name for the new folder.
An async operation with an EmailMailboxCreateFolderResult containing the newly created folder and the status of the create operation.
| Device family |
Windows 10 (introduced v10.0.10586.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v2)
|
TryDeleteFolderAsync(String) TryDeleteFolderAsync(String) TryDeleteFolderAsync(String) TryDeleteFolderAsync(String)
Asynchronously attempts to delete an email folder.
public : IAsyncOperation<EmailMailboxDeleteFolderStatus> TryDeleteFolderAsync(PlatForm::String folderId)public IAsyncOperation<EmailMailboxDeleteFolderStatus> TryDeleteFolderAsync(String folderId)Public Function TryDeleteFolderAsync(folderId As String) As IAsyncOperation( Of EmailMailboxDeleteFolderStatus )// You can use this method in JavaScript.
- folderId
- PlatForm::String String String String
The Id of the folder to delete.
An async operation with an EmailMailboxDeleteFolderStatus value representing the status of the delete operation.
| Device family |
Windows 10 (introduced v10.0.10586.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v2)
|
TryEmptyFolderAsync(String) TryEmptyFolderAsync(String) TryEmptyFolderAsync(String) TryEmptyFolderAsync(String)
Asynchronously attempt to delete the contents of an email folder.
public : IAsyncOperation<EmailMailboxEmptyFolderStatus> TryEmptyFolderAsync(PlatForm::String folderId)public IAsyncOperation<EmailMailboxEmptyFolderStatus> TryEmptyFolderAsync(String folderId)Public Function TryEmptyFolderAsync(folderId As String) As IAsyncOperation( Of EmailMailboxEmptyFolderStatus )// You can use this method in JavaScript.
- folderId
- PlatForm::String String String String
The Id of the folder to empty.
An async operation with an EmailMailboxEmptyFolderStatus value representing the status of the delete operation.
| Device family |
Windows 10 (introduced v10.0.10586.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v2)
|
TryForwardMeetingAsync(EmailMessage, IIterable, String, EmailMessageBodyKind, String, String)
TryForwardMeetingAsync(EmailMessage, IIterable, String, EmailMessageBodyKind, String, String)
TryForwardMeetingAsync(EmailMessage, IIterable, String, EmailMessageBodyKind, String, String)
TryForwardMeetingAsync(EmailMessage, IIterable, String, EmailMessageBodyKind, String, String)
Asynchronously attempts to forward a meeting request.
public : IAsyncOperation<PlatForm::Boolean> TryForwardMeetingAsync(EmailMessage meeting, IIterable<EmailRecipient> recipients, PlatForm::String subject, EmailMessageBodyKind forwardHeaderType, PlatForm::String forwardHeader, PlatForm::String comment)public IAsyncOperation<bool> TryForwardMeetingAsync(EmailMessage meeting, IEnumerable<EmailRecipient> recipients, String subject, EmailMessageBodyKind forwardHeaderType, String forwardHeader, String comment)Public Function TryForwardMeetingAsync(meeting As EmailMessage, recipients As IEnumerable<EmailRecipient>, subject As String, forwardHeaderType As EmailMessageBodyKind, forwardHeader As String, comment As String) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
The meeting to forward.
- recipients
- IIterable<EmailRecipient> IEnumerable<EmailRecipient> IEnumerable<EmailRecipient> IEnumerable<EmailRecipient>
The list of new recipients.
- subject
- PlatForm::String String String String
The subject of the email.
- forwardHeaderType
- EmailMessageBodyKind EmailMessageBodyKind EmailMessageBodyKind EmailMessageBodyKind
The email message format, HTML or plain text.
- forwardHeader
- PlatForm::String String String String
The email forward header.
- comment
- PlatForm::String String String String
The body of the message.
A Boolean value indicating if the meeting was successfully forwarded.
TryGetAutoReplySettingsAsync(EmailMailboxAutoReplyMessageResponseKind) TryGetAutoReplySettingsAsync(EmailMailboxAutoReplyMessageResponseKind) TryGetAutoReplySettingsAsync(EmailMailboxAutoReplyMessageResponseKind) TryGetAutoReplySettingsAsync(EmailMailboxAutoReplyMessageResponseKind)
Asynchronously attempts to get the auto-reply settings for the mailbox.
public : IAsyncOperation<EmailMailboxAutoReplySettings> TryGetAutoReplySettingsAsync(EmailMailboxAutoReplyMessageResponseKind requestedFormat)public IAsyncOperation<EmailMailboxAutoReplySettings> TryGetAutoReplySettingsAsync(EmailMailboxAutoReplyMessageResponseKind requestedFormat)Public Function TryGetAutoReplySettingsAsync(requestedFormat As EmailMailboxAutoReplyMessageResponseKind) As IAsyncOperation( Of EmailMailboxAutoReplySettings )// You can use this method in JavaScript.
- requestedFormat
- EmailMailboxAutoReplyMessageResponseKind EmailMailboxAutoReplyMessageResponseKind EmailMailboxAutoReplyMessageResponseKind EmailMailboxAutoReplyMessageResponseKind
The requested text format of the auto-reply message, HTML or plain text.
TryMoveFolderAsync(String, String) TryMoveFolderAsync(String, String) TryMoveFolderAsync(String, String) TryMoveFolderAsync(String, String)
Asynchronously attempts to move the specified email folder.
public : IAsyncOperation<PlatForm::Boolean> TryMoveFolderAsync(PlatForm::String folderId, PlatForm::String newParentFolderId)public IAsyncOperation<bool> TryMoveFolderAsync(String folderId, String newParentFolderId)Public Function TryMoveFolderAsync(folderId As String, newParentFolderId As String) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
- folderId
- PlatForm::String String String String
The folder to move.
- newParentFolderId
- PlatForm::String String String String
The new parent for the folder specified in the folderId parameter.
A Boolean value indicating if the move was successful.
- See Also
TryMoveFolderAsync(String, String, String) TryMoveFolderAsync(String, String, String) TryMoveFolderAsync(String, String, String) TryMoveFolderAsync(String, String, String)
Asynchronously attempts to move the specified email folder and rename it in the process.
public : IAsyncOperation<PlatForm::Boolean> TryMoveFolderAsync(PlatForm::String folderId, PlatForm::String newParentFolderId, PlatForm::String newFolderName)public IAsyncOperation<bool> TryMoveFolderAsync(String folderId, String newParentFolderId, String newFolderName)Public Function TryMoveFolderAsync(folderId As String, newParentFolderId As String, newFolderName As String) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
- folderId
- PlatForm::String String String String
The folder to move.
- newParentFolderId
- PlatForm::String String String String
The new parent for the folder specified in the folderId parameter.
- newFolderName
- PlatForm::String String String String
The name for the folder in the new location.
A Boolean value indicating if the move was successful.
- See Also
TryMoveMessageAsync(String, String) TryMoveMessageAsync(String, String) TryMoveMessageAsync(String, String) TryMoveMessageAsync(String, String)
Asynchronously attempts to move the specified email message.
public : IAsyncOperation<PlatForm::Boolean> TryMoveMessageAsync(PlatForm::String messageId, PlatForm::String newParentFolderId)public IAsyncOperation<bool> TryMoveMessageAsync(String messageId, String newParentFolderId)Public Function TryMoveMessageAsync(messageId As String, newParentFolderId As String) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
- messageId
- PlatForm::String String String String
The ID of the email message to move.
- newParentFolderId
- PlatForm::String String String String
The ID of the new folder where the email message should reside.
A Boolean value indicating if the move was successful.
TryProposeNewTimeForMeetingAsync(EmailMessage, DateTime, TimeSpan, String, String) TryProposeNewTimeForMeetingAsync(EmailMessage, DateTime, TimeSpan, String, String) TryProposeNewTimeForMeetingAsync(EmailMessage, DateTime, TimeSpan, String, String) TryProposeNewTimeForMeetingAsync(EmailMessage, DateTime, TimeSpan, String, String)
Asynchronously attempts to send a meeting request proposing a new time.
public : IAsyncOperation<PlatForm::Boolean> TryProposeNewTimeForMeetingAsync(EmailMessage meeting, DateTime newStartTime, TimeSpan newDuration, PlatForm::String subject, PlatForm::String comment)public IAsyncOperation<bool> TryProposeNewTimeForMeetingAsync(EmailMessage meeting, DateTimeOffset newStartTime, TimeSpan newDuration, String subject, String comment)Public Function TryProposeNewTimeForMeetingAsync(meeting As EmailMessage, newStartTime As DateTimeOffset, newDuration As TimeSpan, subject As String, comment As String) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
The meeting for which to propose a new time.
- newStartTime
- DateTime DateTimeOffset DateTimeOffset DateTimeOffset
The proposed new time for the meeting to start.
- newDuration
- TimeSpan TimeSpan TimeSpan TimeSpan
The proposed duration of the meeting.
- subject
- PlatForm::String String String String
The subject of the meeting email.
- comment
- PlatForm::String String String String
The body of the message.
A Boolean value indicating if the proposed meeting message was successfully sent.
TrySetAutoReplySettingsAsync(EmailMailboxAutoReplySettings) TrySetAutoReplySettingsAsync(EmailMailboxAutoReplySettings) TrySetAutoReplySettingsAsync(EmailMailboxAutoReplySettings) TrySetAutoReplySettingsAsync(EmailMailboxAutoReplySettings)
Asynchronously attempts to set the auto-reply settings for the mailbox.
public : IAsyncOperation<PlatForm::Boolean> TrySetAutoReplySettingsAsync(EmailMailboxAutoReplySettings autoReplySettings)public IAsyncOperation<bool> TrySetAutoReplySettingsAsync(EmailMailboxAutoReplySettings autoReplySettings)Public Function TrySetAutoReplySettingsAsync(autoReplySettings As EmailMailboxAutoReplySettings) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
- autoReplySettings
- EmailMailboxAutoReplySettings EmailMailboxAutoReplySettings EmailMailboxAutoReplySettings EmailMailboxAutoReplySettings
The new auto-reply settings.
A Boolean value indicating if the operation was successful.
TryUpdateMeetingResponseAsync(EmailMessage, EmailMeetingResponseType, String, String, Boolean) TryUpdateMeetingResponseAsync(EmailMessage, EmailMeetingResponseType, String, String, Boolean) TryUpdateMeetingResponseAsync(EmailMessage, EmailMeetingResponseType, String, String, Boolean) TryUpdateMeetingResponseAsync(EmailMessage, EmailMeetingResponseType, String, String, Boolean)
Asynchronously attempts to respond to a meeting request.
public : IAsyncOperation<PlatForm::Boolean> TryUpdateMeetingResponseAsync(EmailMessage meeting, EmailMeetingResponseType response, PlatForm::String subject, PlatForm::String comment, bool sendUpdate)public IAsyncOperation<bool> TryUpdateMeetingResponseAsync(EmailMessage meeting, EmailMeetingResponseType response, String subject, String comment, Boolean sendUpdate)Public Function TryUpdateMeetingResponseAsync(meeting As EmailMessage, response As EmailMeetingResponseType, subject As String, comment As String, sendUpdate As Boolean) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
The meeting request.
- response
- EmailMeetingResponseType EmailMeetingResponseType EmailMeetingResponseType EmailMeetingResponseType
The response to the meeting request, accept, decline, or tentative.
- subject
- PlatForm::String String String String
The subject of the response email message.
- comment
- PlatForm::String String String String
The body of the response email message.
- sendUpdate
- bool Boolean Boolean Boolean
A Boolean indicating whether or not to send a response to the meeting originator.
A Boolean value indicating if the response was sent successfully.
ValidateCertificatesAsync(IIterable)
ValidateCertificatesAsync(IIterable)
ValidateCertificatesAsync(IIterable)
ValidateCertificatesAsync(IIterable)
Validates the certificate against the sync provider service.
public : IAsyncOperation<IVectorView<EmailCertificateValidationStatus>> ValidateCertificatesAsync(IIterable<Certificate> certificates)public IAsyncOperation<IReadOnlyList<EmailCertificateValidationStatus>> ValidateCertificatesAsync(IEnumerable<Certificate> certificates)Public Function ValidateCertificatesAsync(certificates As IEnumerable<Certificate>) As IAsyncOperation( Of IReadOnlyListEmailCertificateValidationStatus )// You can use this method in JavaScript.
- certificates
- IIterable<Certificate> IEnumerable<Certificate> IEnumerable<Certificate> IEnumerable<Certificate>
The certificate to validate.
The confirmation that the certificate is valid.
| Device family |
Windows 10 (introduced v10.0.10586.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v2)
|
Events
MailboxChanged MailboxChanged MailboxChanged MailboxChanged
Occurs when the mailbox has changed.
public : event TypedEventHandler MailboxChanged<EmailMailbox, EmailMailboxChangedEventArgs>public event TypedEventHandler MailboxChanged<EmailMailbox, EmailMailboxChangedEventArgs>Public Event MailboxChanged<EmailMailbox, EmailMailboxChangedEventArgs>// You can use this event in JavaScript.