Integre o Microsoft Graph Mail com o Google SecOps

Este documento explica como integrar o Microsoft Graph Mail com o Google Security Operations (Google SecOps).

Antes de começar

Antes de configurar a integração delegada do Microsoft Graph Mail no Google SecOps, conclua os seguintes passos:

  1. Crie a aplicação Microsoft Entra.

  2. Configure as autorizações da API para a sua aplicação.

  3. Crie um segredo do cliente.

Crie a aplicação Microsoft Entra

Para criar a app Microsoft Entra, conclua os seguintes passos:

  1. Inicie sessão no portal do Azure como administrador de utilizadores ou administrador de palavras-passe.

  2. Selecione Microsoft Entra ID.

  3. Aceda a Registos de apps > Novo registo.

  4. Introduza o nome da aplicação.

  5. Clique em Registar.

    Este documento fornece um exemplo que usa uma configuração de inquilino único. O fluxo OAuth (credenciais do cliente) suportado pela integração não requer o URL de redirecionamento.

  6. Guarde os valores do ID da aplicação (cliente) e do ID do diretório (inquilino) para configurar os parâmetros de integração.

Configure autorizações da API

Para configurar as autorizações da API para a integração, conclua os seguintes passos:

  1. No portal do Azure, aceda a Autorizações da API > Adicionar uma autorização.

  2. Selecione Microsoft Graph > Autorizações da aplicação.

  3. Na secção Selecionar autorizações, selecione as seguintes autorizações obrigatórias:

    • Mail.Read
    • Mail.ReadWrite
    • Mail.Send
    • User.Read
    • Directory.Read.All

  4. Clique em Adicionar autorizações.

  5. Clique em Conceder consentimento do administrador para ORGANIZATION_NAME.

    Quando for apresentada a caixa de diálogo Confirmação de concessão de consentimento do administrador, clique em Sim.

Limite o acesso de aplicações a caixas de correio específicas

Por predefinição, as aplicações com autorizações de aplicação Mail.ReadWrite ou Mail.Send têm acesso a todas as caixas de correio na sua organização. Para restringir o acesso da aplicação apenas a caixas de correio específicas, configure as políticas de acesso a aplicações no Microsoft Exchange Online.

Para configurar as políticas de acesso a aplicações, conclua os seguintes passos:

  1. Associe ao Exchange Online PowerShell:

    1. Abra o PowerShell como administrador.

    2. Instale o módulo de gestão do Exchange Online (se ainda não estiver instalado):

      Install-Module -Name ExchangeOnlineManagement

    3. Associe ao Exchange Online:

      Connect-ExchangeOnline

  2. Identifique o ID da aplicação e as caixas de correio de destino:

    1. Obtenha o ID de cliente (ID da aplicação) da aplicação de correio do Microsoft Graph no Azure AD.

    2. Identifique os endereços de email das caixas de correio às quais quer que a aplicação aceda. Para uma gestão mais fácil, crie um grupo de segurança com capacidade de envio de email no Azure AD e adicione estas caixas de correio como membros.

  3. Crie uma política de acesso a aplicações:

    1. Use o cmdlet New-ApplicationAccessPolicy para criar uma política que restrinja o acesso a caixas de correio selecionadas.

    2. Opcional: restrinja o acesso a um grupo de segurança específico de caixas de correio:

      1. Substitua <Your_Application_ID> pelo ID de cliente da sua aplicação.

      2. Substitua <Security_Group_Email_Address> pelo endereço de email do grupo de segurança que contém as caixas de correio permitidas.

      New-ApplicationAccessPolicy -AppId "<Your_Application_ID>" -PolicyScopeGroupId "<Security_Group_Email_Address>" -AccessRight RestrictAccess -Description "SOAR Graph Mail Access Policy"

  4. Valide a eficácia da política com o cmdlet Test-ApplicationAccessPolicy:

       Test-ApplicationAccessPolicy -AppId "<Your_Application_ID>" -Identity "user_email_to_test@yourdomain.com"

    Este comando indica se a aplicação tem acesso à caixa de correio especificada com base nas políticas aplicadas.

Nota:

  • São necessárias autorizações OrganizationManagement ou Security Administrator no Exchange Online para criar estas políticas.

  • Normalmente, as alterações às políticas entram em vigor no prazo de 30 minutos.

  • Após a aplicação da política, a aplicação só pode aceder às caixas de correio permitidas. As tentativas de acesso a outros devolvem um erro Access Denied.

Crie um segredo do cliente

Para criar um segredo do cliente, conclua os seguintes passos:

  1. Aceda a Certificados e segredos > Novo segredo do cliente.

  2. Forneça uma descrição para um segredo do cliente e defina o respetivo prazo de validade.

  3. Clique em Adicionar.

  4. Guarde o valor do segredo do cliente (não o ID secreto) para o usar como valor do parâmetro ID secreto quando configurar a integração. O valor do segredo do cliente só é apresentado uma vez.

Parâmetros de integração

A integração do Microsoft Graph Mail requer os seguintes parâmetros:
Parâmetro Descrição
Azure AD Endpoint

Obrigatório.

O ponto final do Microsoft Entra ID a usar na integração.

O valor pode ser diferente para diferentes tipos de inquilinos.

O valor predefinido é https://login.microsoftonline.com.
Microsoft Graph Endpoint

Obrigatório.

O ponto final do Microsoft Graph a usar na integração.

O valor pode ser diferente para diferentes tipos de inquilinos.

O valor predefinido é https://graph.microsoft.com.
Client ID

Obrigatório.

O ID de cliente (aplicação) da aplicação Microsoft Entra a usar na integração.
Secret ID

Obrigatório.

O valor do segredo do cliente da aplicação Microsoft Entra a usar na integração.
Tenant

Obrigatório.

O valor do Microsoft Entra ID (ID do inquilino).
Default Mailbox

Obrigatório.

A caixa de correio a usar na integração.
Mail Field Source

Opcional.

Se estiver selecionada, a integração obtém o endereço de email da caixa de correio do atributo mail dos detalhes do utilizador. Se não estiver selecionado, a integração obtém o endereço da caixa de correio do campo userPrincipalName.

Não selecionado por predefinição.
Verify SSL

Obrigatório.

Se estiver selecionada, a integração valida o certificado SSL quando se liga ao Microsoft Graph.

Selecionado por predefinição.
Base64 Encoded Private Key

Opcional.

Especifique uma chave privada codificada em base64 que vai ser usada para desencriptar o email.
Base64 Encoded Certificate

Opcional.

Especifique um certificado codificado em base64 que vai ser usado para descifrar o email.
Base64 Encoded CA certificate

Opcional.

Especifique um certificado de CA fidedigno codificado em base64 para a validação da assinatura.

Para obter instruções sobre como configurar uma integração no Google SecOps, consulte o artigo Configurar integrações.

Se necessário, pode fazer alterações numa fase posterior. Depois de configurar uma instância de integração, pode usá-la em manuais de soluções. Para mais informações sobre como configurar e suportar várias instâncias, consulte o artigo Suporte de várias instâncias.

Ações

Antes de configurar ações, faculte as autorizações necessárias para a integração. Para ver mais detalhes, consulte a secção Configure as autorizações da API deste documento.

Eliminar email

Pode usar a ação Eliminar email para eliminar um ou mais emails de uma caixa de correio. Esta ação elimina emails com base nos seus critérios de pesquisa. Com as autorizações adequadas, a ação Eliminar email pode mover emails para caixas de correio diferentes.

Esta ação é assíncrona. Ajuste o limite de tempo da ação no ambiente de programação integrado (IDE) do Google SecOps conforme necessário.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Eliminar email requer os seguintes parâmetros:

Parâmetro Descrição
Delete In Mailbox

Obrigatório.

