E-mail

O conector de e-mail permite executar operações de inserção, exclusão, atualização e leitura no banco de dados do IMAP.

Antes de começar

Antes de usar o conector de e-mail, execute as seguintes tarefas:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Conceda a função IAM roles/connectors.admin ao usuário que está configurando o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em + Criar novo para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em Próxima.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione e-mail na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem ter mais de 49 caracteres.
    4. (Opcional) Descrição: insira uma descrição para a conexão.
    5. Como opção, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    7. Protocolo: o tipo de servidor de e-mail ao qual se conectar. Os valores válidos são IMAP e POP.
    8. Nível de verbosidade: esse campo determina a quantidade de detalhes que você quer incluir no arquivo de registro. Os valores válidos variam de 1 a 5. Um nível de detalhes mais alto registra todos os detalhes de comunicação, incluindo solicitação, resposta e certificados SSL.
    9. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    10. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
      • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
        • Básico: autenticação HTTP básica.
        • Resumo: autenticação HTTP de resumo.
      • Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
      • Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
      • Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
        • Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
        • Sempre: a conexão será sempre com SSL ativado.
        • Nunca: a conexão não está com SSL ativado.
        • Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
      • Na seção Servidor proxy, insira os detalhes do servidor proxy.
        1. Clique em + Adicionar destino.
        2. Selecione um Tipo de destino.
          • Endereço do host: especifique o nome do host ou o endereço IP do destino.

            Se quiser estabelecer uma conexão privada com seu sistema de back-end, faça o seguinte:

    11. Também é possível clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
    12. Clique em Próxima.
  5. Na seção Destinos, insira detalhes do nome ou endereço do servidor de e-mail ao qual você quer se conectar. O servidor oferece suporte aos protocolos IMAP ou POP.
    1. Tipo de destino: selecione um Tipo de destino. Por exemplo, digite o endereço do host e o número da porta. Por exemplo, o endereço do host é outlook.office365.com e a porta é 993.
      • Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
      • Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.

      Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.

    2. Se você quiser enviar e-mails, adicione os detalhes do servidor SMTP na seção SMTPServer clicando em +Adicionar destino. Depois, faça o seguinte:
      • Digite o endereço do host e o número da porta. Por exemplo, o endereço do host é smtp-mail.outlook.com e a porta é 587.
    3. Clique em Próxima.
  6. Na seção Autenticação, insira os detalhes da autenticação.
    1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      Os seguintes tipos de autenticação são compatíveis com a conexão do e-mail:

      • Nome de usuário e senha

      2. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

    2. Clique em Next.
  7. Revisão: revise os detalhes de conexão e autenticação.
  8. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

  • Nome de usuário e senha
    • Nome de usuário: o usuário da conta de e-mail usada para autenticação.
    • Senha: o Secret do Secret Manager que contém a senha da conta de e-mail usada para autenticação.

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

  • Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

    No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

  • Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações sem suporte não serão listadas na lista Operations.

  • Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e um de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Limitações do sistema

O conector de e-mail pode processar uma transação por segundo, por nó, e limita todas as transações além desse limite. Por padrão, os Integration Connectors alocam dois nós (para melhor disponibilidade) para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Ações

Esta seção lista as ações compatíveis com o conector. Para entender como configurar as ações, consulte Exemplos de ação.

Ação MoveEmails

Parâmetros de entrada da ação MoveEmails

Nome do parâmetro Tipo de dados Obrigatório Descrição
Descrição String Sim A caixa de e-mails para a qual a mensagem será movida.
Caixa de e-mails String Sim Caixa de correio onde a mensagem está atualmente.
ID String Sim Essa entrada indica o conjunto de mensagens a serem executadas. Pode consistir em um único ID de mensagem, um intervalo de mensagens especificado por dois números de mensagem separados por ":" (por exemplo, "1:5") e/ou números de mensagem individuais separados por "," (por exemplo, "1:5,7,10").

Para saber como configurar a ação MoveEmails, consulte Exemplos de ação.

Ação SendMailMessages

Parâmetros de entrada da ação SendMailMessages

