



# O365
  
Conecte-se à sua conta de e-mail do Outlook e ao espaço de trabalho do Sharepoint.  

*Read this in other languages: [English](Manual_O365.md), [Português](Manual_O365.pr.md), [Español](Manual_O365.es.md)*
  
![banner](imgs/Banner_O365.jpg)
## Como instalar este módulo
  
Para instalar o módulo no Rocketbot Studio, pode ser feito de duas formas:
1. Manual: __Baixe__ o arquivo .zip e descompacte-o na pasta módulos. O nome da pasta deve ser o mesmo do módulo e dentro dela devem ter os seguintes arquivos e pastas: \__init__.py, package.json, docs, example e libs. Se você tiver o aplicativo aberto, atualize seu navegador para poder usar o novo módulo.
2. Automático: Ao entrar no Rocketbot Studio na margem direita você encontrará a seção **Addons**, selecione **Install Mods**, procure o módulo desejado e aperte instalar.  



## Como usar este módulo

Antes de usar este módulo, você precisa registrar seu aplicativo no portal de Registros de Aplicativo do Azure.

1. Entre no portal do Azure e procure o serviço Microsoft Entra ID.
2. No menu do lado esquerdo, entre em "Registros de aplicativos".
3. Selecione "Novo registro".
4. Em "Tipos de conta compatíveis", escolha:
    - "Contas em qualquer diretório organizacional (qualquer diretório do Azure AD: multilocatário) e contas pessoais da Microsoft (como Skype ou Xbox)" para este caso, use ID de locatário = **common**.
    - "Somente contas deste diretório organizacional (somente esta conta: locatário único) para este caso usam **ID de locatário específico** do aplicativo.
    - "Somente contas pessoais da Microsoft" para este caso, use ID do locatário = **consumers**.
5. Defina o uri de redirecionamento (Web) como: https://localhost:5001/ e clique em "Registrar".
6. Copie o ID do aplicativo (cliente). Você vai precisar desse valor.
7. Em "Certificados e 
segredos", gere um novo segredo do cliente. Defina a validade (de preferência 24 meses). Copie o **VALUE** do segredo do cliente criado (**__NÃO o ID do segredo__**). Ele vai esconder depois de alguns minutos.
8. Em "Permissões de API", clique em "Adicionar uma permissão", selecione "Microsoft Graph", depois em "Permissões delegadas", localize e selecione "Mail.ReadWrite" e "User.Read" e, finalmente, "Adicionar permissões".
9. No Rocketbot Studio, insira o comando "Connect to O365", insira os dados solicitados (ID do cliente, valor secreto e locatário) e execute o comando.
10. No console do Rocketbot será gerado um URL, copie e cole no seu navegador.
    - **Exemplo:** <sub>https://login.microsoftonline.com/common/oauth2/v2.0/authorize?response_type=code&client_id=82f8efcd-6a0d-4532-a62e-3e2aecb4d19f&redirect_uri=https%3A%2F%2Flogin.microsoftonline.com%2Fcommon%2Foauth2%2Fnativeclient&scope=Mail.ReadWrite+User.Read.All&state=3LvNFBfX0qej9Q0rsixmSWjCGJyi0M&access_type=offline
11. Aceite
 a concessão de permissões e retornará uma tela sem conteúdo. Copie o URL e cole-o no console do Rocketbot abaixo de **"Paste the authenticated url here:"**.
    - Exemplo: <sub>https://login.microsoftonline.com/common/oauth2/nativeclient?code=M.R3_SN1.5dcda10b-6567-ce05-3a5b-f67145c62684&state=3LvNFBfX0qej9Q0rsixmSWjCGJyi0M
12. Pressione "enter" e se a operação foi bem sucedida você verá no console: "Authentication Flow Completed. Oauth Access Token Stored. You can now use the API." e será criado um arquivo com suas credenciais, na pasta raiz do Rocketbot, chamado o365_token.txt o o365_token_{session}.txt.

## ERRO

Se na guia de login que abre quando você executa o comando de conexão você vê este erro:

![erro](imgs/o365error.PNG)

Isso ocorre porque as permissões de administrador necessárias não foram concedidas ao usuário, portanto o Administrador deve executar as seguintes etapas:

1. Acesse o portal do Azure >
2. Vá para Azure Active Directory
3. Selecione seu aplicativo
4. Vá 
para Permissões da API
5. Conceda consentimento do administrador