A caixa de correio predefinida onde executar a operação de eliminação. Se as autorizações o permitirem, a ação também pode pesquisar noutras caixas de correio. Este parâmetro aceita vários valores como uma string separada por vírgulas.
Folder Name

Obrigatório.

Uma pasta da caixa de correio para pesquisar emails. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Mail IDs

Opcional.

Uma condição de filtro para pesquisar emails com IDs de email específicos.

Este parâmetro aceita uma lista de IDs de email separados por vírgulas para pesquisar.

Se este parâmetro for fornecido, a pesquisa ignora os parâmetros Subject Filter e Sender Filter.
Subject Filter

Opcional.

Uma condição de filtro que especifica o assunto do email a pesquisar.
Sender Filter

Opcional.

Uma condição de filtro que especifica o remetente dos emails pedidos.
Timeframe (Minutes)

Opcional.

Uma condição de filtro que especifica o período em minutos para pesquisar emails.
Only Unread

Opcional.

Se estiver selecionada, a ação pesquisa apenas emails não lidos.

Não selecionado por predefinição.
How many mailboxes to process in a single batch

Opcional.

O número de caixas de correio a processar num único lote (uma única ligação ao servidor de correio).

O valor predefinido é 25.

Resultados da ação

A tabela seguinte descreve os tipos de resultados associados à ação Delete Email:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Eliminar email fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully deleted emails in the following mailboxes: MAILBOX_NAME: DELETED_EMAILS_NUMBER

Mailbox MAILBOX was not found.

 Ação efetuada com êxito.

Action was not able to find any emails based on the specified search criteria.

Action failed to delete any emails because the provided mailbox folder name was not found in the mailbox(es): MAILBOX_NAME, MAILBOX_FOLDER

Failed to find any of the provided mailboxes: MAILBOX_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Eliminar email:

Nome do resultado do script Valor
is_success True ou False

Transfira anexos de emails

Use a ação Transferir anexos do email para transferir anexos de emails com base nos critérios fornecidos.

Esta ação não é executada em entidades do Google SecOps.

Esta ação é assíncrona. Se necessário, ajuste o valor do limite de tempo do script no IDE do Google SecOps.

A ação substitui o caráter de sublinhado \` forward slash or/backslash characters in the names of the downloaded attachments with the_`.

Dados de ações

A ação Transferir anexos do email requer os seguintes parâmetros:

Parâmetro Descrição
Search In Mailbox

Obrigatório.

A caixa de correio predefinida onde a operação de pesquisa é executada. Se as autorizações o permitirem, a ação também pode pesquisar noutras caixas de correio. Este parâmetro aceita vários valores como uma string separada por vírgulas.
Folder Name

Obrigatório.

Uma pasta da caixa de correio onde executar a pesquisa. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Download Destination

Obrigatório.

Um tipo de armazenamento para guardar os anexos transferidos.

Por predefinição, a ação tenta guardar o anexo no contentor do Cloud Storage. Guardar um anexo no sistema de ficheiros local é uma opção alternativa.

Os valores possíveis são GCP Bucket e Local File System. O valor predefinido é GCP Bucket.
Download Path

Obrigatório.

Um caminho para transferir anexos.

Quando guarda anexos no contentor do Cloud Storage ou num sistema de ficheiros local, a ação espera que especifique o caminho de transferência no formato semelhante ao Unix, como /tmp/test.
Mail IDs

Opcional.

Uma condição de filtro para pesquisar emails com IDs de email específicos.

Este parâmetro aceita uma lista de IDs de email separados por vírgulas para pesquisar.

Se este parâmetro for fornecido, a pesquisa ignora os parâmetros Subject Filter e Sender Filter.
Subject Filter

Opcional.

Uma condição de filtro que especifica o assunto do email a pesquisar.

Este filtro usa a lógica contains.
Sender Filter

Opcional.

Uma condição de filtro que especifica o remetente dos emails pedidos.

Este filtro usa a lógica equals.
Download Attachments From EML

Opcional.

Se selecionada, a ação transfere anexos de ficheiros EML.

Não selecionado por predefinição.
Download attachments to unique path?

Opcional.

Se estiver selecionada, a ação transfere anexos para o caminho único fornecido no campo do parâmetro Download Path para evitar substituir anexos transferidos anteriormente.

Não selecionado por predefinição.
How many mailboxes to process in a single batch

Opcional.

O número de caixas de correio a processar num único lote (uma única ligação ao servidor de correio).

O valor predefinido é 25.

Resultados da ação

A ação Transferir anexos do email fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação Transferir anexos do email:

[
    {
        "attachment_name": "name1.png",
        "downloaded_path": "file_path/name1.png"
    },
    {
        "attachment_name": "name2.png",
        "downloaded_path": "file_path/name2.png"
    }
]
Mensagens de saída

A ação Transferir anexos do email fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Downloaded NUMBER_OF_ATTACHMENTS attachments. Files: PATHS.

Failed to find emails in MAILBOX with the following mail ids: EMAIL_IDS.

In the mailboxes listed below, emails were found, but there were no attachments to download. Affected mailboxes: MAILBOXES. Mail IDs without attachments to download: LIST_OF_EMAIL_IDS attachments.

 Ação efetuada com êxito.

Failed to find any emails using the provided criteria!

Failed to find any of the provided mailboxes: MAILBOXES

Action failed to run because the provided mailbox folder name FOLDER_NAME was not found in the mailbox MAILBOX.

Error executing action. Reason: ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Download Attachments From Email:

Nome do resultado do script Valor
is_success True ou False

Extraia dados de ficheiros EML anexados

Use a ação Extrair dados de EML anexado para obter dados dos anexos EML de email e devolvê-los nos resultados da ação. Esta ação suporta os formatos de ficheiro .eml, .msg e .ics.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Extrair dados do EML anexado requer os seguintes parâmetros:

Parâmetro Descrição
Search In Mailbox

Obrigatório.

A caixa de correio predefinida onde a operação de pesquisa é executada. Se as autorizações o permitirem, a ação também pode pesquisar noutras caixas de correio. Este parâmetro aceita vários valores como uma string separada por vírgulas.
Folder Name

Opcional.

Uma pasta da caixa de correio onde executar a pesquisa. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Mail IDs

Obrigatório.

Uma condição de filtro para pesquisar emails com IDs de email específicos.

Este parâmetro aceita uma lista de IDs de email separados por vírgulas para pesquisar.
Regex Map JSON

Opcional.

Uma definição JSON que contém expressões regulares a aplicar ao ficheiro de email anexado e gerar valores-chave adicionais no resultado JSON da ação. O exemplo do valor deste parâmetro é o seguinte:

{ips: \\b\\\\d{1,3}\\\\.\\\\d{1,3}\\\\.\\\\d{1,3}\\\\.\\\\d{1,3}\\b}

Resultados da ação

A ação Extrair dados do EML anexado fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte descreve a saída do resultado JSON recebida quando usa a ação Extrair dados do EML anexado:

[
    {
        "type": "EML",
        "subject": "examplesubject",
        "from": "sender@example.com",
        "to": "user1@example.com,user2@example.com",
        "date": "Thu,4Jul202412:11:29+0530",
        "text": "text",
        "html": "<p>example-html</p>",
        "regex": {},
        "regex_from_text_part": {},
        "id": "ID",
        "name": "example.eml"
    },
    {
        "type": "MSG",
        "subject": "examplesubject",
        "from": "user@example.com",
        "to": "user1@example.com,user2@example.com",
        "date": "Thu,4Jul202412:11:29+0530",
        "text": "text",
        "html": "<p>examplehtml</p>",
        "regex": {},
        "regex_from_text_part": {},
        "id": "ID",
        "name": "example.msg"
    },
    {
        "type": "ICS",
        "subject": "examplesubject",
        "from": "sender@example.com",
        "to": "user1@example.com,user2@example.com",
        "date": "Thu,4Jul202412:11:29+0530",
        "text": "text",
        "html": "<p>example-html</p>",
        "regex": {},
        "regex_from_text_part": {},
        "id": "ID",
        "name": "example.ics"
    }
]
Mensagens de saída

