Office.LoadedMessageCompose interface
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Representa uma mensagem no modo de composição que está atualmente carregada. Um LoadedMessageCompose
objeto é devolvido quando Office.context.mailbox.loadItemByIdAsync
é chamado numa mensagem no modo de composição.
Comentários
[ Conjunto de API: Pré-visualização da caixa de correio ]
Nível mínimo de permissão: item de leitura/escrita
Modo Outlook aplicável: mensagem Compose
Importante:
Ao implementar a funcionalidade de seleção múltipla de itens, determine se já consegue aceder às propriedades necessárias do item selecionado através da
Office.context.mailbox.getSelectedItemsAsync
chamada. Se puder, não precisa de ligarloadItemByIdAsync
para .Só é possível carregar um item de correio de cada vez. Quando implementar
loadItemByIdAsync
o , tem de chamarunloadAsync
depois de processar o item. Isto tem de ser feito antes de chamarloadItemByIdAsync
outro item.
Propriedades
bcc | Obtém os destinatários na linha Bcc (cópia oculta de carbono) de uma mensagem. |
body | Obtém o corpo e o formato do item. |
categories | Obtém um objeto que fornece métodos para gerir as categorias do item. |
cc | Obtém destinatários na linha Cc (cópia de carbono) de uma mensagem. |
conversation |
Obtém um identificador da conversa de email que contém uma mensagem específica. Você pode obter um número inteiro para esta propriedade se o aplicativo de email estiver ativado nos formulários de leitura ou nas respostas em formulários de composição. Se, posteriormente, o usuário alterar o assunto da mensagem de resposta, ao enviar a resposta, a ID da conversa daquela mensagem será alterada e o valor obtido anteriormente não mais se aplicará. Você obtém nulo para esta propriedade para um novo item em um formulário de composição. |
delay |
Obtém a data e hora de entrega atrasadas de uma mensagem. |
from | Obtém o endereço de email do remetente de uma mensagem. |
in |
Obtém o ID da mensagem original a ser respondida pela mensagem atual. |
internet |
Obtém os cabeçalhos de Internet personalizados de uma mensagem. Para saber mais, consulte Obter e definir cabeçalhos da Internet numa mensagem num suplemento do Outlook. |
item |
Obtém o tipo de item que representa uma instância. A |
notification |
Obtém as mensagens de notificação do item. |
sensitivity |
Obtém a etiqueta de confidencialidade de uma mensagem. |
series |
Obtém o ID da série à qual pertence uma instância. No Outlook na Web e no Windows (novo e clássico), o |
subject | Obtém a descrição que aparece no campo assunto de um item. A |
to | Obtém os destinatários na linha Para de uma mensagem. Fornece acesso aos destinatários na linha Para de uma mensagem. O tipo de objeto e o nível de acesso dependem do modo do item atual. |
Métodos
get |
Obtém um anexo de uma mensagem ou compromisso e devolve-o como um O |
get |
Obtém um anexo de uma mensagem ou compromisso e devolve-o como um O |
get |
Obtém os anexos do item como uma matriz. |
get |
Obtém os anexos do item como uma matriz. |
get |
Especifica o tipo de composição de mensagens e o respetivo tipo de coação. A mensagem pode ser nova ou responder ou reencaminhar. O tipo de coerção pode ser HTML ou texto simples. |
get |
Especifica o tipo de composição de mensagens e o respetivo tipo de coação. A mensagem pode ser nova ou responder ou reencaminhar. O tipo de coerção pode ser HTML ou texto simples. |
get |
Obtém a posição codificada em Base64 da mensagem atual num tópico de conversação. |
get |
Obtém a posição codificada em Base64 da mensagem atual num tópico de conversação. |
get |
Obtém dados de inicialização transmitidos quando o suplemento é ativado por uma mensagem acionável. |
get |
Obtém dados de inicialização transmitidos quando o suplemento é ativado por uma mensagem acionável. |
get |
Obtém a classe de item exchange Web Services da mensagem selecionada. |
get |
Obtém a classe de item exchange Web Services da mensagem selecionada. |
get |
De forma assíncrona, obtém o identificador de item dos Serviços Web exchange (EWS) de um item guardado. Quando invocado, este método devolve o ID do item através da função de chamada de retorno. |
get |
De forma assíncrona, obtém o ID de um item guardado. Quando invocado, este método devolve o ID do item através da função de chamada de retorno.
Nota: se o suplemento chamar |
get |
Obtém as propriedades de um compromisso ou mensagem numa pasta partilhada ou caixa de correio partilhada. Para obter mais informações sobre como utilizar esta API, consulte Ativar pastas partilhadas e cenários de caixa de correio partilhada num suplemento do Outlook. |
get |
Obtém as propriedades de um compromisso ou mensagem numa pasta partilhada ou caixa de correio partilhada. Para obter mais informações sobre como utilizar esta API, consulte Ativar pastas partilhadas e cenários de caixa de correio partilhada num suplemento do Outlook. |
is |
Obtém se a assinatura do cliente estiver ativada. No Outlook no Windows (clássico), a chamada à API devolve |
is |
Obtém se a assinatura do cliente estiver ativada. No Outlook no Windows (clássico), a chamada à API devolve |
load |
Carrega de forma assíncrona as propriedades personalizadas para esse suplemento no item selecionado. As propriedades personalizadas são armazenadas como pares chave-valor numa base por aplicação, por item. Este método devolve um objeto CustomProperties na chamada de retorno, que fornece métodos para aceder às propriedades personalizadas específicas do item atual e do suplemento atual. As propriedades personalizadas não são encriptadas no item, pelo que não deve ser utilizado como armazenamento seguro. As propriedades personalizadas são fornecidas como um objeto |
save |
Guarda de forma assíncrona a mensagem atual como um rascunho. |
save |
Guarda de forma assíncrona a mensagem atual como um rascunho. |
unload |
Quando são selecionados vários itens de correio, fecha o item atualmente carregado, para que outro item de correio selecionado possa ser carregado para processamento. |
unload |
Quando são selecionados vários itens de correio, fecha o item atualmente carregado, para que outro item de correio selecionado possa ser carregado para processamento. |
Detalhes da propriedade
bcc
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém os destinatários na linha Bcc (cópia oculta de carbono) de uma mensagem.
bcc: Recipients;
Valor da propriedade
Comentários
[ Conjunto de API: Caixa de Correio 1.1 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante:
Apenas o
getAsync
método do objeto Destinatários é suportado.Consoante o cliente e a plataforma do Outlook, os limites podem aplicar-se ao número de destinatários que pode obter. Para obter mais informações, veja o objeto Destinatários .
body
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém o corpo e o formato do item.
body: Body;
Valor da propriedade
Comentários
[ Conjunto de API: Caixa de Correio 1.1 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante: apenas os getAsync
métodos e getTypeAsync
do objeto Corpo são suportados.
categories
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém um objeto que fornece métodos para gerir as categorias do item.
categories: Categories;
Valor da propriedade
Comentários
[ Conjunto de API: Caixa de Correio 1.8 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
cc
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém destinatários na linha Cc (cópia de carbono) de uma mensagem.
cc: Recipients;
Valor da propriedade
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante:
Apenas o
getAsync
método do objeto Destinatários é suportado.Consoante o cliente e a plataforma do Outlook, os limites podem aplicar-se ao número de destinatários que pode obter. Para obter mais informações, veja o objeto Destinatários .
conversationId
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém um identificador da conversa de email que contém uma mensagem específica.
Você pode obter um número inteiro para esta propriedade se o aplicativo de email estiver ativado nos formulários de leitura ou nas respostas em formulários de composição. Se, posteriormente, o usuário alterar o assunto da mensagem de resposta, ao enviar a resposta, a ID da conversa daquela mensagem será alterada e o valor obtido anteriormente não mais se aplicará.
Você obtém nulo para esta propriedade para um novo item em um formulário de composição.
conversationId: string;
Valor da propriedade
string
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
delayDeliveryTime
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém a data e hora de entrega atrasadas de uma mensagem.
delayDeliveryTime: DelayDeliveryTime;
Valor da propriedade
Comentários
[ Conjunto de API: Caixa de Correio 1.13 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante: apenas o getAsync
método do objeto DelayDeliveryTime é suportado.
from
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém o endereço de email do remetente de uma mensagem.
from: From;
Valor da propriedade
Comentários
[ Conjunto de API: Caixa de Correio 1.7 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
inReplyTo
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém o ID da mensagem original a ser respondida pela mensagem atual.
inReplyTo: string;
Valor da propriedade
string
Comentários
[ Conjunto de API: Caixa de Correio 1.14 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante:
No Outlook no Windows, o
inReplyTo
valor é mantido em todas as respostas, independentemente das alterações efetuadas pelo utilizador, como alterar o assunto numa resposta.A
inReplyTo
propriedade é devolvidanull
para novas mensagens e convites de reunião que estão a ser reencaminhados por um utilizador que também é o organizador da reunião.
internetHeaders
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém os cabeçalhos de Internet personalizados de uma mensagem.
Para saber mais, consulte Obter e definir cabeçalhos da Internet numa mensagem num suplemento do Outlook.
internetHeaders: InternetHeaders;
Valor da propriedade
Comentários
[ Conjunto de API: Caixa de Correio 1.8 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante: apenas o getAsync
método do objeto InternetHeaders é suportado.
itemType
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém o tipo de item que representa uma instância.
A itemType
propriedade devolve um dos valores de ItemType
enumeração, indicando se a instância do objeto de item é uma mensagem ou um compromisso.
itemType: MailboxEnums.ItemType | string;
Valor da propriedade
Office.MailboxEnums.ItemType | string
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
notificationMessages
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém as mensagens de notificação do item.
notificationMessages: NotificationMessages;
Valor da propriedade
Comentários
[ Conjunto de API: Caixa de Correio 1.3 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante:
- Apenas o
getAllAsync
método do objeto NotificationMessages é suportado.
sensitivityLabel
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém a etiqueta de confidencialidade de uma mensagem.
sensitivityLabel: SensitivityLabel;
Valor da propriedade
Comentários
[ Conjunto de API: Caixa de Correio 1.13 ]
Nível mínimo de permissão: item de leitura/escrita
Modo Outlook aplicável: mensagem Compose
Importante:
Para utilizar a funcionalidade de etiqueta de confidencialidade no suplemento, tem de ter uma subscrição Microsoft 365 E5.
Apenas o
getAsync
método do objeto SensitivityLabel é suportado.
Para saber mais sobre como gerir etiquetas de confidencialidade no seu suplemento, consulte Gerir a etiqueta de confidencialidade da sua mensagem ou compromisso no modo de composição.
seriesId
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém o ID da série à qual pertence uma instância.
No Outlook na Web e no Windows (novo e clássico), o seriesId
devolve o ID dos Serviços Web exchange (EWS) do item principal (série) ao qual este item pertence.
seriesId: string;
Valor da propriedade
string
Comentários
[ Conjunto de API: Caixa de Correio 1.7 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante: o identificador devolvido pela seriesId
propriedade é o mesmo que o identificador de item dos Serviços Web exchange. A seriesId
propriedade não é idêntica aos IDs do Outlook utilizados pela API REST do Outlook. Antes de efetuar chamadas à API REST com este valor, deve ser convertida com Office.context.mailbox.convertToRestId
. Para obter mais detalhes, consulte Utilizar as APIs REST do Outlook a partir de um suplemento do Outlook.
A seriesId
propriedade devolve null
itens que não têm itens principais, como compromissos individuais, itens de série ou pedidos de reunião e devoluções undefined
para quaisquer outros itens que não sejam pedidos de reunião.
subject
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém a descrição que aparece no campo assunto de um item.
A subject
propriedade obtém todo o assunto do item, conforme enviado pelo servidor de e-mail.
subject: Subject;
Valor da propriedade
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante: apenas o getAsync
método do objeto Assunto é suportado.
to
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém os destinatários na linha Para de uma mensagem. Fornece acesso aos destinatários na linha Para de uma mensagem. O tipo de objeto e o nível de acesso dependem do modo do item atual.
to: Recipients;
Valor da propriedade
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante:
Apenas o
getAsync
método do objeto Destinatários é suportado.Consoante o cliente e a plataforma do Outlook, os limites podem aplicar-se ao número de destinatários que pode obter. Para obter mais informações, veja o objeto Destinatários .
Detalhes do método
getAttachmentContentAsync(attachmentId, options, callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém um anexo de uma mensagem ou compromisso e devolve-o como um AttachmentContent
objeto.
O getAttachmentContentAsync
método obtém o anexo com o identificador especificado do item. Como melhor prática, deve obter o identificador do anexo a partir de uma getAttachmentsAsync
chamada e, em seguida, na mesma sessão, utilizar esse identificador para obter o anexo. No Outlook na Web e no novo Outlook no Windows, o identificador de anexo só é válido na mesma sessão. Uma sessão termina quando o utilizador fecha a aplicação ou, se o utilizador começar a compor um formulário inline, é posteriormente apresentado o formulário para continuar numa janela separada.
getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;
Parâmetros
- attachmentId
-
string
O identificador do anexo que pretende obter.
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext
: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void
Opcional. Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro, asyncResult
, que é um Office.AsyncResult
objeto. Se a chamada falhar, a asyncResult.error
propriedade conterá um código de erro com o motivo da falha.
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.8 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Erros:
AttachmentTypeNotSupported
: o tipo de anexo não é suportado. Os tipos não suportados incluem imagens incorporadas no Formato RTF ou tipos de anexos de itens diferentes dos itens de e-mail ou calendário (como um contacto ou item de tarefa).InvalidAttachmentId
: o identificador de anexo não existe.
getAttachmentContentAsync(attachmentId, callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém um anexo de uma mensagem ou compromisso e devolve-o como um AttachmentContent
objeto.
O getAttachmentContentAsync
método obtém o anexo com o identificador especificado do item. Como melhor prática, deve obter o identificador do anexo a partir de uma getAttachmentsAsync
chamada e, em seguida, na mesma sessão, utilizar esse identificador para obter o anexo. No Outlook na Web e no novo Outlook no Windows, o identificador de anexo só é válido na mesma sessão. Uma sessão termina quando o utilizador fecha a aplicação ou, se o utilizador começar a compor um formulário inline, é posteriormente apresentado o formulário para continuar numa janela separada.
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;
Parâmetros
- attachmentId
-
string
O identificador do anexo que pretende obter.
- callback
-
(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void
Opcional. Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro, asyncResult
, que é um Office.AsyncResult
objeto. Se a chamada falhar, a asyncResult.error
propriedade conterá um código de erro com o motivo da falha.
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.8 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Erros:
AttachmentTypeNotSupported
: o tipo de anexo não é suportado. Os tipos não suportados incluem imagens incorporadas no Formato RTF ou tipos de anexos de itens diferentes dos itens de e-mail ou calendário (como um contacto ou item de tarefa).InvalidAttachmentId
: o identificador de anexo não existe.
getAttachmentsAsync(options, callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém os anexos do item como uma matriz.
getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
Parâmetros
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext
: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void
Opcional. Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
. Se a chamada falhar, a asyncResult.error
propriedade conterá um código de erro com o motivo da falha.
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.8 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
getAttachmentsAsync(callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém os anexos do item como uma matriz.
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void
Opcional. Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
. Se a chamada falhar, a asyncResult.error
propriedade conterá um código de erro com o motivo da falha.
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.8 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
getComposeTypeAsync(options, callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Especifica o tipo de composição de mensagens e o respetivo tipo de coação. A mensagem pode ser nova ou responder ou reencaminhar. O tipo de coerção pode ser HTML ou texto simples.
getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;
Parâmetros
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext
: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<any>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
. Com êxito, a asyncResult.value
propriedade contém um objeto com o tipo de composição e o tipo de coação do item.
Retornos
void
Um objeto com ComposeType
e CoercionType
enumerar valores para o item de mensagem.
Comentários
[ Conjunto de API: Caixa de Correio 1.10 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
getComposeTypeAsync(callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Especifica o tipo de composição de mensagens e o respetivo tipo de coação. A mensagem pode ser nova ou responder ou reencaminhar. O tipo de coerção pode ser HTML ou texto simples.
getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult<any>) => void): void;
Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<any>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
. Com êxito, a asyncResult.value
propriedade contém um objeto com o tipo de composição e o tipo de coação do item.
Retornos
void
Um objeto com ComposeType
e CoercionType
enumerar valores para o item de mensagem.
Comentários
[ Conjunto de API: Caixa de Correio 1.10 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
getConversationIndexAsync(options, callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém a posição codificada em Base64 da mensagem atual num tópico de conversação.
getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Parâmetros
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext
: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro, asyncResult
, que é um Office.AsyncResult
objeto. A posição codificada com Base64 da mensagem atual numa conversação é devolvida na asyncResult.value
propriedade .
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.14 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Sugestão: pode utilizar o índice de conversação para localizar uma mensagem num tópico de conversação. Em seguida, utilize o respetivo conteúdo para fornecer contexto para a mensagem atual que está a ser composta.
getConversationIndexAsync(callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém a posição codificada em Base64 da mensagem atual num tópico de conversação.
getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro, asyncResult
, que é um Office.AsyncResult
objeto. A posição codificada com Base64 da mensagem atual numa conversação é devolvida na asyncResult.value
propriedade .
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.14 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Sugestão: pode utilizar o índice de conversação para localizar uma mensagem num tópico de conversação. Em seguida, utilize o respetivo conteúdo para fornecer contexto para a mensagem atual que está a ser composta.
getInitializationContextAsync(options, callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém dados de inicialização transmitidos quando o suplemento é ativado por uma mensagem acionável.
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Parâmetros
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext
: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
. Com êxito, os dados de contexto de inicialização são fornecidos como uma cadeia (ou uma cadeia vazia se não houver contexto de inicialização) na asyncResult.value
propriedade.
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.8 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
getInitializationContextAsync(callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém dados de inicialização transmitidos quando o suplemento é ativado por uma mensagem acionável.
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
. Com êxito, os dados de contexto de inicialização são fornecidos como uma cadeia (ou uma cadeia vazia se não houver contexto de inicialização) na asyncResult.value
propriedade.
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.8 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
getItemClassAsync(options, callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém a classe de item exchange Web Services da mensagem selecionada.
getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Parâmetros
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext
: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro, asyncResult
, que é um Office.AsyncResult
objeto. A classe da mensagem é devolvida na asyncResult.value
propriedade .
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.14 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante:
A tabela seguinte lista as classes de mensagens predefinidas.
Classe item | Descrição |
---|---|
O IPM. Nota | Novas mensagens e respostas a mensagens |
O IPM. Note.SMIME | Mensagens encriptadas que também podem ser assinadas |
O IPM. Note.SMIME.MultipartSigned | Mensagens com assinatura não criptografada |
IPM.Schedule.Meeting.Request | Solicitações de reunião |
IPM.Schedule.Meeting.Canceled | Cancelamentos de reunião |
O IPM. Schedule.Meeting.Resp.Neg | Respostas para recusar solicitações de reunião |
O IPM. Schedule.Meeting.Resp.Pos | Respostas para aceitar pedidos de reunião |
O IPM. Schedule.Meeting.Resp.Tent | Respostas para aceitar provisoriamente solicitações de reunião |
getItemClassAsync(callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém a classe de item exchange Web Services da mensagem selecionada.
getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro, asyncResult
, que é um Office.AsyncResult
objeto. A classe da mensagem é devolvida na asyncResult.value
propriedade .
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.14 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante:
A tabela seguinte lista as classes de mensagens predefinidas.
Classe item | Descrição |
---|---|
O IPM. Nota | Novas mensagens e respostas a mensagens |
O IPM. Note.SMIME | Mensagens encriptadas que também podem ser assinadas |
O IPM. Note.SMIME.MultipartSigned | Mensagens com assinatura não criptografada |
IPM.Schedule.Meeting.Request | Solicitações de reunião |
IPM.Schedule.Meeting.Canceled | Cancelamentos de reunião |
O IPM. Schedule.Meeting.Resp.Neg | Respostas para recusar solicitações de reunião |
O IPM. Schedule.Meeting.Resp.Pos | Respostas para aceitar pedidos de reunião |
O IPM. Schedule.Meeting.Resp.Tent | Respostas para aceitar provisoriamente solicitações de reunião |
getItemIdAsync(options, callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
De forma assíncrona, obtém o identificador de item dos Serviços Web exchange (EWS) de um item guardado.
Quando invocado, este método devolve o ID do item através da função de chamada de retorno.
getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Parâmetros
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext
: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
. O ID do item EWS do item é devolvido na asyncResult.value
propriedade .
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.8 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante:
O ID do item devolvido não é idêntico ao ID de Entrada do Outlook ou ao ID utilizado pela API REST do Outlook. Antes de efetuar chamadas à API REST com este valor, deve ser convertida com
Office.context.mailbox.convertToRestId
.Se o suplemento chamar
getItemIdAsync
um item no modo de composição (por exemplo, para obter uma utilizaçãoitemId
com o EWS ou a API REST), tenha em atenção que, quando o Outlook está no modo de cache, poderá demorar algum tempo até que o item seja sincronizado com o servidor. Até o item ser sincronizado, oitemId
não é reconhecido e a utilização devolve um erro.
Erros:
-
ItemNotSaved
: o ID não pode ser obtido até que o item seja guardado.
getItemIdAsync(callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
De forma assíncrona, obtém o ID de um item guardado.
Quando invocado, este método devolve o ID do item através da função de chamada de retorno.
Nota: se o suplemento chamar getItemIdAsync
um item no modo de composição (por exemplo, para obter um itemId
para utilizar com o EWS ou a API REST), tenha em atenção que, quando o Outlook estiver no modo de cache, poderá demorar algum tempo até o item ser sincronizado com o servidor. Até o item ser sincronizado, o itemId
não é reconhecido e a utilização devolve um erro.
getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
.
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.8 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Erros:
-
ItemNotSaved
: o ID não pode ser obtido até que o item seja guardado.
getSharedPropertiesAsync(options, callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém as propriedades de um compromisso ou mensagem numa pasta partilhada ou caixa de correio partilhada.
Para obter mais informações sobre como utilizar esta API, consulte Ativar pastas partilhadas e cenários de caixa de correio partilhada num suplemento do Outlook.
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
Parâmetros
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext
: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro, asyncResult
, que é um Office.AsyncResult
objeto. A asyncResult.value
propriedade fornece as propriedades do item partilhado.
Retornos
void
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante: no modo Compose mensagem, esta API não é suportada no Outlook na Web ou no Windows (novo e clássico), a menos que sejam cumpridas as seguintes condições.
a. Delegar acesso/Pastas partilhadas
O proprietário da caixa de correio inicia uma mensagem. Pode ser uma nova mensagem, uma resposta ou um reencaminhamento.
Guardam a mensagem e, em seguida, movem-na da sua própria pasta Rascunhos para uma pasta partilhada com o delegado.
O delegado abre o rascunho a partir da pasta partilhada e, em seguida, continua a compor.
b. Caixa de correio partilhada (aplica-se apenas ao Outlook clássico no Windows)
O utilizador da caixa de correio partilhada inicia uma mensagem. Pode ser uma nova mensagem, uma resposta ou um reencaminhamento.
Guardam a mensagem e, em seguida, movem-na da sua própria pasta Rascunhos para uma pasta na caixa de correio partilhada.
Outro utilizador da caixa de correio partilhada abre o rascunho da caixa de correio partilhada e, em seguida, continua a compor.
A mensagem encontra-se agora num contexto partilhado e os suplementos que suportam estes cenários partilhados podem obter as propriedades partilhadas do item. Depois de a mensagem ter sido enviada, normalmente encontra-se na pasta Itens Enviados do remetente.
getSharedPropertiesAsync(callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém as propriedades de um compromisso ou mensagem numa pasta partilhada ou caixa de correio partilhada.
Para obter mais informações sobre como utilizar esta API, consulte Ativar pastas partilhadas e cenários de caixa de correio partilhada num suplemento do Outlook.
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;
Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro, asyncResult
, que é um Office.AsyncResult
objeto. A asyncResult.value
propriedade fornece as propriedades do item partilhado.
Retornos
void
Comentários
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
Importante: no modo Compose mensagem, esta API não é suportada no Outlook na Web ou no Windows (novo e clássico), a menos que sejam cumpridas as seguintes condições.
a. Delegar acesso/Pastas partilhadas
O proprietário da caixa de correio inicia uma mensagem. Pode ser uma nova mensagem, uma resposta ou um reencaminhamento.
Guardam a mensagem e, em seguida, movem-na da sua própria pasta Rascunhos para uma pasta partilhada com o delegado.
O delegado abre o rascunho a partir da pasta partilhada e, em seguida, continua a compor.
b. Caixa de correio partilhada (aplica-se apenas ao Outlook no Windows)
O utilizador da caixa de correio partilhada inicia uma mensagem. Pode ser uma nova mensagem, uma resposta ou um reencaminhamento.
Guardam a mensagem e, em seguida, movem-na da sua própria pasta Rascunhos para uma pasta na caixa de correio partilhada.
Outro utilizador da caixa de correio partilhada abre o rascunho da caixa de correio partilhada e, em seguida, continua a compor.
A mensagem encontra-se agora num contexto partilhado e os suplementos que suportam estes cenários partilhados podem obter as propriedades partilhadas do item. Depois de a mensagem ter sido enviada, normalmente encontra-se na pasta Itens Enviados do remetente.
isClientSignatureEnabledAsync(options, callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém se a assinatura do cliente estiver ativada.
No Outlook no Windows (clássico), a chamada à API devolve true
se a assinatura predefinida para novas mensagens, respostas ou reencaminhamentos estiver definida para um modelo para a conta do Outlook de envio. No Outlook na Web e no novo Outlook no Windows, a chamada à API devolve true
se a assinatura estiver ativada para os tiposnewMail
de composição , reply
ou forward
. Se as definições estiverem definidas como "(none)" no Outlook no Windows (clássico) ou estiverem desativadas no Outlook na Web ou no novo Outlook no Windows, a chamada à API devolve false
.
isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
Parâmetros
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext
: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
.
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.10 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
isClientSignatureEnabledAsync(callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém se a assinatura do cliente estiver ativada.
No Outlook no Windows (clássico), a chamada à API devolve true
se a assinatura predefinida para novas mensagens, respostas ou reencaminhamentos estiver definida para um modelo para a conta do Outlook de envio. No Outlook na Web e no novo Outlook no Windows, a chamada à API devolve true
se a assinatura estiver ativada para os tiposnewMail
de composição , reply
ou forward
. Se as definições estiverem definidas como "(none)" no Outlook no Windows (clássico) ou estiverem desativadas no Outlook na Web ou no novo Outlook no Windows, a chamada à API devolve false
.
isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
.
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.10 ]
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
loadCustomPropertiesAsync(callback, userContext)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Carrega de forma assíncrona as propriedades personalizadas para esse suplemento no item selecionado.
As propriedades personalizadas são armazenadas como pares chave-valor numa base por aplicação, por item. Este método devolve um objeto CustomProperties na chamada de retorno, que fornece métodos para aceder às propriedades personalizadas específicas do item atual e do suplemento atual. As propriedades personalizadas não são encriptadas no item, pelo que não deve ser utilizado como armazenamento seguro.
As propriedades personalizadas são fornecidas como um objeto CustomProperties
na propriedade asyncResult.value
. Este objeto pode ser utilizado para obter propriedades personalizadas do item de correio.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;
Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<Office.CustomProperties>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult
.
- userContext
-
any
Opcional. Os desenvolvedores podem fornecer qualquer objeto que desejarem acessar na função de retorno de chamada. Esse objeto pode ser acessado pela propriedade asyncResult.asyncContext
na função de retorno de chamada.
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.1 ]
Para saber mais sobre as propriedades personalizadas, consulte Obter e definir metadados de suplementos para um suplemento do Outlook.
Nível mínimo de permissão: ler item
Modo Outlook aplicável: mensagem Compose
saveAsync(options, callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Guarda de forma assíncrona a mensagem atual como um rascunho.
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Parâmetros
- options
- Office.AsyncContextOptions
Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext
: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro, asyncResult
, que é um Office.AsyncResult
objeto. O ID da mensagem EWS é devolvido na asyncResult.value
propriedade .
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.3 ]
Nível mínimo de permissão: item de leitura/escrita
Modo Outlook aplicável: mensagem Compose
Importante:
No Outlook na Web, o novo Outlook no Windows ou o Outlook clássico no Windows no modo online (modo não colocado em cache), o item é guardado no servidor. No Outlook no modo cache, o item é salvo no cache local.
Ao trabalhar com conteúdo formatado em HTML, é importante ter em atenção que o cliente do Outlook pode modificar o conteúdo. Isto significa que as chamadas subsequentes para métodos como
Body.getAsync
,Body.setAsync
e até mesmosaveAsync
podem não resultar no mesmo conteúdo.O identificador devolvido é o mesmo que o identificador de item dos Serviços Web exchange (EWS). O ID do item devolvido não é idêntico ao ID de Entrada do Outlook ou ao ID utilizado pela API REST do Outlook. Antes de efetuar chamadas à API REST com este valor, deve ser convertida com
Office.context.mailbox.convertToRestId
.Se o suplemento chamar
saveAsync
um item no modo de composição para obter um ID de item a utilizar com o EWS ou a API REST, tenha em atenção que, quando o Outlook está no modo de cache, poderá demorar algum tempo até que o item seja realmente sincronizado com o servidor. Até o item ser sincronizado, a utilização do ID do item devolverá um erro.No Outlook na Web e no novo Outlook no Windows, a conta de caixa de correio para a qual um rascunho é guardado varia quando
saveAsync
é chamado numa mensagem que será enviada a partir de uma conta de caixa de correio partilhada. Se o remetente criar uma nova mensagem a partir da respetiva caixa de correio pessoal e selecionar a conta de caixa de correio partilhada no campo De ,saveAsync
guarda o rascunho na pasta Rascunhos da caixa de correio pessoal do utilizador. Se o remetente abrir a conta de caixa de correio partilhada num separador separador do browser (por exemplo, através da opção Abrir outra caixa de correio ) e criar uma nova mensagem,saveAsync
guarda o rascunho na pasta Rascunhos da caixa de correio partilhada.
Erros:
-
InvalidAttachmentId
: o identificador de anexo não existe.
saveAsync(callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Guarda de forma assíncrona a mensagem atual como um rascunho.
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Quando o método for concluído, a função transmitida no callback
parâmetro é chamada com um único parâmetro, asyncResult
, que é um Office.AsyncResult
objeto. O ID da mensagem EWS é devolvido na asyncResult.value
propriedade .
Retornos
void
Comentários
[ Conjunto de API: Caixa de Correio 1.3 ]
Nível mínimo de permissão: item de leitura/escrita
Modo Outlook aplicável: mensagem Compose
Importante:
No Outlook na Web, o novo Outlook no Windows ou o Outlook clássico no Windows no modo online (modo não colocado em cache), o item é guardado no servidor. No Outlook no modo cache, o item é salvo no cache local.
Ao trabalhar com conteúdo formatado em HTML, é importante ter em atenção que o cliente do Outlook pode modificar o conteúdo. Isto significa que as chamadas subsequentes para métodos como
Body.getAsync
,Body.setAsync
e até mesmosaveAsync
podem não resultar no mesmo conteúdo.O identificador devolvido é o mesmo que o identificador de item dos Serviços Web exchange (EWS). O ID do item devolvido não é idêntico ao ID de Entrada do Outlook ou ao ID utilizado pela API REST do Outlook. Antes de efetuar chamadas à API REST com este valor, deve ser convertida com
Office.context.mailbox.convertToRestId
.Se o suplemento chamar
saveAsync
um item no modo de composição para obter um ID de item a utilizar com o EWS ou a API REST, tenha em atenção que, quando o Outlook está no modo de cache, poderá demorar algum tempo até que o item seja realmente sincronizado com o servidor. Até o item ser sincronizado, a utilização do ID do item devolverá um erro.No Outlook na Web e no novo Outlook no Windows, a conta de caixa de correio para a qual um rascunho é guardado varia quando
saveAsync
é chamado numa mensagem que será enviada a partir de uma conta de caixa de correio partilhada. Se o remetente criar uma nova mensagem a partir da respetiva caixa de correio pessoal e selecionar a conta de caixa de correio partilhada no campo De ,saveAsync
guarda o rascunho na pasta Rascunhos da caixa de correio pessoal do utilizador. Se o remetente abrir a conta de caixa de correio partilhada num separador separador do browser (por exemplo, através da opção Abrir outra caixa de correio ) e criar uma nova mensagem,saveAsync
guarda o rascunho na pasta Rascunhos da caixa de correio partilhada.
Erros:
-
InvalidAttachmentId
: o identificador de anexo não existe.
unloadAsync(options, callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Quando são selecionados vários itens de correio, fecha o item atualmente carregado, para que outro item de correio selecionado possa ser carregado para processamento.
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parâmetros
- options
- Office.AsyncContextOptions
Um literal de objeto que contém a asyncContext
propriedade . Atribua qualquer objeto a que pretenda aceder na função de chamada de retorno à asyncContext
propriedade .
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Quando o método for concluído, a função transmitida no parâmetro de chamada de retorno é chamada com um único parâmetro, asyncResult
, que é um Office.AsyncResult
objeto.
Retornos
void
Comentários
[ Conjunto de API: Pré-visualização da caixa de correio ]
Nível mínimo de permissão: item de leitura/escrita
Modo Outlook aplicável: mensagem Compose
Importante:
Para saber mais sobre o processamento de várias mensagens selecionadas, consulte Ativar o seu suplemento do Outlook em várias mensagens.
Quando um item de correio selecionado é carregado com
loadItemByIdAsync
o , tem de ligarunloadAsync
depois de o processar. Isto tem de ser feito antes de chamarloadItemByIdAsync
outro item selecionado.
unloadAsync(callback)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Quando são selecionados vários itens de correio, fecha o item atualmente carregado, para que outro item de correio selecionado possa ser carregado para processamento.
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parâmetros
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Opcional. Quando o método for concluído, a função transmitida no parâmetro de chamada de retorno é chamada com um único parâmetro, asyncResult
, que é um Office.AsyncResult
objeto.
Retornos
void
Comentários
[ Conjunto de API: Pré-visualização da caixa de correio ]
Nível mínimo de permissão: item de leitura/escrita
Modo Outlook aplicável: mensagem Compose
Importante:
Para saber mais sobre o processamento de várias mensagens selecionadas, consulte Ativar o seu suplemento do Outlook em várias mensagens.
Quando um item de correio selecionado é carregado com
loadItemByIdAsync
o , tem de ligarunloadAsync
depois de o processar. Isto tem de ser feito antes de chamarloadItemByIdAsync
outro item selecionado.