Nome do parâmetro Tipo de dados Obrigatório Descrição
BCC String Não Lista separada por ponto e vírgula de nomes e endereços de e-mail dos destinatários CC.
Prioridade String Não Prioridade da mensagem de e-mail.
Confidencialidade String Não Sensibilidade da mensagem de e-mail.
Anexo String Sim Lista separada por ponto e vírgula dos nomes dos arquivos de anexo (com caminho, se a leitura for de um arquivo) incluídos na mensagem.
MessageBody String Sim O corpo da mensagem.
AttachmentData String Sim Lista separada por ponto e vírgula dos dados de anexo codificados em base64 incluídos na mensagem. Você ainda precisa especificar o nome do arquivo em "Anexos".
InlineImage String Sim Lista separada por ponto e vírgula dos identificadores de imagem inline (cids) a serem incluídos na mensagem.
DeliveryNotification String Não Endereço de e-mail para enviar uma notificação de entrega.
InlineImageData String Sim Lista separada por ponto e vírgula dos dados de imagem codificados em base64 a serem incluídos na mensagem.
CC String Não A lista de nomes e endereços de e-mail dos destinatários em CC, separada por ponto e vírgula.
InlineImageContent String Não O conteúdo como InputStream a ser enviado.
De String Não O endereço de e-mail do remetente.
Até String Não A lista separada por ponto e vírgula de nomes e endereços de e-mail dos destinatários.
Assunto String Sim O assunto da mensagem de e-mail.
AttachmentContent String Não O conteúdo como InputStream a ser enviado.
Conjunto de caracteres String Não O conjunto de caracteres a ser usado na mensagem.
Recibo de leitura String Não Endereço de e-mail para o qual a confirmação de leitura será enviada.
IsHTML String Não Se o e-mail é HTML ou texto simples.
Importância String Não Importância da mensagem de e-mail.

Por exemplo, sobre como configurar a ação SendMailMessages, consulte Exemplos de ação.

Ação SetLabels

Parâmetros de entrada da ação SetLabels

Nome do parâmetro Tipo de dados Obrigatório Descrição
OperationType String Sim Indica se os rótulos especificados precisam ser adicionados, removidos ou substituídos na lista de rótulos existente.
Caixa de e-mails String Sim A caixa de e-mails do Gmail em que a mensagem está localizada.
ID String Sim Essas entradas indicam o conjunto de mensagens em que a operação será realizada. Pode consistir em um único ID de mensagem, um intervalo de mensagens especificado por dois números de mensagem separados por ':' (por exemplo, "1:5") e/ou números de mensagens separados por "," (por exemplo, "1:5,7,10").
Rótulo String Sim Lista de marcadores a serem definidos para a mensagem especificada pela propriedade MessageSet. Essa entrada precisa ser definida como uma lista de marcadores separados por vírgulas.

Para saber como configurar a ação SetLabels, consulte Exemplos de ação.

Ação SetFlag

Parâmetros de entrada da ação SetFlag

Nome do parâmetro Tipo de dados Obrigatório Descrição
OperationType String Sim Isso indica o clima em que as sinalizações especificadas precisam ser adicionadas,removidas ou substituídas pela lista de sinalizações existentes.
Caixa de correio String Sim A caixa de correio onde a mensagem está localizada.
ID String Sim Essa entrada indica o conjunto de mensagens nas quais operar. Pode consistir em um único ID de mensagem, um intervalo de mensagens especificado por dois números de mensagem separados por ":" (por exemplo, "1:5") e/ou números de mensagem individuais separados por "," (por exemplo, "1:5,7,10").
Sinalizações String Sim Define as flags especificadas para a mensagem especificada pelo conjunto de mensagens. (por exemplo, Visualizado, excluído, rascunho, sinalizado). As sinalizações devem ser especificadas como uma lista separada por vírgulas(por exemplo, vista, excluída, sinalizada).

Por exemplo, sobre como configurar a ação SetFlag, consulte Exemplos de ação.

Exemplos

Exemplos de ação