A ação Extrair dados de EML anexado fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Extracted data from ATTACHMENT_NAMES attached email files. Files: PATHS

Failed to find emails in MAILBOX with the following mail ids: MAIL_ID_LIST

 Ação efetuada com êxito.

Failed to find any emails using the provided criteria!

Failed to find any of the provided mailboxes: MAILBOX_LIST

Action failed to run because the provided mailbox folder name MAILBOX_FOLDER was not found in the mailbox MAILBOX

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores para o resultado do script quando usa a ação Extrair dados do EML anexado:

Nome do resultado do script Valor
is_success True ou False

Encaminhar email

Use a ação Encaminhar email para encaminhar emails que incluem discussões anteriores. Com as autorizações adequadas, esta ação pode enviar emails a partir de uma caixa de correio diferente da especificada na configuração da integração.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Encaminhar email requer os seguintes parâmetros:

Parâmetro Descrição
Send From

Obrigatório.

Um endereço de email opcional a partir do qual enviar um email, se as autorizações o permitirem.

Por predefinição, o email é enviado a partir da caixa de correio predefinida especificada na configuração da integração.
Folder Name

Opcional.

Uma pasta da caixa de correio para pesquisar emails. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Mail ID

Obrigatório.

O ID do email a encaminhar.
Subject

Obrigatório.

O assunto do email.
Send to

Obrigatório.

Uma lista de endereços de email separados por vírgulas para os destinatários do email, como user1@example.com, user2@example.com.
CC

Opcional.

Uma lista de endereços de email separados por vírgulas para o campo CC do email.

O formato é o mesmo que o do parâmetro Send to.
BCC

Opcional.

Uma lista de endereços de email separados por vírgulas para o campo BCC do email.

O formato é o mesmo que o do parâmetro Send to.
Attachments Paths

Opcional.

Uma lista separada por vírgulas de caminhos para anexos de ficheiros armazenados no servidor, como /FILE_DIRECTORY/file.pdf, /FILE_DIRECTORY/image.jpg.
Mail content

Obrigatório.

O corpo do email.

Resultados da ação

A tabela seguinte descreve os tipos de saída associados à ação Encaminhar email:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Encaminhar email apresenta as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem
Email with message ID MAIL_ID was forwarded successfully. Ação efetuada com êxito.

Error executing action "Forward Email" because the provided mail id EMAIL_ID was not found.

Action failed to delete any emails because the provided mailbox folder name was not found in the mailbox(es): MAILBOX: MAILBOX_FOLDER

Action failed to run because specified attachments were not found: ATTACHMENTS_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Encaminhar email:

Nome do resultado do script Valor
is_success True ou False

Obtenha a conta da caixa de correio fora das definições da instalação

Use a ação Get Mailbox Account Out Of Facility Settings para obter as definições da conta de caixa de correio fora das instalações (OOF) para a entidade Google SecOps User fornecida.

A ação Get Mailbox Account Out Of Facility Settings usa a versão beta da API Microsoft Graph.

Esta ação é executada na entidade User do Google SecOps.

Dados de ações

Nenhum.

Resultados da ação

A ação Get Mailbox Account Out Of Facility Settings fornece as seguintes saídas:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte mostra o resultado JSON recebido quando usa a ação Get Mailbox Account Out Of Facility Settings:

{
   "@odata.context": "https://graph.microsoft.com/beta/$metadata#communications/presences/$entity",
   "id": "ID",
   "availability": "Offline",
   "activity": "Offline",
   "statusMessage": null,
   "outOfOfficeSettings": {
       "message": "\n\nOut Of Facility111\n",
       "isOutOfOffice": true
   }
}
Mensagens de saída

A ação Get Mailbox Account Out Of Facility Settings pode devolver as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully returned OOF settings for ENTITY_ID.

Failed to find the following usernames in Office 365 service: USERNAME_LIST.

 A ação foi bem-sucedida.

Error executing action "Add Identity Protection Detection Comment". Reason: ERROR_REASON

Action wasn't able to find OOF settings for ENTITY_ID.

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte indica o valor da saída do resultado do script quando usa a ação Get Mailbox Account Out Of Facility Settings:

Nome do resultado do script Valor
is_success True ou False

Marque o email como lixo eletrónico

Use a ação Marcar email como lixo eletrónico para marcar emails como lixo eletrónico numa caixa de correio especificada. Esta ação adiciona o remetente do email à lista de remetentes bloqueados e move a mensagem para a pasta Lixo eletrónico.

A ação Marcar email como lixo eletrónico usa a versão beta da API Microsoft Graph.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Marcar email como lixo eletrónico requer os seguintes parâmetros:

Parâmetro Descrição
Search In Mailbox

Obrigatório.

Uma caixa de correio onde pesquisar o email.

Por predefinição, a ação tenta pesquisar o email na caixa de correio predefinida que especificou na configuração da integração. Para executar uma pesquisa noutras caixas de correio, configure as autorizações adequadas para a ação.

Este parâmetro aceita vários valores como uma string separada por vírgulas.
Folder Name

Obrigatório.

Uma pasta da caixa de correio onde pesquisar emails. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.

O valor predefinido é Inbox.
Mail IDs

Obrigatório.

Os IDs ou os valores das mensagens de correio eletrónico a marcar como lixo eletrónico.internetMessageId

Este parâmetro aceita vários valores como uma string separada por vírgulas.

Resultados da ação

A ação Marcar email como lixo eletrónico fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Marcar email como lixo eletrónico pode devolver as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully marked the email as junk.

Failed to find email with ID ID in MAILBOX.

Mailbox MAILBOX was not found.

 A ação foi bem-sucedida.

Error executing action "Mark Email as Junk". Reason: ERROR_REASON

Failed to find any emails based on provided parameters!

Action failed to run because the provided mailbox folder name MAILBOX_FOLDER was not found in the mailbox MAILBOX.

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte indica o valor do resultado do script quando usa a ação Marcar email como lixo eletrónico:

Nome do resultado do script Valor
is_success True ou False

Marque o email como não sendo lixo eletrónico

Use a ação Marcar email como não sendo lixo eletrónico para marcar emails como não sendo lixo eletrónico numa caixa de correio específica. Esta ação remove o remetente da lista de remetentes bloqueados e move a mensagem para a pasta Caixa de entrada.

A ação Marcar email como não sendo lixo eletrónico usa a versão beta da API Microsoft Graph.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Marcar email como não sendo lixo eletrónico requer os seguintes parâmetros:

Parâmetro Descrição
Search In Mailbox

Obrigatório.

Uma caixa de correio onde pesquisar um email.

Por predefinição, a ação tenta pesquisar o email na caixa de correio predefinida que especificou na configuração da integração. Para executar uma pesquisa noutras caixas de correio, configure as autorizações adequadas para a ação.

Este parâmetro aceita vários valores como uma string separada por vírgulas.
Folder Name

Obrigatório.

Uma pasta da caixa de correio onde pesquisar emails. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Mail IDs

Obrigatório.

Os IDs ou os valores das mensagens de correio eletrónico a marcar como lixo eletrónico.internetMessageId

Este parâmetro aceita vários valores como uma string separada por vírgulas.

Resultados da ação

A ação Marcar email como não lixo eletrónico fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Marcar email como não sendo lixo eletrónico pode devolver as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully marked the email as not junk.

Failed to find email with ID ID in MAILBOX.

Mailbox MAILBOX was not found.

 A ação foi bem-sucedida.

Error executing action "Mark Email as Not Junk". Reason: ERROR_REASON

Failed to find any emails based on provided parameters!

Action failed to run because the provided mailbox folder name MAILBOX_FOLDER was not found in the mailbox MAILBOX.

