Esta página foi traduzida pela API Cloud Translation.

Email

O conetor de email permite-lhe realizar operações de inserção, eliminação, atualização e leitura na base de dados IMAP.

Antes de começar

Antes de usar o conector de email, conclua as seguintes tarefas:

No seu projeto do Google Cloud:
- Certifique-se de que a conetividade de rede está configurada. Para obter informações sobre padrões de rede, consulte o artigo Conetividade de rede.
- Conceda a função IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
- Conceda as seguintes funções de IAM à conta de serviço que quer usar para o conector:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  Uma conta de serviço é um tipo especial de Conta Google destinada a representar um utilizador não humano que precisa de autenticação e autorização para aceder a dados nas APIs Google. Se não tiver uma conta de serviço, tem de criar uma. O conector e a conta de serviço têm de pertencer ao mesmo projeto. Para mais informações, consulte Criar uma conta de serviço.
- Ative os seguintes serviços:
  - secretmanager.googleapis.com (Secret Manager API)
  - connectors.googleapis.com (API Connectors)
  Para saber como ativar serviços, consulte o artigo Ativar serviços.
Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

Configure o conetor

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.
Aceda à página Ligações
Clique em + Criar novo para abrir a página Criar associação.
Na secção Localização, escolha a localização para a ligação.
1. Região: selecione uma localização na lista pendente.
  Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.
2. Clicar em Seguinte.
Na secção Detalhes da associação, conclua o seguinte:
1. Conetor: selecione Email na lista pendente de conetores disponíveis.
2. Versão do conetor: selecione a versão do conetor na lista pendente de versões disponíveis.
3. No campo Nome da ligação, introduza um nome para a instância de ligação.
  Os nomes das associações têm de cumprir os seguintes critérios:
  - Os nomes das associações podem usar letras, números ou hífenes.
  - As letras têm de ser minúsculas.
  - Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
  - Os nomes das associações não podem exceder 49 carateres.
4. (Opcional) Descrição: introduza uma descrição para a associação.
5. Opcionalmente, ative o Registo na nuvem e, em seguida, selecione um nível de registo. Por predefinição, o nível do registo está definido como Error.
6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
7. Protocolo: o tipo de servidor de email ao qual estabelecer ligação. Os valores válidos são IMAP e POP.
8. Nível de detalhe: este campo determina a quantidade de detalhes que quer incluir no ficheiro de registo. Os valores válidos variam entre 1 e 5. Um nível de detalhe mais elevado regista todos os detalhes de comunicação, incluindo o pedido, a resposta e os certificados SSL.
9. Opcionalmente, configure as definições do nó de associação:
  - Número mínimo de nós: introduza o número mínimo de nós de ligação.
  - Número máximo de nós: introduza o número máximo de nós de ligação.
  Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.
10. (Opcional) Na secção Definições avançadas, selecione a caixa de verificação Usar proxy para configurar um servidor proxy para a ligação e configurar os seguintes valores:
11. Opcionalmente, clique em + Adicionar etiqueta para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
12. Clicar em Seguinte.
Na secção Destinos, introduza os detalhes do nome ou do endereço do servidor de correio ao qual quer estabelecer ligação. O servidor suporta os protocolos IMAP ou POP.
1. Tipo de destino: selecione um Tipo de destino. Por exemplo, introduza o endereço do anfitrião e o número da porta. Por exemplo, o endereço do anfitrião é outlook.office365.com e a porta é 993.
  - Para especificar o nome de anfitrião ou o endereço IP de destino, selecione Endereço do anfitrião e introduza o endereço no campo Anfitrião 1.
  - Para estabelecer uma ligação privada, selecione Anexo do ponto final e escolha o anexo necessário na lista Anexo do ponto final.
    Nota: para saber como criar uma associação de ponto final, consulte Associação de serviço do PSC e Associação de ponto final. Depois de criar a associação do ponto final, esta fica visível na lista Associação do ponto final.
  Se quiser estabelecer uma ligação pública aos seus sistemas de back-end com segurança adicional, pode considerar configurar endereços IP estáticos de saída para as suas ligações e, em seguida, configurar as regras da firewall para permitir apenas os endereços IP estáticos específicos.