Como alternativa, você também pode permitir que os usuários concordem com o aplicativo sem a aprovação do administrador, da seguinte forma:

1. Acesse o portal do Azure
2. Aplicação Empresarial
3. Configurações do usuário
4. Vá para Consentimento e permissões
5. Permitir que os usuários concordem com os aplicativos

## Descrição do comando

### Conectar a O365
  
Conectar-se à instância do aplicativo O365
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|client_id||client_id|
|client_secret||client_secret|
|tenant_id||tenant_id|
|session||session|
|Conectar ao Sharepoint||-|
|Ativar caixa de correio compartilhada||-|
|Proxy HTTPS||https://192.168.00.00:4000|
|Proxy HTTP||http://192.168.00.00:4000|
|Atribuir à variável||Variable|

### Listar todos os e-mails
  
Listar todos os e-mails, você pode especificar um filtro
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|Filter||subject eq 'compras'|
|Ordenar por||importance desc|
|ID Pasta||Inbox|
|Número de e-mails para listar||25|
|Buzão compartilhado (Opcional)|Email do buzon compartilhado para acesso|sharedmailbox@outlook|
|Atribuir à variável||Variable|
|session||session|

### Listar e-mails não lidos
  
Liste todos os e-mails não lidos da sua caixa de correio
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|Filter||subject eq 'compras'|
|Ordenar por||importance desc|
|ID Pasta||Inbox|
|Número de e-mails para listar||25|
|Buzão compartilhado|Email do buzon compartilhado para acesso|sharedmailbox@outlook|
|Atribuir à variável||Variable|
|session||session|

### Ler e-mail para identificação
  
Ler um e-mail usando seu ID
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|Identificação do email||345|
|Caminho para download do anexo||C:\User\Desktop|
|Baixar anexos||-|
|Caminho para download mensagem html||C:\User\Desktop|
|Baixar mensagem como HTML||-|
|Marcar como lido||-|
|Corpo do e-mail HTML|Se esta caixa estiver marcada, retornará o corpo do e-mail na versão HTML.||
|E-mail completo em HTML|Se esta caixa estiver marcada, retornará o e-mail completo em versão HTML.||
|Corpo do e-mail RAW|Se esta caixa estiver marcada, retornará o corpo do e-mail na versão RAW.||
|Buzão compartilhado|Email do buzon compartilhado para acesso|sharedmailbox@outlook|
|Atribuir à variável||Variable|
|session||session|

### Enviar Email
  
Envia un email
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|Para||to@mail.com, to1@mail.com|
|Cc||to2@mail.com, to3@mail.com|
|Bcc||to4@mail.com, to5@mail.com|
|Buzão compartilhado (Opcional)|Email do buzon compartilhado da qual deseja enviar o email|sharedmailbox@outlook|
|Assunto||Nuevo mail|
|Mensagem||Esto es una prueba|
|Attached File||C:\User\Desktop\test.txt|
|Pasta (vários arquivos)||C:\User\Desktop\Files|
|session||session|

### Responder Email
  
Responder um email usando seu ID
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|Identificação do email||345|
|Cc||to2@mail.com, to3@mail.com|
|Bcc||to4@mail.com, to5@mail.com|
|Buzão compartilhado (Opcional)|Email do buzon compartilhado da qual deseja responder o email|sharedmailbox@outlook|
|Mensagem||Esto es una prueba|
|Attached File||C:\User\Desktop\test.txt|
|Pasta (vários arquivos)||C:\User\Desktop\Files|
|Marcar como lido||-|
|Responder ao remeteste||-|
|session||session|

### Reenviar um e-mail
  
Reenviar um e-mail usando seu ID
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|Identificação do email||345|
|Para||to@mail.com, to1@mail.com|
|Cc||to2@mail.com, to3@mail.com|
|Bcc||to4@mail.com, to5@mail.com|
|Buzão compartilhado (Opcional)|Email do buzon compartilhado da qual deseja reenviar o email|sharedmailbox@outlook|
|Mensagem||This is a test.|
|Attached File||C:\User\Desktop\test.txt|
|Pasta (vários arquivos)||C:\User\Desktop\Files|
|Marcar como lido||-|
|Atribuir à variável||Variable|
|session||session|

### Baixar anexos
  