A ação falhou.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte lista o valor da saída do resultado do script quando usa a ação Marcar email como não lixo eletrónico:

Nome do resultado do script Valor
is_success True ou False

Mover email para pasta

Use a ação Mover email para pasta para mover um ou vários emails da pasta de email de origem para a outra pasta na caixa de correio. Com as autorizações adequadas, esta ação pode mover emails para outras caixas de correio diferentes da que é fornecida na configuração da integração.

Esta ação é assíncrona. Ajuste o limite de tempo da ação no ambiente de programação integrado (IDE) do Google SecOps, conforme necessário.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

Para configurar a ação Mover email para pasta, use os seguintes parâmetros:

Parâmetro Descrição
Move In Mailbox

Obrigatório.

A caixa de correio predefinida onde a operação de movimento é executada. Se as autorizações o permitirem, a ação também pode pesquisar noutras caixas de correio. Este parâmetro aceita vários valores como uma string separada por vírgulas.

Source Folder Name

Obrigatório.

Uma pasta de origem a partir da qual mover o email. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Destination Folder Name

Obrigatório.

Uma pasta de destino para mover o email.

Forneça o valor do parâmetro no seguinte formato: Inbox/folder_name/subfolder_name. Este parâmetro não é sensível a maiúsculas e minúsculas.
Mail IDs

Opcional.

Uma condição de filtro para pesquisar emails com IDs de email específicos.

Este parâmetro aceita uma lista de IDs de email separados por vírgulas para pesquisar.

Se este parâmetro for fornecido, a pesquisa ignora os parâmetros Subject Filter e Sender Filter.
Subject Filter

Opcional.

Uma condição de filtro que especifica o assunto do email a pesquisar.

Este filtro usa a lógica contains.
Sender Filter

Opcional.

Uma condição de filtro que especifica o remetente dos emails pedidos.

Este filtro usa a lógica equals.
Timeframe (Minutes)

Opcional.

Uma condição de filtro que especifica o período, em minutos, para pesquisar emails.
Only Unread

Opcional.

Se estiver selecionada, a ação pesquisa apenas emails não lidos.

Não selecionado por predefinição.
How many mailboxes to process in a single batch

Opcional.

O número de caixas de correio a processar num único lote (uma única ligação ao servidor de correio).

O valor predefinido é 25.

Resultados da ação

A tabela seguinte descreve os tipos de resultados associados à ação Mover email para pasta:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Mover email para pasta fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Successfully moved emails in the following mailboxes: MAILBOX: MOVED_EMAILS_NUMBER

Mailbox MAILBOX was not found.

 Ação efetuada com êxito.

Action was not able to find any emails based on the specified search criteria.

Action failed to move any emails because the provided source folder was not found in the mailbox(es): MAILBOX_NAME, MAILBOX_FOLDER

Action failed to move any emails because the provided destination folder was not found in the mailbox(es): MAILBOX_NAME, MAILBOX_FOLDER

Failed to find any of the provided mailboxes: MAILBOX_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Move Email To Folder (Mover email para pasta):

Nome do resultado do script Valor
is_success True ou False

Tchim-tchim

Use a ação Ping para testar a conetividade ao serviço de correio do Microsoft Graph.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

Nenhum.

Resultados da ação

A tabela seguinte descreve os tipos de saída associados à ação Ping:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Ping apresenta as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem
Successfully connected to the Microsoft Graph mail service with the provided connection parameters! Ação efetuada com êxito.
Failed to connect to the Microsoft Graph mail service! Error is ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Ping:

Nome do resultado do script Valor
is_success True ou False

Guarde o email no registo

Use a ação Guardar email no registo para guardar emails ou anexos de email no mural de registos do Google SecOps. Com as autorizações adequadas, esta ação pode guardar emails de caixas de correio diferentes da que foi fornecida na configuração da integração.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Guardar email no registo requer os seguintes parâmetros:

Parâmetro Descrição
Search In Mailbox

Obrigatório.

A caixa de correio predefinida onde a operação de pesquisa é executada. Se as autorizações o permitirem, a ação também pode pesquisar noutras caixas de correio.
Folder Name

Opcional.

Uma pasta da caixa de correio onde pesquisar emails. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Mail ID

Obrigatório.

Uma lista de IDs de email separados por vírgulas para pesquisar.

Se usou a ação Enviar email para enviar emails, defina o valor do parâmetro para o marcador de posição {SendEmail.JSONResult|id} ou {SendEmail.JSONResult|internetMessageId}.
Save Only Email Attachments

Opcional.

Se estiver selecionada, a ação guarda apenas os anexos do email especificado.

Não selecionado por predefinição.
Attachment To Save

Opcional.

Se o parâmetro Save Only Email Attachments for selecionado, a ação apenas guarda os anexos especificados por este parâmetro.

Este parâmetro aceita vários valores como uma string separada por vírgulas.
Base64 Encode

Opcional.

Se esta opção estiver selecionada, a ação codifica o ficheiro de email no formato base64.

Não selecionado por predefinição.

Resultados da ação

A tabela seguinte descreve os tipos de saída associados à ação Guardar email no registo:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Fixação à parede da caixa

Os seguintes anexos estão associados à ação Guardar email no registo:

  • EMAIL_SUBJECT.eml, se a ação guardar o email.

  • Se a ação guardar o anexo, o nome do anexo contém uma extensão de ficheiro, se existir.

Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação Save Email To The Case:

{
    "id": "ID",
    "createdDateTime": "2024-02-16T14:10:34Z",
    "eml_info": "example_info",
    "lastModifiedDateTime": "2024-02-16T14:10:41Z",
    "changeKey": "cxsdjjh",
    "categories": [],
    "receivedDateTime": "2024-02-16T14:10:35Z",
    "sentDateTime": "2024-02-16T14:09:36Z",
    "hasAttachments": true,
    "internetMessageId": "INTERNET_MESSAGE_ID",
    "subject": "all attachments",
    "bodyPreview": "all the attachments",
    "importance": "normal",
    "parentFolderId": "PARENT_FOLDER_ID",
    "conversationId": "CONVERSATION_ID",
    "conversationIndex": "example-index",
    "isDeliveryReceiptRequested": false,
    "isReadReceiptRequested": false,
    "isRead": true,
    "isDraft": false,
    "webLink": "https://example.com/",
    "inferenceClassification": "focused",
    "body": {
        "contentType": "html",
        "content": "<html><head>example-html</head></html>"
    },
    "sender": {
        "emailAddress": {
            "name": "NAME",
            "address": "sender@example.com"
        }
    },
    "from": {
        "emailAddress": {
            "name": "NAME",
            "address": "user@example.com"
        }
    },
    "toRecipients": [
        {
            "emailAddress": {
                "name": "NAME",
                "address": "recipient@example.com"
            }
        }
    ],
    "ccRecipients": [],
    "bccRecipients": [],
    "replyTo": [],
    "flag": {
        "flagStatus": "notFlagged"
    }
}
Mensagens de saída

Numa cronologia do registo, a ação Guardar email no registo fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Email successfully saved!

Successfully saved the following attachments: ATTACHMENTS_LIST

The following attachments were not found in email with mail id: EMAIL_ID: ATTACHMENTS_LIST

 Ação efetuada com êxito.

Mailbox MAILBOX_NAME was not found.

Action failed to run because the provided mailbox folder name MAILBOX_FOLDER was not found in the mailbox MAILBOX_NAME

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Guardar email no registo:

Nome do resultado do script Valor
is_success True ou False

Pesquisar emails

Use a ação Pesquisar emails para executar a pesquisa de emails na caixa de correio predefinida com base nos critérios de pesquisa fornecidos. Com as autorizações adequadas, esta ação pode executar uma pesquisa noutras caixas de correio.