Exemplo: mover um e-mail

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação MoveEmails e clique em Concluído.
  3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value: 
     {
"Destination": "Inbox",
"Mailbox": "Archive",
"Id": "1"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa MoveEmails terá um valor semelhante a este:

    [{
"Success": "true",
"rss:title": "Message(s) moved successfully."
}]

Exemplo: enviar um e-mail

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação SendMailMessages e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
     {
"MessageBody": "This mail is generated by using action sendmailmessage for outlook server.",
"To": "test97@gmail.com",
"Subject": "Outlook SMTP\n server."
}

    4. Se a ação for bem-sucedida, o SendMailMessages resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

    [{
 "MessageId": "4797386f18288a7441c5317a459b8340e857@outlook.com"
}]

Exemplo: enviar e-mail com anexo

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação SendMailMessages e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
     {
"MessageBody": "This mail is generated by using action sendmailmessage for outlook server.",
"To": "test97@gmail.com",
"Subject": "Outlook SMTP PDF Mail.",
"Attachment": "Testing.pdf",
"AttachmentData": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuz1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FD
...[too long to view on UI. Please download the log to view the full content.]
}

    4. Se a ação for bem-sucedida, o SendMailMessages resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

    [{
"MessageId": "1e96993a6053845c65ee44e6b4153d585e@outlook.com"
}]

Exemplo: definir rótulos

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação SetLabels e clique em Concluído.
  3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value: 
     {
"Labels": "GoogleCloud_Testing",
"OperationType": "ADD",
"Mailbox": "Inbox",
"Id": "1"
}

    4. Se a ação for bem-sucedida, o SetLabels resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

    [{
"Success": "true",
"rss:title": "Message labels set correctly."
}]

Exemplo: set flag

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação SetFlag e clique em Concluído.
  3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value: 
    {
"Mailbox": "Sent",
"Id": "1",
"Flags": "Draft",
"OperationType": "ADD"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa SetFlag terá um valor semelhante a este:

    [{
"Success": "true",
"rss:title": "Message flags set correctly."
}]

Exemplo: definir sinalização para um e-mail específico

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação SetFlag e clique em Concluído.
  3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value: 
    {
"Mailbox": "Sent",
"Id": "1",
"Flags": "Flagged",
"OperationType": "ADD"
}

    4. Se a ação for bem-sucedida, o SetFlag resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

    [{
"Success": "true",
"rss:title": "Message flags set correctly."
}]

Exemplos de operações de entidade

Esta seção mostra como executar algumas das operações de entidade neste conector.

Exemplo: listar todos os e-mails

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Inbox na lista Entity.
  3. Selecione a operação LIST e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, você também pode filtrar o conjunto de resultados especificando uma cláusula de filtro. Especifique o valor da cláusula de filtro sempre entre aspas simples (').

Exemplo: receber um único e-mail

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Inbox na lista Entity.
  3. Selecione a operação GET e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em EntityId e insira 1 no campo Valor padrão.

    Aqui, 1 é um ID de registro exclusivo na entidade Inbox.

Exemplo: excluir um e-mail

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Inbox na lista Entity.
  3. Selecione a operação DELETE e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em entityId e insira 1 no campo Valor padrão.

Usar o Terraform para criar conexões

É possível usar o Terraform recurso para criar uma nova conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Para conferir um exemplo de modelo do Terraform para criação de conexão, consulte Exemplo de modelo.

Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro Tipo de dados Obrigatório Descrição
protocolo STRING Verdadeiro O tipo de servidor de e-mail ao qual se conectar.
proxy_enabled BOOLEAN Falso Marque esta caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme ENUM Falso O tipo de autenticação a ser usado para autenticar no proxy ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user STRING Falso Um nome de usuário a ser usado para autenticar no proxy ProxyServer.
proxy_password SECRET Falso Uma senha a ser usada para autenticação no proxy ProxyServer.
proxy_ssltype ENUM Falso O tipo de SSL a ser usado na conexão com o proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL

Usar a conexão de e-mail em uma integração

Depois de criar a conexão, ela fica disponível na integração da Apigee e na integração do aplicativo. Você pode usar a conexão em uma integração pela tarefa Conectores.

  • Para entender como criar e usar a tarefa Conectores na integração da Apigee, consulte a Tarefa Conectores.
  • Para entender como criar e usar a tarefa Conectores no Application Integration, consulte Tarefa Conectores.

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir