Esta página foi traduzida pela API Cloud Translation.

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 o papel do IAM roles/connectors.admin ao usuário que estiver 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:

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"
Clique em + Criar novo para abrir a página Criar conexão.
Na seção Local, escolha o local da conexão.
1. Região: selecione um local na lista suspensa.
  Para acessar a lista de todas as regiões com suporte, consulte Locais.
2. Clique em Próxima.
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 exceder 63 caracteres.
4. (Opcional) Descrição : insira uma descrição para a conexão.
5. (Opcional) Ativar o Cloud Logging:marque essa caixa de seleção para armazenar todos os dados de registro da conexão.
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 detalhes: esse campo determina a quantidade de detalhes que você quer incluir no arquivo de registros. Os valores válidos vão de 1 a 5. Um nível de nível 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:
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.
Na seção Destinos, digite 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.
  - Se você quiser estabelecer uma conexão particular com seus sistemas de back-end, selecione Anexo do endpoint na lista e escolha o anexo de endpoint necessário na lista Anexo do endpoint.
    Observação : para entender como criar um anexo de endpoint, consulte o anexo de serviço do PSC e o anexo de endpoint. Depois que você criar o anexo de endpoint, ele ficará visível na lista Anexo do endpoint.
  Se você quiser 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, em seguida, configure as regras de firewall para colocar na lista de permissões 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 SMTPServer. 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.
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. Clique em Próxima.
Revisão: revise os detalhes de conexão e autenticação.
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:
- List
- Receber
- Criação
- Atualizar
- Excluir
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 for compatível com nenhuma das operações da entidade, essas operações sem suporte não serão incluídas na lista de 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 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 as transações acima desse limite. Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.

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

Observação:o número de nós do Integration Connectors será escalonado automaticamente de maneira dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes sem esperar pelo escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processa menos transações. Para configurar os valores do nó, faça o seguinte:

Se você for um cliente com pagamento por utilização, configure o valor mínimo e máximo do nó na página de edição de conexão.
Se você for um cliente com base em assinatura, entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para melhorar a capacidade, verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

Ações

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

Observação:os resultados de todas as ações estarão disponíveis como uma resposta JSON no parâmetro de resposta connectorOutputPayload da tarefa Connectors depois que você executar a integraçã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	A caixa de e-mails em que a mensagem está localizada no momento.
ID	String	Sim	Essa entrada indica o conjunto de mensagens nas quais operar. Ela 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 individuais separados por "," (por exemplo, "1:5,7,10").

Para ver como configurar a ação MoveEmails, consulte os 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	No	A lista, separada por ponto e vírgula, de nomes e endereços de e-mail dos destinatários em cópia oculta.
Prioridade	String	No	Prioridade da mensagem de e-mail.
Sensibilidade	String	No	Sensibilidade da mensagem de e-mail.
Anexo	String	Sim	Lista separada por ponto-e-vírgula dos nomes dos arquivos anexados (com caminho, se for a leitura de um arquivo) incluída 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 deve 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	No	Endereço de e-mail para onde 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	No	A lista separada por ponto e vírgula de nomes e endereços de e-mail dos destinatários em cópia.
InlineImageContent	String	No	O conteúdo como InputStream a ser enviado.
De	String	No	O endereço de e-mail do remetente.
Para	String	No	A lista separada por ponto e vírgula de nomes e endereços de e-mail dos destinatários.
Matéria	String	Sim	O assunto da mensagem de e-mail.
AttachmentContent	String	No	O conteúdo como InputStream a ser enviado.
Charset	String	No	O conjunto de caracteres que será usado na mensagem.
ReadReceipt	String	No	Endereço de e-mail para o qual a confirmação de leitura será enviada.
IsHTML	String	No	Se o e-mail é HTML ou texto simples.
Importância	String	No	Importância da mensagem de e-mail.

Para ver como configurar a ação SendMailMessages, consulte os Exemplos de ação.

Ação SetMarcadores

Parâmetros de entrada da ação SetLabels

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
OperationType	String	Sim	Isso indica o clima em que os rótulos especificados precisam ser adicionados,removidos ou substituir a 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	Essa entrada indica o conjunto de mensagens nas quais operar. Ela 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 individuais 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 rótulos separada 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 e-mails	String	Sim	A caixa de correio em que a mensagem está localizada.
ID	String	Sim	Essa entrada indica o conjunto de mensagens nas quais operar. Ela 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 individuais separados por "," (por exemplo, "1:5,7,10").
Sinalizações	String	Sim	Define as sinalizações especificadas para a mensagem especificada pelo conjunto de mensagens. (por exemplo, visto, excluído, rascunho,sinalizado). As sinalizações devem ser especificadas como uma lista separada por vírgulas(por exemplo, vista, excluída, sinalizada).

Para ver como configurar a ação SetFlag, consulte os Exemplos de ação.

Examples

Exemplos de ação

Exemplo: mover um e-mail

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

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

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

Exemplo: enviar um e-mail

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação SendMailMessages e clique em Concluído.

Na seção Task Input 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."
}

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa SendMailMessages terá um valor semelhante ao seguinte:

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

Exemplo: enviar e-mail com anexo

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação SendMailMessages e clique em Concluído.

Na seção Task Input 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.]
}

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa SendMailMessages terá um valor semelhante ao seguinte:

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

Exemplo: definir rótulos

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

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa SetLabels terá um valor semelhante ao seguinte:

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

Exemplo: set flag

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

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

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

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

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

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa SetFlag 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

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Inbox na lista Entity.
Selecione a operação LIST e clique em Concluído.
Opcionalmente, na seção Entrada de tarefa da tarefa Conectores, é possível 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

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Inbox na lista Entity.
Selecione a operação GET e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em IdEntidade e insira 1 no campo Valor padrão.
Aqui, 1 é um ID de registro exclusivo na entidade Inbox.

Exemplo: excluir um e-mail

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

Usar o Terraform para criar conexões

É possível usar o recurso do Terraform 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 a criação de conexões, 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 o proxy do ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de usuário a ser usado para autenticar o proxy do 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 que você cria a conexão, ela fica disponível na Apigee Integration e no Application Integration. É possível usar a conexão em uma integração por meio da 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

Entenda como suspender e retomar uma conexão.
Entenda como monitorar o uso do conector.
Saiba como acessar os registros do conector.