Esta ação é assíncrona. Ajuste o limite de tempo da ação no IDE do Google SecOps conforme necessário.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Pesquisar emails requer os seguintes parâmetros:

Parâmetro Descrição
Search In Mailbox

Obrigatório.

A caixa de correio predefinida onde a operação de pesquisa é executada. Se as autorizações o permitirem, a ação também pode pesquisar noutras caixas de correio. Este parâmetro aceita vários valores como uma string separada por vírgulas.

Para pesquisas complexas num número significativo de caixas de correio, use a integração do Exchange Extension Pack.
Folder Name

Obrigatório.

Uma pasta da caixa de correio onde pesquisar emails. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.
Subject Filter

Opcional.

Uma condição de filtro que especifica o assunto do email a pesquisar.

Este filtro usa a lógica contains.
Sender Filter

Opcional.

Uma condição de filtro que especifica o remetente dos emails pedidos.

Este filtro usa a lógica equals.
Timeframe (Minutes)

Opcional.

Uma condição de filtro que especifica o período em minutos para pesquisar emails.
Max Emails To Return

Opcional.

O número de emails para a ação a devolver.

Se não definir um valor, é usado o valor predefinido da API.

O valor predefinido é 10.
Only Unread

Opcional.

Se estiver selecionada, a ação pesquisa apenas emails não lidos.

Não selecionado por predefinição.
All Fields To Return

Opcional.

Se selecionada, a ação devolve todos os campos disponíveis para o email obtido.

Não selecionado por predefinição.
How many mailboxes to process in a single batch

Opcional.

O número de caixas de correio a processar num único lote (uma única ligação ao servidor de correio).

O valor predefinido é 25.

Resultados da ação

A tabela seguinte descreve os tipos de saída associados à ação Search Emails:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mesa de parede para caixas

Numa página de registo, a ação Pesquisar emails apresenta a seguinte tabela:

Título da tabela: Emails correspondentes

Colunas:

  • ID do email
  • Assunto
  • Remetente
  • Destinatários
  • Data de receção
Mensagens de saída

A ação Pesquisar emails fornece as seguintes mensagens de saída:

Action was not able to find any emails based on the specified search criteria.

Mensagem de saída Descrição da mensagem

Successfully found emails in the following mailboxes: MAILBOX: FOUND_EMAILS_NUMBER

Mailbox MAILBOX was not found.

 Ação efetuada com êxito.

Failed to find any of the provided mailboxes: MAILBOX_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Pesquisar emails:

Nome do resultado do script Valor
is_success True ou False

Enviar email

Use a ação Enviar email para enviar emails de uma caixa de correio específica para uma lista arbitrária de destinatários.

Esta ação pode enviar emails em texto simples ou formatados em HTML. Com as autorizações adequadas, a ação pode enviar emails a partir de uma caixa de correio diferente da especificada na configuração da integração.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Enviar email requer os seguintes parâmetros:

Parâmetro Descrição
Send From

Obrigatório.

Um endereço de email opcional a partir do qual enviar emails, se as autorizações o permitirem.

Por predefinição, a ação envia emails a partir da caixa de correio predefinida especificada na configuração da integração.
Subject

Obrigatório.

O assunto do email.
Send to

Obrigatório.

Uma lista de endereços de email separados por vírgulas para os destinatários do email, como user1@example.com, user2@example.com.
CC

Opcional.

Uma lista de endereços de email separados por vírgulas para o campo CC do email.

O formato é o mesmo que o do parâmetro Send to.
BCC

Opcional.

Uma lista de endereços de email separados por vírgulas para o campo BCC do email.

O formato é o mesmo que o do parâmetro Send to.
Attachments Paths

Opcional.

Uma lista separada por vírgulas de caminhos para anexos de ficheiros armazenados no servidor, como /FILE_DIRECTORY/file.pdf, /FILE_DIRECTORY/image.jpg.
Attachments Location

Obrigatório.

Uma localização onde os anexos são armazenados.

Por predefinição, a ação tenta carregar anexos a partir do contentor do Cloud Storage.

Os valores possíveis são GCP Bucket ou Local File System. O valor predefinido é GCP Bucket.
Mail Content Type

Opcional.

O tipo de conteúdo do email.

Os valores possíveis são os seguintes:

  • Text
  • HTML

O valor predefinido é Text.
Mail Content

Obrigatório.

O corpo do email.
Reply-To Recipients

Opcional.

Uma lista de destinatários separada por vírgulas a usar no cabeçalho Reply-To.

Use o cabeçalho Reply-To para redirecionar emails de resposta para o endereço de email especificado em vez do endereço do remetente no campo From.

Resultados da ação

A tabela seguinte descreve os tipos de saída associados à ação Send Email:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Enviar email fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Email was sent successfully.

 Ação efetuada com êxito.

Action failed to run because specified attachments were not found: ATTACHMENTS_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Enviar email:

Nome do resultado do script Valor
is_success True ou False

Enviar HTML de email

Use a ação Enviar email HTML para enviar emails que usam o modelo HTML do Google SecOps de uma caixa de correio específica para uma lista arbitrária de destinatários. Com as autorizações adequadas, a ação pode enviar emails a partir de uma caixa de correio diferente da predefinida.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Enviar email HTML requer os seguintes parâmetros:

Parâmetro Descrição
Send From

Obrigatório.

Um endereço de email opcional a partir do qual enviar emails, se as autorizações o permitirem.

Por predefinição, a ação envia emails a partir da caixa de correio predefinida especificada na configuração da integração.
Subject

Obrigatório.

O assunto do email.
Send to

Obrigatório.

Uma lista de endereços de email separados por vírgulas para os destinatários do email, como user1@example.com, user2@example.com.
CC

Opcional.

Uma lista de endereços de email separados por vírgulas para o campo CC do email.

O formato é o mesmo que o do parâmetro Send to.
BCC

Opcional.

Uma lista de endereços de email separados por vírgulas para o campo BCC do email.

O formato é o mesmo que o do parâmetro Send to.
Attachments Paths

Opcional.

Um caminho completo para o anexo a fornecer, como /FILE_DIRECTORY/file.pdf, /FILE_DIRECTORY/image.jpg.

Pode fornecer vários valores numa string separada por vírgulas.
Email HTML Template

Obrigatório.

O tipo de modelo HTML a usar.

Os valores possíveis são Email HTML Template e Dynamically generated list of available templates.

O valor predefinido é Email HTML Template.
Mail Content

Obrigatório.

O corpo do email.
Reply-To Recipients

Opcional.

Uma lista de destinatários separada por vírgulas a usar no cabeçalho Reply-To.

Use o cabeçalho Reply-To para redirecionar os emails de resposta para o endereço de email específico em vez do endereço do remetente indicado no campo From.
Attachment Location

Obrigatório.

Uma localização onde os anexos são armazenados.

Por predefinição, a ação tenta carregar anexos a partir do contentor do Cloud Storage.

Os valores possíveis são GCP Bucket ou Local File System. O valor predefinido é GCP Bucket.

Resultados da ação

A ação Enviar email HTML fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação Enviar email HTML:

{
    "createdDateTime": "2024-01-30T16:50:27Z",
    "lastModifiedDateTime": "2024-01-30T16:50:27Z",
    "changeKey": "example-key",
    "categories": [],
    "receivedDateTime": "2024-01-30T16:50:27Z",
    "sentDateTime": "2024-01-30T16:50:27Z",
    "hasAttachments": false,
    "internetMessageId": "outlook.com",
    "subject": "Testing",
    "bodyPreview": "example",
    "importance": "normal",
    "parentFolderId": "ID",
    "conversationId": "ID",
    "conversationIndex": "INDEX",
    "isDeliveryReceiptRequested": false,
    "isReadReceiptRequested": false,
    "isRead": true,
    "isDraft": false,
    "webLink": "https://example.com",
    "inferenceClassification": "focused",
    "body": {
        "contentType": "html",
        "content": "content"
    },
    "sender": {
        "emailAddress": {
            "name": "NAME",
            "address": "sender@example.com"
        }
    },
    "from": {
        "emailAddress": {
            "name": "NAME",
            "address": "user@example.com"
        }
    },
    "toRecipients": [
        {
            "emailAddress": {
                "name": "NAME",
                "address": "recipient@example.com"
            }
        }
    ],
    "ccRecipients": [],
    "bccRecipients": [],
    "replyTo": [],
    "uniqueBody": {
        "contentType": "html",
        "content": "content"
    },
    "flag": {
        "flagStatus": "notFlagged"
    },
    "id": "ID"
}
Mensagens de saída

