Correo electrónico

El conector de correo electrónico te permite realizar operaciones de inserción, eliminación, actualización y lectura en la base de datos de IMAP.

Antes de comenzar

Antes de usar el conector de correo electrónico, realiza las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Asegúrate de que la conectividad de red esté configurada. Para obtener información sobre los patrones de red, consulta Conectividad de red.
    • Otorga el rol de IAM roles/connectors.admin al usuario que configure el conector.
    • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

    • Habilita los siguientes servicios:
      • secretmanager.googleapis.com (API de Secret Manager)
      • connectors.googleapis.com (API de conectores)

      Para comprender cómo habilitar servicios, consulta Habilita servicios.

    Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

    Ir a la página Conexiones

  2. Haz clic en + Crear nuevo para abrir la página Crear conexión.
  3. En la sección Ubicación, elige la ubicación para la conexión.
    1. Región: selecciona una ubicación de la lista desplegable.

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

    2. Haz clic en Siguiente.
  4. En la sección Detalles de la conexión, completa lo siguiente:
    1. Conector: Selecciona Correo electrónico en la lista desplegable de conectores disponibles.
    2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
    3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 49 caracteres.
    4. Descripción: Ingresa una descripción para la conexión (opcional).
    5. De manera opcional, habilita Cloud Logging y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en Error.
    6. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
    7. Protocolo: Es el tipo de servidor de correo electrónico al que te conectarás. Los valores válidos son IMAP y POP.
    8. Nivel de verbosidad: Este campo determina la cantidad de detalles que deseas incluir en el archivo de registro. Los valores válidos varían de 1 a 5. Un nivel de verbosidad más alto registra todos los detalles de la comunicación, incluidos la solicitud, la respuesta y los certificados SSL.
    9. De manera opcional, configura los parámetros de nodo de conexión:

      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

    10. Usar proxy: selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión y configurar los siguientes valores:
      • Esquema de autenticación del proxy: Selecciona el tipo de autenticación para autenticar con el servidor proxy. Se admiten los siguientes tipos de autenticación:
        • Básico: Autenticación HTTP básica.
        • Resumen: Autenticación de HTTP de resumen.
      • Usuario de proxy: Un nombre de usuario que se usará para autenticarse con el servidor proxy.
      • Contraseña de proxy: el secreto de Secret Manager de la contraseña del usuario.
      • Tipo de SSL del proxy: el tipo de SSL que se usará para conectarse al servidor del proxy. Se admiten los siguientes tipos de autenticación:
        • Automático: Configuración predeterminada. Si la URL es HTTPS, se usa la opción Túnel. Si la URL es una URL HTTP, se usa la opción NUNCA.
        • Siempre: La conexión siempre está habilitada para SSL.
        • Nunca: La conexión no está habilitada para SSL.
        • Túnel: La conexión se realiza a través de un proxy de túnel. El servidor proxy abre una conexión con el host remoto y el tráfico fluye de un lado a otro a través del proxy.
      • En la sección Proxy Server, ingresa los detalles del servidor proxy.
        1. Haz clic en Agregar destino.
        2. Selecciona un Tipo de destino.
          • Dirección del host: Especifica el nombre de host o la dirección IP del destino.

            Si deseas establecer una conexión privada a tu sistema de backend, haz lo siguiente:

    11. De forma opcional, haz clic en + Agregar etiqueta para agregar una etiqueta a la conexión en forma de un par clave-valor.
    12. Haz clic en Siguiente.
  5. En la sección Destinos, ingresa los detalles del nombre o la dirección del servidor de correo al que deseas conectarte. El servidor admite los protocolos IMAP o POP.
    1. Tipo de destino: Selecciona un Tipo de destino. Por ejemplo, ingresa la dirección del host y el número de puerto. Por ejemplo, la dirección del host es outlook.office365.com y el puerto es 993.
      • Selecciona Dirección de host en la lista para especificar el nombre de host o la dirección IP del destino.
      • Si deseas establecer una conexión privada a tus sistemas de backend, selecciona Adjunto de extremo en la lista y, luego, selecciona el archivo adjunto de extremo requerido en la lista Adjunto de extremo.

      Si deseas establecer una conexión pública a tus sistemas de backend con seguridad adicional, puedes configurar direcciones IP salientes estáticas para tus conexiones y, luego, configurar tus reglas de firewall para incluir en la lista de entidades permitidas solo las direcciones IP estáticas específicas.

    2. Si quieres enviar correos electrónicos, haz clic en +Agregar destino para agregar los detalles del servidor SMTP en la sección SMTPServer. Luego, sigue estos pasos:
      • Ingresa la dirección del host y el número de puerto. Por ejemplo, la dirección del host es smtp-mail.outlook.com y el puerto es 587.
    3. Haz clic en Siguiente.
  6. En la sección Autenticación, ingresa los detalles de autenticación.
    1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

      La conexión de correo electrónico admite los siguientes tipos de autenticación:

      • Nombre de usuario y contraseña

      2. Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

    2. Haz clic en Siguiente.
  7. Revisa: Revisa tus detalles de conexión y autenticación.
  8. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

  • Nombre de usuario y contraseña
    • Nombre de usuario: El usuario de la cuenta de correo electrónico que se usa para la autenticación.
    • Contraseña: El Secret de Secret Manager que contiene la contraseña de la cuenta de correo electrónico que se usa para la autenticación.

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

  • Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

    Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

  • Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:

    Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, estas operaciones no compatibles no se incluyen en la lista Operations.

  • Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Por lo general, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Limitaciones del sistema