Baixar anexos de e-mail
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|Identificação do email||345|
|Caminho para download do anexo||C:\User\Desktop|
|Marcar como lido||-|
|Buzão compartilhado|Opcional. Deve ser fornecido o email do buzon compartilhado.|shared@mailbox.com|
|Atribuir à variável||Variable|
|session||session|

### Marcarcomo não lido
  
Marcar um e-mail como não lido
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|Identificação do email||345|
|Buzão compartilhado|Opcional. Deve ser fornecido o email do buzon compartilhado.|shared@mailbox.com|
|Atribuir à variável||Variable|
|session||session|

### Baixar .eml
  
Baixe um e-mail no formato .eml
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|Identificação do email||345|
|Caminho da pasta||C:/Users/user/Documents/|
|Nome do arquivo||Mail|
|Buzão compartilhado|Opcional. Deve ser fornecido o email do buzon compartilhado.|shared@mailbox.com|
|Atribuir à variável||Variable|
|session||session|

### Lista de pastas de e-mail
  
Lista de pastas de e-mail
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|Filter||displayName eq 'Processed'|
|Pasta pai|||
|Buzão compartilhado|Opcional. Deve ser fornecido o email do buzon compartilhado.|shared@mailbox.com|
|Atribuir à variável||Variable|
|session||session|

### Mover e-mail
  
Mover um email de uma pasta para outra
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|Identificação do email||345|
|Identificação da pasta||345|
|Buzão compartilhado|Opcional. Deve ser fornecido o email do buzon compartilhado.|shared@mailbox.com|
|Atribuir à variável||Variable|
|session||session|

### Criar pasta
  
Cria uma nova pasta no e-mail
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID pasta Pai||Inbox or 345...|
|Nome da nova pasta||new_folder|
|Buzão compartilhado|Opcional. Deve ser fornecido o email do buzon compartilhado.|shared@mailbox.com|
|Atribuir à variável||Variable|
|session||session|

### Obter Grupos
  
Obter lista de Grupos aos quais a conta pertence
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|Filtro|Filtrar os grupos que comezan con o texto introducido.||
|Atribuir à variável||Variable|
|session||session|

### Obter Grupos
  
Obter Grupo por ID
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do grupo||ID|
|Atribuir à variável||Variable|
|session||session|

### Obter site
  
Obter o site do Grupo
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do grupo||ID|
|Hostname|Exemplo do link https//tusitio.sharepoint.com/sites/RecursosHumanos/SubsitioRRHH tirar tusitio.sharepoint.com|tusitio.sharepoint.com|
|Rota ao sitio|Exemplo do link https//tusitio.sharepoint.com/sites/RecursosHumanos/SubsitioRRHH tirar /sites/RecursosHumanos/SubsitioRRHH|/sites/RecursosHumanos/SubsitioRRHH|
|Atribuir à variável||Variable|
|session||session|

### Obter listas
  
Obter as listas do Site
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do grupo||ID|
|Atribuir à variável||Variable|
|session||session|

### Obter listas por ID do Sítio
  
Obter as listas do Site
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do Sítio||ID|
|Atribuir à variável||Variable|
|Session||session|

### Obter colunas da lista
  
Obtenha as colunas editáveis de uma Lista específica do Site
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do Sítio||ID|
|ID da lista||ID|
|Atribuir à variável||Variable|
|session||session|

### Criar List
  
Criar uma nova lista
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do Sítio||ID|
|Dados da lista||{'displayName': 'example_name'}|
|Atribuir à variável||Variable|
|session||session|

### Obter itens da lista
  
Obter os itens de uma Lista usando seu nome
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do Sítio||ID|
|Hostname|Exemplo do link https//tusitio.sharepoint.com/sites/RecursosHumanos/SubsitioRRHH tirar tusitio.sharepoint.com|tusitio.sharepoint.com|
|Rota ao sitio|Exemplo do link https//tusitio.sharepoint.com/sites/RecursosHumanos/SubsitioRRHH tirar /sites/RecursosHumanos/SubsitioRRHH|/sites/RecursosHumanos/SubsitioRRHH|
|Nome da lista||name|
|Limite||10|
|Filtro do consulta||field/id1 eq 'value'|
|Ordenar por||column|
|Campos para expandir||['id1','id2',...]|
|Atribuir à variável||Variable|
|session||session|