Numa Case Wall, a ação Enviar email HTML fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem
Email was sent successfully. Ação efetuada com êxito.

Action failed to run because the HTML template was not specified.

Action failed to run because the following specified attachments were not found: ATTACHMENT_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do guião quando usa a ação Enviar email HTML:

Nome do resultado do script Valor
is_success True ou False

Enviar resposta à discussão

Use a ação Enviar resposta na discussão para enviar uma mensagem como resposta à discussão de email. Com as autorizações adequadas, a ação pode enviar emails a partir de uma caixa de correio diferente da especificada na configuração da integração.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Send Thread Reply requer os seguintes parâmetros:

Parâmetro Descrição
Send From

Obrigatório.

Um endereço de email opcional a partir do qual enviar emails, se as autorizações o permitirem.

Por predefinição, a ação envia emails a partir da caixa de correio predefinida especificada na configuração da integração.
Mail ID

Obrigatório.

O ID do email a pesquisar.
Folder Name

Opcional.

Uma pasta da caixa de correio onde pesquisar emails. Para especificar uma subpasta, use a barra /, como Inbox/Subfolder.

O valor predefinido é Inbox.
Attachments Paths

Opcional.

Uma lista separada por vírgulas de caminhos para anexos de ficheiros armazenados no servidor, como /FILE_DIRECTORY/file.pdf, /FILE_DIRECTORY/image.jpg.
Mail Content

Obrigatório.

O corpo do email.
Reply All

Opcional.

Se selecionada, a ação envia uma resposta a todos os destinatários relacionados com o email original.

Não selecionado por predefinição.

Este parâmetro tem prioridade sobre o parâmetro Reply To.
Reply To

Opcional.

Uma lista de emails separados por vírgulas para os quais enviar a resposta.

Se não fornecer nenhum valor e a caixa de verificação Reply All não estiver selecionada, a ação envia apenas uma resposta ao remetente do email original.

Se a caixa de verificação Reply All estiver selecionada, a ação ignora este parâmetro.
Attachments Location

Obrigatório.

Uma localização onde os anexos são armazenados.

Por predefinição, a ação tenta carregar anexos a partir do contentor do Cloud Storage.

Os valores possíveis são GCP Bucket ou Local File System. O valor predefinido é GCP Bucket.

Resultados da ação

A tabela seguinte descreve os tipos de saída associados à ação Send Thread Reply:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Mensagens de saída Disponível
Resultado do script Disponível
Mensagens de saída

A ação Send Thread Reply (Enviar resposta à discussão) fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem
Successfully sent reply to the mail with ID: EMAIL_ID Ação efetuada com êxito.
Error executing action "Send Thread Reply". Reason: if you want to send a reply only to your own email address, you need to work with "Reply To" parameter.

Falha na ação.

Verifique o valor do parâmetro Reply To.

Error executing action "Send Thread Reply" because the provided mail id EMAIL_ID was not found.

Action failed to run because specified attachments were not found: ATTACHMENTS_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Send Thread Reply:

Nome do resultado do script Valor
is_success True ou False

Enviar email de votação

Use a ação Enviar email de votação para enviar emails com as opções de resposta predefinidas. Esta ação usa modelos HTML do Google SecOps para formatar o email. Com as autorizações adequadas, a ação Enviar email de votação pode enviar emails a partir de uma caixa de correio diferente da predefinição.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Send Vote Email requer os seguintes parâmetros:

Parâmetro Descrição
Send From

Obrigatório.

Um endereço de email opcional a partir do qual enviar emails, se as autorizações o permitirem.

Por predefinição, a ação envia emails a partir da caixa de correio predefinida especificada na configuração da integração.
Subject

Obrigatório.

O assunto do email.
Send to

Obrigatório.

Uma lista de endereços de email separados por vírgulas para os destinatários do email, como user1@example.com, user2@example.com.
CC

Opcional.

Uma lista de endereços de email separados por vírgulas para o campo CC do email.

O formato é o mesmo que o do parâmetro Send to.
BCC

Opcional.

Uma lista de endereços de email separados por vírgulas para o campo BCC do email.

O formato é o mesmo que o do parâmetro Send to.
Attachments Paths

Opcional.

Um caminho completo para o anexo a fornecer, como /FILE_DIRECTORY/file.pdf, /FILE_DIRECTORY/image.jpg.

Pode fornecer vários valores numa string separada por vírgulas.
Email HTML Template

Obrigatório.

O tipo de modelo HTML a usar.

Os valores possíveis são Email HTML Template e Dynamically generated list of available templates.

O valor predefinido é Email HTML Template.
Reply-To Recipients

Opcional.

Uma lista de destinatários separada por vírgulas a usar no cabeçalho Reply-To.

Use o cabeçalho Reply-To para redirecionar os emails de resposta para o endereço de email especificado em vez do endereço do remetente indicado no campo De.
Structure of voting options

Obrigatório.

A estrutura da votação a enviar aos destinatários.

Os valores possíveis são Yes/No ou Approve/Reject. O valor predefinido é Yes/No.

Attachment Location

Obrigatório.

Uma localização onde os anexos são armazenados.

Por predefinição, a ação tenta carregar o anexo a partir do contentor do Cloud Storage.

Os valores possíveis são GCP Bucket ou Local File System. O valor predefinido é GCP Bucket.

Resultados da ação

A ação Enviar email de votação fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Não disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Não disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação Send Vote Email:

{
    "createdDateTime": "2024-01-30T16:50:27Z",
    "lastModifiedDateTime": "2024-01-30T16:50:27Z",
    "changeKey": "KEY",
    "categories": [],
    "receivedDateTime": "2024-01-30T16:50:27Z",
    "sentDateTime": "2024-01-30T16:50:27Z",
    "hasAttachments": false,
    "internetMessageId": "<example-message-ID>",
    "subject": "Testing",
    "bodyPreview": "example",
    "importance": "normal",
    "parentFolderId": "FOLDER_ID",
    "conversationId": "CONVERSATION_ID",
    "conversationIndex": "CONVERSATION_INDEX",
    "isDeliveryReceiptRequested": false,
    "isReadReceiptRequested": false,
    "isRead": true,
    "isDraft": false,
    "webLink": "https://www.example.com/about",
    "inferenceClassification": "focused",
    "body": {
        "contentType": "html",
        "content": "content"
    },
    "sender": {
        "emailAddress": {
            "name": "NAME",
            "address": "sender@example.com"
        }
    },
    "from": {
        "emailAddress": {
            "name": "NAME",
            "address": "user@example.com"
        }
    },
    "toRecipients": [
        {
            "emailAddress": {
                "name": "NAME",
                "address": "recipient@example.com"
            }
        }
    ],
    "ccRecipients": [],
    "bccRecipients": [],
    "replyTo": [],
    "uniqueBody": {
        "contentType": "html",
        "content": "content"
    },
    "flag": {
        "flagStatus": "notFlagged"
    },
    "id": "ID"
}
Mensagens de saída

Num mural de registos, a ação Enviar email de votação fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem
Email was sent successfully. Ação efetuada com êxito.

Action failed to run because the HTML template was not specified.