2. Se quiser enviar emails, adicione os detalhes do servidor SMTP na secção SMTPServer clicando em +Adicionar destino. Em seguida, faça o seguinte:
  - Introduza o endereço do anfitrião e o número da porta. Por exemplo, o endereço do anfitrião é smtp-mail.outlook.com e a porta é 587.
3. Clicar em Seguinte.
Na secção Autenticação, introduza os detalhes de autenticação.
1. Selecione um Tipo de autenticação e introduza os detalhes relevantes.
  Os seguintes tipos de autenticação são suportados pela ligação por email:
  - Nome de utilizador e palavra-passe
2. Clicar em Seguinte.
Rever: reveja os detalhes da ligação e da autenticação.
Clique em Criar.

Configure a autenticação

Introduza os detalhes com base na autenticação que quer usar.

Nome de utilizador e palavra-passe
- Nome de utilizador: o utilizador da conta de email usada para autenticar.
- Palavra-passe: Secret do Secret Manager que contém a palavra-passe da conta de email usada para autenticação.

Entidades, operações e ações

Todos os conetores de integração oferecem uma camada de abstração para os objetos da aplicação ligada. Só pode aceder aos objetos de uma aplicação através desta abstração. A abstração é exposta como entidades, operações e ações.

Entidade: pode considerar uma entidade como um objeto ou uma coleção de propriedades na aplicação ou no serviço associado. A definição de uma entidade difere de um conetor para um conetor. Por exemplo, num conetor de base de dados, as tabelas são as entidades. Num conetor de servidor de ficheiros, as pastas são as entidades. Num conetor de sistema de mensagens, as filas são as entidades.
No entanto, é possível que um conector não suporte ou não tenha entidades, caso em que a lista Entities estará vazia.
Operação: uma operação é a atividade que pode realizar numa entidade. Pode realizar qualquer uma das seguintes operações numa entidade:
- Lista
- Obter
- Criar
- Atualizar
- Eliminar
Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para a entidade. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa de conectores. No entanto, se um conector não suportar nenhuma das operações de entidades, essas operações não suportadas não são apresentadas na lista Operations.
Ação: uma ação é uma função de primeira classe que é disponibilizada à integração através da interface do conetor. Uma ação permite-lhe fazer alterações a uma ou mais entidades e varia de conetor para conetor. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. No entanto, é possível que um conector não suporte nenhuma ação, caso em que a lista Actions está vazia.

Limitações do sistema

O conector de email pode processar 1 transação por segundo, por nó, e limita todas as transações que excedam este limite. Por predefinição, os Integration Connectors atribuem 2 nós (para uma melhor disponibilidade) a uma ligação.

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

Nota: o número de nós de conectores de integração é dimensionado automaticamente de forma dinâmica com base na sua utilização. No entanto, se quiser reservar capacidade para grandes volumes sem esperar pela escalabilidade automática, pode ajustar o valor mínimo de nós para uma ligação. São necessários mais nós para processar mais transações para uma associação. Por outro lado, são necessários menos nós se uma associação processar menos transações. Para configurar os valores dos nós, faça o seguinte:

Se for cliente de pagamento conforme o uso, configure o valor mínimo e máximo do nó na página de edição da associação.
Se for cliente com base numa subscrição, contacte o apoio técnico.

O número máximo de transações que um nó pode processar depende de vários fatores. Assim, antes de ajustar os nós mínimos para um melhor débito, é recomendável verificar se os seus sistemas de back-end estão configurados de forma ideal para processar o tráfego necessário.

Ações

Esta secção apresenta as ações suportadas pelo conetor. Para compreender como configurar as ações, consulte os exemplos de ações.