### Obter Item
  
Obtenha um Item, usando seu ID, de uma lista
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do Sítio||ID|
|Hostname|Exemplo do link https//tusitio.sharepoint.com/sites/RecursosHumanos/SubsitioRRHH tirar tusitio.sharepoint.com|tusitio.sharepoint.com|
|Rota ao sitio|Exemplo do link https//tusitio.sharepoint.com/sites/RecursosHumanos/SubsitioRRHH tirar /sites/RecursosHumanos/SubsitioRRHH|/sites/RecursosHumanos/SubsitioRRHH|
|Nome da lista||name|
|ID do Item||ID|
|Campos para expandir||['id1','id2',...]|
|Atribuir à variável||Variable|
|session||session|

### Criar Item
  
Criar um Item dentro de uma Lista
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do Sítio||ID|
|Nome da lista||name|
|Dados do Item||{'title': 'data'}|
|Atribuir à variável||Variable|
|session||session|

### Criar Item
  
Eliminar um Item, usando seu ID, de uma Lista
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do Sítio||ID|
|Nome da lista||name|
|ID do Item||ID|
|Atribuir à variável||Variable|
|session||session|

### Actualizar Item
  
Actualizar dados do Item usando seu ID
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do Sítio||ID|
|Nome da lista||name|
|ID do Item||ID|
|Dados do Item||{'title': 'data'}|
|Atribuir à variável||Variable|
|session||session|

### Obter bibliotecas de documentos
  
Obtenha uma lista das Bibliotecas de Documentos dentro do Site
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do Sítio||ID|
|Hostname|Exemplo do link https//tusitio.sharepoint.com/sites/RecursosHumanos/SubsitioRRHH tirar tusitio.sharepoint.com|tusitio.sharepoint.com|
|Rota ao sitio|Exemplo do link https//tusitio.sharepoint.com/sites/RecursosHumanos/SubsitioRRHH tirar /sites/RecursosHumanos/SubsitioRRHH|/sites/RecursosHumanos/SubsitioRRHH|
|Atribuir à variável||Variable|
|session||session|

### Obter documentos
  
Obtenha uma lista dos documentos dentro de uma biblioteca
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do Sítio||ID|
|Hostname|Exemplo do link https//tusitio.sharepoint.com/sites/RecursosHumanos/SubsitioRRHH tirar tusitio.sharepoint.com|tusitio.sharepoint.com|
|Rota ao sitio|Exemplo do link https//tusitio.sharepoint.com/sites/RecursosHumanos/SubsitioRRHH tirar /sites/RecursosHumanos/SubsitioRRHH|/sites/RecursosHumanos/SubsitioRRHH|
|ID do Biblioteca|Você pode obter o ID da biblioteca usando o módulo 'Obter bibliotecas de documentos'|ID|
|Começar de|Caminho dentro da biblioteca de onde começar a obter os documentos. Exemplo /Documentos compartilhados/Pasta1|Path/to/folder|
|Contém|Obter apenas os documentos que contêm este texto em seu nome. Deixe vazio para obter todos os documentos.|Text|
|Atribuir à variável||Variable|
|session||session|

### Carregar documentos
  
Carregar um documento para uma biblioteca do Site
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do Sítio||ID|
|ID do Biblioteca||ID|
|ID da Pasta||ID|
|Caminho|||
|Atribuir à variável||Variable|
|session||session|

### Baixe ou modifique o documento
  
Carregar um documento para uma biblioteca do Site
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID do Sítio||ID|
|ID do Biblioteca||ID|
|ID do Item||ID|
|Dados para modificar||{'name': 'new_name.jpg', 'description':'new_description'}|
|Atualizar dados do documento|||
|ID da pasta de destino||ID|
|Mover documento|||
|Caminho|||
|Baixar documento|||
|Excluir documento|||
|Atribuir à variável||Variable|
|session||session|

### Criar pasta do SharePoint
  
Crie uma nova pasta do SharePoint.
|Parâmetros|Descrição|exemplo|
| --- | --- | --- |
|ID pasta Pai||Id de la biblioteca...|
|ID Pasta Contenedora||ID de la carpeta contenedora o 'root'|
|ID do Grupo/Local||ID del Grupo de M365|
|Nome da nova pasta||new_folder|
|Atribuir à variável||Variable|
|session||session|