Action failed to run because the following specified attachments were not found: ATTACHMENT_LIST

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Send Vote Email:

Nome do resultado do script Valor
is_success True ou False

Wait For Email From User

Use a ação Aguardar email do utilizador para aguardar a resposta do utilizador com base num email enviado através da ação Enviar email.

Esta ação é assíncrona. Ajuste o limite de tempo da ação no IDE do Google SecOps conforme necessário.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Aguardar email do utilizador requer os seguintes parâmetros:

Parâmetro Descrição
Mail ID

Obrigatório.

O ID do email.

Se usou a ação Enviar email para enviar emails, defina o valor do parâmetro para o marcador de posição {SendEmail.JSONResult|id} ou {SendEmail.JSONResult|internetMessageId}.
Wait for All Recipients To Reply?

Opcional.

Se selecionada, a ação aguarda respostas de todos os destinatários até atingir o limite de tempo ou prosseguir com a primeira resposta.

Selecionado por predefinição.
Wait Stage Exclude Pattern

Opcional.

Uma expressão regular para excluir respostas específicas da fase de espera. Este parâmetro funciona com o corpo do email.

Por exemplo, se configurar a expressão regular, a ação não considera as mensagens automáticas de ausência do escritório como respostas de destinatários e aguarda a resposta de um utilizador real.Out of Office.*
Folder To Check For Reply

Opcional.

Uma pasta de email da caixa de correio para pesquisar a resposta do utilizador. A pesquisa é executada na caixa de correio a partir da qual o email com uma pergunta foi enviado.

Este parâmetro é sensível a maiúsculas e minúsculas.

O valor predefinido é Inbox.
Fetch Response Attachments

Opcional.

Se esta opção for selecionada e a resposta do destinatário contiver anexos, a ação obtém a resposta e adiciona-a como um anexo ao resultado da ação.

Não selecionado por predefinição.

Resultados da ação

A tabela seguinte descreve os tipos de resultados associados à ação Aguardar email do utilizador:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Disponível
Tabela de enriquecimento Não disponível
Resultado JSON Não disponível
Mensagens de saída Disponível
Resultado do script Disponível
Fixação à parede da caixa

O anexo da capa de parede seguinte está associado à ação Aguardar email de utilizador:

Tipo: entidade

Conteúdo do anexo: título, nome do ficheiro (extensões incluídas, se existirem), fileContent.

  • Título: RECIPIENT_EMAIL anexo de resposta.
  • Nome do ficheiro: ATTACHMENT_FILENAME + FILE_EXTENSION
  • fileContent: CONTENT_OF_THE_ATTACHED_FILE
Mesa de parede para caixas

A ação Aguardar email do utilizador pode gerar a seguinte tabela:

Título da tabela: Emails correspondentes

Colunas:

  • ID do email
  • Data de receção
  • Remetente
  • Destinatários
  • Assunto
Mensagens de saída

A ação Wait For Mail From User fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Found the user EMAIL_RECIPIENT reply: USER_REPLY

Timeout getting reply from user: EMAIL_RECIPIENT.

 Ação efetuada com êxito.

Action failed to receive any replies until timeout.

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Aguardar email do utilizador:

Nome do resultado do script Valor
is_success True ou False

Aguarde pelos resultados do email de votação

Use a ação Aguardar resultados do email de votação para aguardar a resposta do utilizador com base no email de votação enviado através da ação Enviar email de votação.

Esta ação é assíncrona. Ajuste o limite de tempo da ação no IDE do Google SecOps conforme necessário.

Esta ação não é executada em entidades do Google SecOps.

Dados de ações

A ação Wait For Vote Email Results requer os seguintes parâmetros:

Parâmetro Descrição
Vote Mail Sent From

Obrigatório.

A caixa de correio a partir da qual a ação Enviar email de votação enviou um email.

O valor predefinido é a caixa de correio que especificou na configuração da integração.

Opcionalmente, pode definir um valor diferente para este parâmetro se o email de votação for enviado a partir de uma caixa de correio diferente.
Mail ID

Obrigatório.

O ID do email.

Se o email for enviado através da ação Send Vote Email, defina o valor do parâmetro para o marcador de posição SendVoteEmail.JSONResult|id ou SendEmail.JSONResult|internetMessageId.

Para devolver IDs de email, pode usar a ação Pesquisar emails.
Wait for All Recipients To Reply?

Opcional.

Se selecionada, a ação aguarda respostas de todos os destinatários até atingir o limite de tempo ou prosseguir com a primeira resposta.

Selecionado por predefinição.
Wait Stage Exclude Pattern

Opcional.

Uma expressão regular para excluir respostas específicas da fase de espera.

Este parâmetro funciona com o corpo do email.

Exemplo: a ação não considera as mensagens automáticas de ausência do escritório como respostas de destinatários, mas aguarda uma resposta real do utilizador.
Folder To Check For Reply

Opcional.

Uma pasta de email da caixa de correio para pesquisar a resposta do utilizador. A pesquisa é executada na caixa de correio a partir da qual foi enviado o email que contém uma pergunta.

Este parâmetro aceita uma lista de pastas separada por vírgulas para verificar a resposta do utilizador em várias pastas.

Este parâmetro é sensível a maiúsculas e minúsculas.

O valor predefinido é Inbox.
Folder To Check For Sent Mail

Opcional.

Uma pasta da caixa de correio para pesquisar o correio enviado. É uma caixa de correio a partir da qual enviou o email com uma pergunta.

Este parâmetro aceita uma lista de pastas separada por vírgulas para verificar a resposta do utilizador em várias pastas.

Este parâmetro é sensível a maiúsculas e minúsculas. Para especificar uma subpasta, use a barra invertida, como Inbox/Subfolder./

O valor predefinido é Sent Items.
Fetch Response Attachments

Opcional.

Se esta opção for selecionada e a resposta do destinatário contiver anexos, a ação obtém a resposta e adiciona-a como um anexo ao mural do registo.

Não selecionado por predefinição.

Resultados da ação

A ação Wait For Vote Email Results fornece os seguintes resultados:

Tipo de saída da ação Disponibilidade
Fixação à parede da caixa Disponível
Link da parede da caixa Não disponível
Mesa de parede para caixas Disponível
Tabela de enriquecimento Não disponível
Resultado JSON Disponível
Mensagens de saída Disponível
Resultado do script Disponível
Fixação à parede da caixa

O anexo da Case Wall seguinte está associado à ação Wait For Vote Email Results:

Tipo: entidade

Conteúdo do anexo: título, nome do ficheiro (extensões incluídas, se existirem), fileContent.

  • Título: RECIPIENT_EMAIL anexo de resposta.
  • Nome do ficheiro: ATTACHMENT_FILENAME + FILE_EXTENSION
  • fileContent: CONTENT_OF_THE_ATTACHED_FILE
Mesa de parede para caixas

Num mural de registos, a ação Aguardar resultados do email gera a seguinte tabela:

Título da tabela: Emails correspondentes

Colunas:

  • ID do email
  • Data de receção
  • Remetente
  • Destinatários
  • Assunto
Resultado JSON

O exemplo seguinte descreve o resultado JSON recebido quando usa a ação Wait For Vote Email Results:

{
    "Responses": [
        {
            "recipient": "user@example.com",
            "vote": "Approve"
        }
    ]
}
Mensagens de saída

A ação Wait For Vote Email Results fornece as seguintes mensagens de saída:

Mensagem de saída Descrição da mensagem

Found the user EMAIL_RECIPIENT reply: USER_REPLY.

Exceeded timeout to get a reply from user: EMAIL_RECIPIENT.

 Ação efetuada com êxito.

Action failed to receive any replies until timeout.

Failed to execute action, the error is: ERROR_REASON

Falha na ação.

Verifique a ligação ao servidor, os parâmetros de entrada ou as credenciais.
Resultado do script