El conector de correo electrónico puede procesar 1 transacción por segundo por nodo y regula las transacciones que superen este límite. De forma predeterminada, los conectores de integración asignan 2 nodos (para una mejor disponibilidad) a una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Acciones

En esta sección, se enumeran las acciones que admite el conector. Para comprender cómo configurar las acciones, consulta Ejemplos de acciones.

Acción MoveEmails

Parámetros de entrada de la acción MoveEmails

Nombre del parámetro Tipo de datos Obligatorio Descripción
Descripción String Sí Es el buzón al que se moverá el mensaje.
Buzón String Sí Es el buzón en el que se encuentra el mensaje actualmente.
ID String Sí Estas entradas indican el conjunto de mensajes en el que se debe operar. Puede consistir en un solo ID de mensaje, un rango de mensajes especificado por dos números de mensaje separados por ':' (p.ej., '1:5') o números de mensaje individuales separados por ',' (p.ej., '1:5,7,10').

Para ver ejemplos sobre cómo configurar la acción MoveEmails, consulta Ejemplos de acciones.

Acción SendMailMessages

Parámetros de entrada de la acción SendMailMessages

Nombre del parámetro Tipo de datos Obligatorio Descripción
Cco String No Es la lista de nombres y direcciones de correo electrónico de los destinatarios Cc separados por punto y coma.
Prioridad String No Es la prioridad del mensaje de correo electrónico.
Sensibilidad String No Sensibilidad del mensaje de correo electrónico.
Adjunto String Sí Es una lista de los nombres de los archivos adjuntos (con la ruta de acceso si se lee desde un archivo) separados por punto y coma que se incluyen en el mensaje.
MessageBody String Sí El cuerpo del mensaje.
AttachmentData String Sí Es una lista separada por punto y coma de los datos del archivo adjunto codificados en base64 que se incluyen en el mensaje. (Aún debes especificar el nombre del archivo en Adjuntos.
InlineImage String Sí Es una lista de los identificadores de imágenes intercaladas (cids) separados por punto y coma que se incluirán en el mensaje.
DeliveryNotification String No Es la dirección de correo electrónico a la que se enviará una notificación de entrega.
InlineImageData String Sí Es una lista separada por punto y coma de los datos de imagen codificados en base 64 que se incluirán en el mensaje.
CC String No Es la lista de nombres y direcciones de correo electrónico de los destinatarios Cc separados por punto y coma.
InlineImageContent String No El contenido como InputStream que se subirá.
De String No La dirección de correo electrónico del remitente.
A String No Es la lista de nombres y direcciones de correo electrónico de los destinatarios, separados por punto y coma.
Asunto String Sí Es el asunto del mensaje de correo electrónico.
AttachmentContent String No El contenido como InputStream que se subirá.
Charset String No Es el conjunto de caracteres que se usará en el mensaje.
ReadReceipt String No Es la dirección de correo electrónico a la que se enviará la confirmación de lectura.
IsHTML String No Si el correo electrónico es HTML o texto sin formato.
Importancia String No Importancia del mensaje de correo electrónico.

Para ver ejemplos sobre cómo configurar la acción SendMailMessages, consulta Ejemplos de acciones.

Acción SetLabels

Parámetros de entrada de la acción SetLabels

Nombre del parámetro Tipo de datos Obligatorio Descripción
OperationType String Sí Indica si se deben agregar,quitar o reemplazar las etiquetas especificadas en la lista de etiquetas existente.
Buzón String Sí El buzón de Gmail en el que se encuentra el mensaje.
ID String Sí Estas entradas indican el conjunto de mensajes en el que se debe operar. Puede consistir en un solo ID de mensaje, un rango de mensajes especificado por dos números de mensaje separados por ':' (p.ej., '1:5') o números de mensaje individuales separados por ',' (p.ej., '1:5,7,10').
Etiqueta String Sí Es la lista de etiquetas que se establecerán en el mensaje especificado por la propiedad MessageSet. Esta entrada debe establecerse como una lista de etiquetas separadas por comas.

Para ver ejemplos sobre cómo configurar la acción SetLabels, consulta Ejemplos de acciones.

Acción SetFlag

Parámetros de entrada de la acción SetFlag

Nombre del parámetro Tipo de datos Obligatorio Descripción
OperationType String Sí Indica si se deben agregar,quitar o reemplazar las marcas especificadas en la lista de marcas existente.
Buzón String Sí Es el buzón en el que se encuentra el mensaje.
ID String Sí Estas entradas indican el conjunto de mensajes en el que se debe operar. Puede consistir en un solo ID de mensaje, un rango de mensajes especificado por dos números de mensaje separados por ':' (p.ej., '1:5') o números de mensaje individuales separados por ',' (p.ej., '1:5,7,10').
Marcas String Sí Establece las marcas especificadas en el mensaje especificado por el conjunto de mensajes. (p. ej., Visto, borrado, borrador,marcado). Las marcas se deben especificar como una lista separada por comas(p. ej., Visto, Borrado, Con marca).

Para ver ejemplos sobre cómo configurar la acción SetFlag, consulta Ejemplos de acciones.

Ejemplos

Ejemplos de acciones

Ejemplo: Cómo mover un correo electrónico

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción MoveEmails y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
     {
"Destination": "Inbox",
"Mailbox": "Archive",
"Id": "1"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea MoveEmails tendrá un valor similar al siguiente:

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

Ejemplo: Envía un correo electrónico

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción SendMailMessages y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el 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. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea SendMailMessages tendrá un valor similar al siguiente:

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

Ejemplo: Envía un correo electrónico con un archivo adjunto

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción SendMailMessages y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el 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. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea SendMailMessages tendrá un valor similar al siguiente:

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

Ejemplo: Cómo configurar etiquetas

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción SetLabels y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
     {
"Labels": "GoogleCloud_Testing",
"OperationType": "ADD",
"Mailbox": "Inbox",
"Id": "1"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea SetLabels tendrá un valor similar al siguiente:

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

Ejemplo: Cómo establecer una marca

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción SetFlag y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"Mailbox": "Sent",
"Id": "1",
"Flags": "Draft",
"OperationType": "ADD"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea SetFlag tendrá un valor similar al siguiente:

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

Ejemplo: Cómo establecer una marca en un correo electrónico en particular

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción SetFlag y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"Mailbox": "Sent",
"Id": "1",
"Flags": "Flagged",
"OperationType": "ADD"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea SetFlag tendrá un valor similar al siguiente:

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

Ejemplos de operaciones de entidades

En esta sección, se muestra cómo realizar algunas de las operaciones de la entidad en este conector.

Ejemplo: Muestra una lista de todos los correos electrónicos

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Inbox en la lista Entity.
  3. Selecciona la operación LIST y haz clic en Listo.
  4. De forma opcional, en la sección Task Input de la tarea Connectors, puedes filtrar tu conjunto de resultados especificando una cláusula de filtro. Especifica el valor de la cláusula de filtro siempre entre comillas simples (').

Ejemplo: Cómo obtener un solo correo electrónico

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Inbox en la lista Entity.
  3. Selecciona la operación GET y haz clic en Listo.
  4. En la sección Task Input de la tarea Connectors, haz clic en EntityId y, luego, ingresa 1 en el campo Default Value.

    Aquí, 1 es un ID de registro único en la entidad Inbox.

Ejemplo: Cómo borrar un correo electrónico

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Inbox en la lista Entity.
  3. Selecciona la operación DELETE y haz clic en Listo.
  4. En la sección Task Input de la tarea Connectors, haz clic en entityId y, luego, ingresa 1 en el campo Default Value.

Usa Terraform para crear conexiones

Puedes usar el recurso de Terraform para crear una conexión nueva.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

Para ver una plantilla de Terraform de ejemplo para la creación de conexiones, consulta la plantilla de ejemplo.

Cuando crees esta conexión con Terraform, debes establecer las siguientes variables en tu archivo de configuración de Terraform:

Nombre del parámetro Tipo de datos Obligatorio Descripción
protocol STRING Verdadero Es el tipo de servidor de correo electrónico al que te conectarás.
proxy_enabled BOOLEAN Falso Selecciona esta casilla de verificación para configurar un servidor proxy para la conexión.
proxy_auth_scheme ENUM Falso Es el tipo de autenticación que se usará para autenticarse en el proxy de ProxyServer. Los valores admitidos son: BASIC, DIGEST, NONE
proxy_user STRING Falso Es un nombre de usuario que se usará para autenticarse en el proxy de ProxyServer.
proxy_password SECRET Falso Es una contraseña que se usará para autenticarse en el proxy de ProxyServer.
proxy_ssltype ENUM Falso Es el tipo de SSL que se usará para conectarse al proxy de ProxyServer. Los valores admitidos son: AUTO, ALWAYS, NEVER, TUNNEL

Usa la conexión de correo electrónico en una integración

Después de crear la conexión, estará disponible en la integración de Apigee y en la integración de aplicaciones. Puedes usar la conexión en una integración a través de la tarea Connectors.

  • Para comprender cómo crear y usar la tarea Connectors en la integración de Apigee, consulta Tarea Connectors.
  • Para comprender cómo crear y usar la tarea Connectors en Application Integration, consulta Tarea Connectors.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?