Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
O subconjunto da API do suplemento do Outlook da API JavaScript do Office inclui objetos, métodos, propriedades e eventos que você pode usar em um suplemento do Outlook.
Observação
Esta documentação destina-se a um conjunto de requisitos que não seja o mais recente.
Novidades da versão 1.8
O conjunto de requisitos de caixa de correio 1.8 inclui todos os recursos do conjunto de requisitos 1.7. Ele adicionou os seguintes recursos.
- Adicionados métodos para obter o conteúdo de um anexo ou obter todos os anexos de um item no modo de redação. Para obter mais informações, consulte Gerenciar os anexos de um item em um formulário redigido no Outlook.
- Adicionado um método para adicionar um arquivo como anexo usando uma cadeia de caracteres codificada em Base64.
- Adicionadas propriedades e métodos para gerenciar categorias em itens e na lista de categorias master da caixa de correio.
- Adicionado suporte para cenários de acesso delegado , incluindo um método para obter propriedades compartilhadas e um elemento de manifesto para habilitar suplementos em pastas compartilhadas.
- Adicionado um objeto para gerenciar o conjunto de locais em um compromisso. Para obter mais informações, consulte Obter ou definir o local ao compor um compromisso no Outlook.
- Adicionado um objeto para obter e definir cabeçalhos personalizados da Internet em um item de mensagem no modo de redação.
- Adicionado um método para obter todos os cabeçalhos da Internet em um item de mensagem no modo de leitura.
- Adicionado um método para obter dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável.
- Adicionado um método para obter a ID de um compromisso salvo ou item de mensagem.
- Adicionado parâmetro opcional
optionsà chamada para cancelar aevent.completedexecução de um evento. - Eventos adicionados que ocorrem quando um anexo é adicionado ou removido e quando o local do compromisso é alterado.
Lista de APIs
A tabela a seguir lista as APIs introduzidas no conjunto de requisitos de Caixa de Correio 1.8. Para exibir a documentação de referência de API para todas as APIs compatíveis com o conjunto de requisitos de Caixa de correio 1.8 ou anterior, consulte APIs do Outlook.
| Classe | Campos | Descrição |
|---|---|---|
| AppointmentCompose | addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Adiciona um arquivo a uma mensagem ou um compromisso como um anexo. |
| addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Adiciona um arquivo a uma mensagem ou um compromisso como um anexo. | |
| Categorias | Obtém um objeto que fornece métodos para gerenciar as categorias do item. | |
| enhancedLocation | Obtém ou define os locais do compromisso. | |
| getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtém um anexo de uma mensagem ou compromisso e o retorna como um AttachmentContent objeto. |
|
| getAttachmentContentAsync(attachmentId: string, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtém um anexo de uma mensagem ou compromisso e o retorna como um AttachmentContent objeto. |
|
| getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) | Obtém os anexos do item como uma matriz. | |
| getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) | Obtém os anexos do item como uma matriz. | |
| getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Recebe dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável. | |
| getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) | Recebe dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável. | |
| getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtém de forma assíncrona o identificador de item do EWS (Serviços Web do Exchange) | |
| getItemIdAsync(opções: Office.AsyncContextOptions, retorno de chamada: (asyncResult: Office.AsyncResult<string>) => void) | Obtém de forma assíncrona o identificador de item do EWS (Serviços Web do Exchange) | |
| getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada. | |
| getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada. | |
| AppointmentRead | Categorias | Obtém um objeto que fornece métodos para gerenciar as categorias do item. |
| enhancedLocation | Obtém os locais de um compromisso. | |
| getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtém um anexo de uma mensagem ou compromisso e o retorna como um AttachmentContent objeto. |
|
| getAttachmentContentAsync(attachmentId: string, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtém um anexo de uma mensagem ou compromisso e o retorna como um AttachmentContent objeto. |
|
| getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Recebe dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável. | |
| getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) | Recebe dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável. | |
| getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada. | |
| getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada. | |
| AttachmentContent | content | O conteúdo de um anexo como uma cadeia de caracteres. |
| format | O formato de cadeia de caracteres a ser usado para o conteúdo de um anexo. | |
| AttachmentDetailsCompose | attachmentType | Obtém um valor que indica o tipo do anexo. |
| id | Obtém o identificador de um anexo. | |
| isInline | Obtém um valor que indica se o anexo aparece como uma imagem no corpo do item em vez de na lista de anexos. | |
| isServiceAccessible | No Outlook na Web e no novo Outlook no Windows, indica se um anexo embutido em uma mensagem foi carregado para o servidor e recebeu uma ID do Serviços Web do Exchange (EWS). | |
| name | Obtém o nome de arquivo do anexo. | |
| size | Obtém o tamanho do anexo em bytes. | |
| url | Obtém a URL do anexo se seu tipo for MailboxEnums.AttachmentType.Cloud. |
|
| AttachmentsChangedEventArgs | attachmentDetails | Obtém o objeto que representa o anexo que foi adicionado ou removido do |
| attachmentStatus | Especifica se o anexo foi adicionado ou removido de um item de email. | |
| type | Obtém o tipo de evento que foi gerado. | |
| Categories | addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) | Adiciona categorias a um item. |
| addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Adiciona categorias a um item. | |
| getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) | Obtém as categorias de um item. | |
| getAsync(opções: Office.AsyncContextOptions, retorno de chamada: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) | Obtém as categorias de um item. | |
| removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) | Remove categorias de um item. | |
| removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Remove categorias de um item. | |
| CategoryDetails | color | A cor da categoria. |
| displayName | O nome da categoria. | |
| EnhancedLocation | addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void) | Adiciona ao conjunto de locais associados ao compromisso. |
| addAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Adiciona ao conjunto de locais associados ao compromisso. | |
| getAsync(callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void) | Obtém o conjunto de locais associados ao compromisso. | |
| getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void) | Obtém o conjunto de locais associados ao compromisso. | |
| removeAsync(locationIdentifiers: LocationIdentifier[], retorno de chamada?: (asyncResult: Office.AsyncResult<void>) => void) | Remove o conjunto de locais associados ao compromisso. | |
| removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Remove o conjunto de locais associados ao compromisso. | |
| EnhancedLocationsChangedEventArgs | enhancedLocations | Obtém o conjunto de locais aprimorados. |
| tipo | Obtém o tipo do evento. | |
| InternetHeaders | getAsync(names: string[], callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void) | Dada uma matriz de nomes de cabeçalho da Internet, esse método retorna um registro que contém esses cabeçalhos da Internet e seus valores. |
| getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void) | Dada uma matriz de nomes de cabeçalho da Internet, esse método retorna um registro que contém esses cabeçalhos da Internet e seus valores. | |
| removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) | Dada uma matriz de nomes de cabeçalho da Internet, esse método remove os cabeçalhos especificados da coleção de cabeçalhos da Internet. | |
| removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Dada uma matriz de nomes de cabeçalho da Internet, esse método remove os cabeçalhos especificados da coleção de cabeçalhos da Internet. | |
| setAsync(cabeçalhos: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Define os cabeçalhos da Internet especificados para os valores especificados. | |
| setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Define os cabeçalhos da Internet especificados para os valores especificados. | |
| LocationDetails | displayName | O nome de exibição do local. |
| emailAddress | O endereço de email associado ao local. | |
| locationIdentifier | O LocationIdentifier do local. |
|
| LocationIdentifier | id | A ID exclusiva do local. |
| type | O tipo do local. | |
| Caixa de Correio | masterCategories | Obtém um objeto que fornece métodos para gerenciar a lista master de categorias associada a uma caixa de correio. |
| MasterCategories | addAsync(categories: CategoryDetails[], callback?: (asyncResult: Office.AsyncResult<void>) => void) | Adiciona categorias à lista master em uma caixa de correio. |
| addAsync(categories: CategoryDetails[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Adiciona categorias à lista master em uma caixa de correio. | |
| getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) | Obtém a lista master de categorias em uma caixa de correio. | |
| getAsync(opções: Office.AsyncContextOptions, retorno de chamada: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) | Obtém a lista master de categorias em uma caixa de correio. | |
| removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) | Remove categorias da lista master em uma caixa de correio. | |
| removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Remove categorias da lista master em uma caixa de correio. | |
| MessageCompose | addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Adiciona um arquivo a uma mensagem ou um compromisso como um anexo. |
| addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Adiciona um arquivo a uma mensagem ou um compromisso como um anexo. | |
| Categorias | Obtém um objeto que fornece métodos para gerenciar as categorias do item. | |
| getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtém um anexo de uma mensagem ou compromisso e o retorna como um AttachmentContent objeto. |
|
| getAttachmentContentAsync(attachmentId: string, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtém um anexo de uma mensagem ou compromisso e o retorna como um AttachmentContent objeto. |
|
| getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) | Obtém os anexos do item como uma matriz. | |
| getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) | Obtém os anexos do item como uma matriz. | |
| getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Recebe dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável. | |
| getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) | Recebe dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável. | |
| getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtém de forma assíncrona o identificador de item do EWS (Serviços Web do Exchange) | |
| getItemIdAsync(opções: Office.AsyncContextOptions, retorno de chamada: (asyncResult: Office.AsyncResult<string>) => void) | Obtém de forma assíncrona o identificador de item do EWS (Serviços Web do Exchange) | |
| getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada. | |
| getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada. | |
| internetHeaders | Obtém ou define os cabeçalhos personalizados da Internet de uma mensagem. | |
| MessageRead | Categorias | Obtém um objeto que fornece métodos para gerenciar as categorias do item. |
| getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void) | Obtém todos os cabeçalhos da Internet para a mensagem como uma cadeia de caracteres. | |
| getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Obtém todos os cabeçalhos da Internet para a mensagem como uma cadeia de caracteres. | |
| getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtém um anexo de uma mensagem ou compromisso e o retorna como um AttachmentContent objeto. |
|
| getAttachmentContentAsync(attachmentId: string, opções: Office.AsyncContextOptions, retorno de chamada?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtém um anexo de uma mensagem ou compromisso e o retorna como um AttachmentContent objeto. |
|
| getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Recebe dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável. | |
| getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) | Recebe dados de inicialização passados quando o suplemento é ativado por uma mensagem acionável. | |
| getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada. | |
| getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtém as propriedades de um compromisso ou mensagem em uma pasta compartilhada ou caixa de correio compartilhada. | |
| AttachmentContentFormat | em base64 | O conteúdo do anexo é retornado como uma cadeia de caracteres codificada em Base64. |
| Eml (em inglês) | O conteúdo do anexo é retornado como uma cadeia de caracteres representando um arquivo formatado .eml. | |
| ICalendar | O conteúdo do anexo é retornado como uma cadeia de caracteres que representa um arquivo formatado em .icalendar. | |
| Url | O conteúdo do anexo é retornado como uma cadeia de caracteres representando uma URL. | |
| AttachmentStatus | Adicionado | Um anexo foi adicionado ao item. |
| Removido | Um anexo foi removido do item. | |
| CategoryColor | Nenhum | Cor padrão ou nenhuma cor mapeada. |
| Preset0 | Vermelho | |
| Preset1 | Laranja | |
| Preset10 | Steel | |
| Preset11 | DarkSteel | |
| Preset12 | Cinza | |
| Preset13 | DarkGray | |
| Preset14 | Preto | |
| Preset15 | DarkRed | |
| Preset16 | DarkOrange | |
| Preset17 | DarkBrown | |
| Preset18 | DarkYellow | |
| Preset19 | DarkGreen | |
| Preset2 | Marrom | |
| Preset20 | DarkTeal | |
| Preset21 | DarkOlive | |
| Preset22 | DarkBlue | |
| Preset23 | DarkPurple | |
| Preset24 | DarkCranberry | |
| Preset3 | Amarelo | |
| Preset4 | Verde | |
| Preset5 | Azul-petróleo | |
| Preset6 | Verde-oliva | |
| Preset7 | Azul | |
| Preset8 | Roxo | |
| Preset9 | Cranberry | |
| DelegatePermissions | DeleteAll | O representante tem permissão para excluir todos os itens. |
| DeleteOwn | O representante tem permissão para excluir somente os itens criados por ele. | |
| EditAll | O representante tem permissão para editar todos os itens. | |
| EditOwn | O representante tem permissão para editar somente os itens criados por ele. | |
| Leitura | O representante tem permissão para ler itens. | |
| Gravar | O representante tem permissão para criar e gravar itens. | |
| LocationType | Personalizado | Um local personalizado. |
| Room | Uma sala de conferência ou recurso semelhante que tenha um endereço SMTP. | |
| SharedProperties | delegatePermissions | As permissões que o representante tem em uma pasta compartilhada ou o usuário em uma caixa de correio compartilhada. |
| owner | O endereço de email do proprietário de um item compartilhado. | |
| targetMailbox | O local da caixa de correio do proprietário para acesso do representante. | |
| targetRestUrl | A URL base da API REST (atualmente https://outlook.office.com/api). |
Eventos
A tabela a seguir lista os eventos introduzidos no conjunto de requisitos 1.8. Para obter uma lista de todos os eventos com suporte que podem ser manipulados usando os addHandlerAsync métodos and removeHandlerAsync , confira Office.EventType.
| Evento | Descrição | Objeto |
|---|---|---|
| AttachmentsChanged | Um anexo foi adicionado ou removido de um item. | Item |
| EnhancedLocationsChanged | O local do compromisso foi alterado. | Item |
Atualizações de manifesto
A tabela a seguir lista as atualizações de manifesto introduzidas no conjunto de requisitos de caixa de correio 1.8. Para saber mais sobre os tipos de manifestos de Suplementos do Office, consulte Manifesto de Suplementos do Office.
| Recurso | Manifesto unificado para o Microsoft 365 | Manifesto somente do suplemento | Descrição |
|---|---|---|---|
| Suporte a pastas compartilhadas |
"authorization.permissions.resourceSpecific.name" Defina como "Mailbox.SharedFolder" |
SupportsSharedFolders | Define se o suplemento está disponível em cenários de pasta compartilhada. |
Confira também
Colaborar conosco no GitHub
A fonte deste conteúdo pode ser encontrada no GitHub, onde você também pode criar e revisar problemas e solicitações de pull. Para obter mais informações, confira o nosso guia para colaboradores.