A tabela seguinte descreve os valores do resultado do script quando usa a ação Wait For Vote Email Results:

Nome do resultado do script Valor
is_success True ou False

Conetores

Para ver instruções detalhadas sobre como configurar um conector no Google SecOps, consulte o artigo Carregue os seus dados (conectores).

Conetor de correio do Microsoft Graph

Use o conetor de email do Microsoft Graph para obter emails do serviço de email do Microsoft Graph.

Use a lista dinâmica para filtrar os valores especificados das partes do corpo e do assunto do email através de expressões regulares. Por predefinição, o conetor usa uma expressão regular para filtrar os URLs do email.

Entradas do conetor

O Conector delegado de correio do Microsoft Graph requer os seguintes parâmetros:
Parâmetro Descrição
Product Field Name

Obrigatório.

O nome do campo onde o nome do produto está armazenado.

O valor predefinido é device_product.

O nome do produto afeta principalmente o mapeamento. Para simplificar e melhorar o processo de mapeamento do conector, o valor predefinido device_product é resolvido para um valor alternativo referenciado a partir do código. Qualquer entrada inválida para este parâmetro é resolvida para um valor alternativo por predefinição.
Event Field Name

Obrigatório.

O nome do campo usado para determinar o nome do evento (subtipo).

O valor predefinido é event_name.
Environment Field Name

Opcional.

O nome do campo onde o nome do ambiente está armazenado.

Se o campo de ambiente não for encontrado, o ambiente é definido como "".

Environment Regex Pattern

Opcional.

Um padrão de expressão regular a executar no valor encontrado no campo Environment Field Name. Este parâmetro permite-lhe manipular o campo de ambiente através da lógica de expressão regular.

Use o valor predefinido .* para obter o valor bruto Environment Field Name necessário.

Se o padrão de expressão regular for nulo ou estiver vazio, ou o valor do ambiente for nulo, o resultado final do ambiente é "".
Email Exclude Pattern

Opcional.

Uma expressão regular para excluir emails específicos da carregamento, como spam ou notícias.

Este parâmetro funciona com o assunto e o corpo do email.
PythonProcessTimeout

Obrigatório.

O limite de tempo limite, em segundos, para o processo Python que executa o script atual.

O valor predefinido é 300.
Azure AD Endpoint

Obrigatório.

O ponto final do Microsoft Entra a usar na integração.

O valor predefinido é https://login.microsoftonline.com.
Microsoft Graph Endpoint

Obrigatório.

O ponto final do Microsoft Graph a usar na integração.

O valor predefinido é https://graph.microsoft.com.
Mail Address

Obrigatório.

Um endereço de email para o conector usar.
Client ID

Obrigatório.

Um ID da app (cliente) da aplicação Microsoft Entra.
Secret ID

Obrigatório.

O valor do segredo do cliente da aplicação Microsoft Entra.
Tenant (Directory) ID

Obrigatório.

O valor do Microsoft Entra ID (ID do inquilino).
Folder to check for emails

Obrigatório.

Uma pasta de email para pesquisar os emails. Este parâmetro aceita uma lista de pastas separada por vírgulas para pesquisar a resposta do utilizador em várias pastas. Para especificar uma subpasta, use a barra invertida, como Inbox/Subfolder./

Este parâmetro é sensível a maiúsculas e minúsculas.

O valor predefinido é Inbox.
Offset Time In Hours

Obrigatório.

O número de horas antes da primeira iteração do conector para obter emails. Este parâmetro aplica-se à iteração inicial do conector depois de ativar o conector pela primeira vez. O conetor pode usar este parâmetro como um valor alternativo quando a data/hora da última iteração do conetor expira.

O valor predefinido é 24.
Max Emails Per Cycle

Obrigatório.

O número de emails a obter para cada iteração do conetor.

O valor predefinido é 10.
Unread Emails Only

Opcional.

Se esta opção estiver selecionada, o conector cria registos apenas a partir de emails não lidos.

Não selecionado por predefinição.
Mark Emails as Read

Opcional.

Se estiver selecionada, o conector marca os emails como lidos após a ingestão.

Não selecionado por predefinição.
Disable Overflow

Opcional.

Se selecionado, o conetor ignora o mecanismo de overflow do Google SecOps.

Não selecionado por predefinição.
Verify SSL

Obrigatório.

Se estiver selecionada, a integração valida o certificado SSL quando se liga ao Microsoft Graph.

Selecionado por predefinição.
Original Received Mail Prefix

Opcional.

Um prefixo a adicionar às chaves de eventos extraídas (por exemplo, to, from ou subject) do email original recebido na caixa de correio monitorizada.

O valor predefinido é orig.
Attached Mail File Prefix

Opcional.

Um prefixo a adicionar às chaves de eventos extraídas (por exemplo, to, from ou subject) do ficheiro de email anexado recebido na caixa de correio monitorizada.

O valor predefinido é attach.
Create a Separate Google Secops Alert per Attached Mail File

Opcional.

Se selecionada, o conector cria vários alertas, com um alerta para cada ficheiro de email anexado.

Este comportamento é útil quando processa emails com vários ficheiros de email anexados e define o mapeamento de eventos do Google SecOps para criar entidades a partir de ficheiros de email anexados.

Não selecionado por predefinição.
Attach Original EML

Opcional.

Se selecionado, o conetor anexa o email original às informações do registo como um ficheiro EML.

Não selecionado por predefinição.
Headers to add to events

Opcional.

Uma string separada por vírgulas de cabeçalhos de email a adicionar aos eventos do Google SecOps, como DKIM-Siganture, Received ou From.

Pode configurar uma correspondência exata para cabeçalhos ou definir este valor de parâmetro como uma expressão regular.

O conetor filtra os valores configurados da lista internetMessageHeaders e adiciona-os ao evento do Google SecOps.

Para impedir que o conector adicione cabeçalhos ao evento, defina o valor do parâmetro da seguinte forma: None.

Por predefinição, o conector adiciona todos os cabeçalhos disponíveis.
Case Name Template

Opcional.

Um nome do registo personalizado.

Quando configura este parâmetro, o conector adiciona uma nova chave denominada custom_case_name ao evento SOAR do Google SecOps.

Pode fornecer marcadores de posição no seguinte formato: [name of the field].

Exemplo: Phishing - [event_mailbox].

Para marcadores de posição, o conetor usa o primeiro evento do Google SecOps SOAR. O conector apenas processa chaves que contêm o valor de string.
Alert Name Template

Opcional.

Um nome de alerta personalizado.

Pode fornecer marcadores de posição no seguinte formato: [name of the field].

Exemplo: Phishing - [event_mailbox].

Para marcadores de posição, o conetor usa o primeiro evento do Google SecOps SOAR. O conector apenas processa chaves que contêm o valor de string. Se não fornecer nenhum valor ou um modelo inválido, o conetor usa o nome do alerta predefinido.
Proxy Server Address

Opcional.

O endereço do servidor proxy a usar.
Proxy Username

Opcional.

O nome de utilizador do proxy para autenticação.
Proxy Password

Opcional.

A palavra-passe do proxy para autenticação.
Mail Field Source

Opcional.

Se estiver selecionada, a integração obtém o endereço de email da caixa de correio do atributo mail dos detalhes do utilizador. Se não estiver selecionado, a integração obtém o endereço da caixa de correio do campo userPrincipalName.

Não selecionado por predefinição.
Base64 Encoded Private Key

Opcional.

Especifique uma chave privada codificada em base64 que vai ser usada para desencriptar o email.
Base64 Encoded Certificate

Opcional.

Especifique um certificado codificado em base64 que vai ser usado para descifrar o email.
Base64 Encoded CA certificate

Opcional.

Especifique um certificado de CA fidedigno codificado em base64 para a validação da assinatura.

Regras de conector

O conetor suporta proxies.

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais da Google SecOps.