Nota: os resultados de todas as ações vão estar disponíveis como uma resposta JSON no parâmetro de resposta da tarefa Connectors connectorOutputPayload após executar a integração.

Ação MoveEmails

Introduza os parâmetros da ação MoveEmails

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
Descrição	String	Sim	A caixa de correio para onde a mensagem vai ser movida.
Caixa de correio	String	Sim	A caixa de correio onde a mensagem se encontra atualmente.
ID	String	Sim	Estas entradas indicam o conjunto de mensagens sobre o qual operar. Pode consistir num único ID de mensagem, num intervalo de mensagens especificado por dois números de mensagens separados por ":" (por exemplo, "1:5") e/ou números de mensagens individuais separados por "," (por exemplo, "1:5,7,10").

Por exemplo, para saber como configurar a ação MoveEmails, consulte os exemplos de ações.

Ação SendMailMessages

Parâmetros de entrada da ação SendMailMessages

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
BCC	String	Não	A lista de nomes e endereços de email dos destinatários em CCO separados por ponto e vírgula.
Prioridade	String	Não	Prioridade da mensagem de correio.
Sensibilidade	String	Não	Sensibilidade da mensagem de email.
Anexo	String	Sim	Lista de nomes de ficheiros anexados (com caminho se estiver a ler a partir de um ficheiro) incluídos na mensagem, separados por ponto e vírgula.
MessageBody	String	Sim	O corpo da mensagem.
AttachmentData	String	Sim	Lista separada por ponto e vírgula dos dados de anexos codificados em base-64 incluídos na mensagem. (Tem de especificar o nome do ficheiro em Anexos.
InlineImage	String	Sim	Lista separada por ponto e vírgula dos identificadores de imagens inline (cids) a incluir na mensagem.
DeliveryNotification	String	Não	Endereço de email para o qual enviar uma notificação de entrega.
InlineImageData	String	Sim	Lista separada por ponto e vírgula dos dados de imagem codificados em base-64 a incluir na mensagem.
CC	String	Não	A lista de nomes e endereços de email dos destinatários em CC, separados por ponto e vírgula.
InlineImageContent	String	Não	O conteúdo como InputStream a carregar.
De	String	Não	O endereço de email do remetente.
Para	String	Não	A lista de nomes e endereços de email dos destinatários separados por ponto e vírgula.
Assunto	String	Sim	O assunto da mensagem de correio.
AttachmentContent	String	Não	O conteúdo como InputStream a carregar.
Conjunto de carateres	String	Não	O conjunto de carateres a usar na mensagem.
ReadReceipt	String	Não	Endereço de email para o qual enviar um recibo de leitura.
IsHTML	String	Não	Se o email é HTML ou texto simples.
Importância	String	Não	Importância da mensagem de email.

Por exemplo, para saber como configurar a ação SendMailMessages, consulte os exemplos de ações.

Ação SetLabels

Parâmetros de entrada da ação SetLabels

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
OperationType	String	Sim	Isto indica se as etiquetas especificadas devem ser adicionadas,removidas ou substituir a lista de etiquetas existente.
Caixa de correio	String	Sim	A caixa de correio do Gmail onde a mensagem se encontra.
ID	String	Sim	Estas entradas indicam o conjunto de mensagens sobre o qual operar. Pode consistir num único ID de mensagem, num intervalo de mensagens especificado por dois números de mensagens separados por ":" (por exemplo, "1:5") e/ou números de mensagens individuais separados por "," (por exemplo, "1:5,7,10").
Etiqueta	String	Sim	Lista de etiquetas a definir para a mensagem especificada pela propriedade MessageSet. Esta entrada deve ser definida como uma lista de etiquetas separadas por vírgulas.

Por exemplo, para saber como configurar a ação SetLabels, consulte os exemplos de ações.

Ação SetFlag

Parâmetros de entrada da ação SetFlag

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
OperationType	String	Sim	Isto indica se as flags especificadas devem ser adicionadas,removidas ou substituir a lista de flags existente.
Caixa de correio	String	Sim	A caixa de correio onde a mensagem se encontra.
ID	String	Sim	Estas entradas indicam o conjunto de mensagens sobre o qual operar. Pode consistir num único ID de mensagem, num intervalo de mensagens especificado por dois números de mensagens separados por ":" (por exemplo, "1:5") e/ou números de mensagens individuais separados por "," (por exemplo, "1:5,7,10").
Bandeiras	String	Sim	Define as flags especificadas para a mensagem especificada pelo conjunto de mensagens. (Por exemplo, Visto, eliminado, rascunho,denunciado). As flags devem ser especificadas como uma lista separada por vírgulas(por exemplo, Seen,Deleted,flagged)

Por exemplo, para saber como configurar a ação SetFlag, consulte os exemplos de ações.

Exemplos

Exemplos de ações

Exemplo: mova um email

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação MoveEmails e, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa terá um valor semelhante ao seguinte:MoveEmailsconnectorOutputPayload

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

Exemplo: enviar um email

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

Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa terá um valor semelhante ao seguinte:SendMailMessagesconnectorOutputPayload

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

Exemplo: enviar email com anexo

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

Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa terá um valor semelhante ao seguinte:SendMailMessagesconnectorOutputPayload

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

Exemplo: definir etiquetas

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação SetLabels e, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa terá um valor semelhante ao seguinte:SetLabelsconnectorOutputPayload

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

Exemplo: definir sinalização

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação SetFlag e, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa terá um valor semelhante ao seguinte:SetFlagconnectorOutputPayload

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

Exemplo: definir um sinalizador para um determinado email

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação SetFlag e, de seguida, clique em Concluído.
Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa terá um valor semelhante ao seguinte:SetFlagconnectorOutputPayload

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

Exemplos de operações de entidades

Esta secção mostra como realizar algumas das operações de entidades neste conector.

Exemplo: liste todos os emails

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Inbox na lista Entity.
Selecione a operação LIST e, de seguida, clique em Concluído.
Opcionalmente, na secção Entrada de tarefas da tarefa Conetores, pode filtrar o conjunto de resultados especificando uma cláusula de filtro. Especifique sempre o valor da cláusula de filtro entre aspas simples (').

Exemplo: receba um único email

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Inbox na lista Entity.
Selecione a operação GET e, de seguida, clique em Concluído.
Na secção Entrada de tarefas da tarefa Conectores, clique em EntityId e, de seguida, introduza 1 no campo Valor predefinido.
Aqui, 1 é um ID de registo exclusivo na entidade Inbox.

Exemplo: elimine um email

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Inbox na lista Entity.
Selecione a operação DELETE e, de seguida, clique em Concluído.
Na secção Entrada de tarefas da tarefa Conetores, clique em entityId e, de seguida, introduza 1 no campo Valor predefinido.

Crie ligações com o Terraform

Pode usar o recurso do Terraform para criar uma nova associação.

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

Para ver um modelo do Terraform de exemplo para a criação de ligações, consulte o modelo de exemplo.

Quando criar esta associação através do Terraform, tem de definir as seguintes variáveis no ficheiro de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
protocolo	STRING	True	O tipo de servidor de email ao qual estabelecer ligação.
proxy_enabled	BOOLEAN	Falso	Selecione esta caixa de verificação para configurar um servidor proxy para a ligação.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a usar para autenticar no proxy ProxyServer. Os valores suportados são: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de utilizador a ser usado para autenticar no proxy ProxyServer.
proxy_password	SECRET	Falso	Uma palavra-passe a usar para autenticar no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a usar quando se liga ao proxy ProxyServer. Os valores suportados são: AUTO, ALWAYS, NEVER, TUNNEL

Use a ligação de email numa integração

Depois de criar a ligação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

O que se segue?

Compreenda como suspender e retomar uma associação.
Compreenda como monitorizar a utilização do conector.
Compreenda como ver os registos do conetor.