En este documento, se explica cómo crear, actualizar y enviar borradores de correos electrónicos con la API de Gmail.
Los borradores de correos electrónicos representan mensajes no enviados con la etiqueta del sistema DRAFT aplicada.
El mensaje que contiene el borrador no se puede editar una vez que se crea, pero se puede reemplazar. En este sentido, el recurso drafts es un contenedor que proporciona un ID estable porque los IDs de los mensajes subyacentes cambian cada vez que se reemplaza el mensaje.
El recurso messages dentro de un borrador tiene un comportamiento similar al de otros mensajes, excepto por las siguientes diferencias:
- Los mensajes de borrador no pueden tener ninguna etiqueta que no sea la etiqueta del sistema
DRAFT. - Cuando se envía el borrador, se borra automáticamente y se crea un mensaje nuevo con un ID actualizado y la etiqueta del sistema
SENT. Este mensaje se devuelve en la respuesta del métododrafts.send.
Crear borradores
Tu app puede crear borradores con el método drafts.create. Para crear un borrador, sigue estos pasos:
- Crea un mensaje MIME que cumpla con el RFC 2822.
- Convierte el mensaje en una cadena codificada en base64URL.
- Llama al método
drafts.createy establece el valor del campomessages.rawen la cadena codificada.
En los siguientes ejemplos de código, se demuestra el proceso:
Java
Python
cURL
curl --request POST \
'https://gmail.googleapis.com/gmail/v1/users/me/drafts' \
--header 'Authorization: Bearer ACCESS_TOKEN" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"message":{"raw":"MESSAGE"}}'
Reemplaza lo siguiente:
- ACCESS_TOKEN: Es el token de acceso que otorga acceso a la API.
- MESSAGE: Es el mensaje MIME con formato RFC 2822, codificado como base64URL.
Actualizar borradores
Al igual que cuando creas un borrador, para actualizarlo, debes proporcionar un recurso drafts en el cuerpo de la solicitud con el campo messages.raw establecido en una cadena codificada en base64URL que contenga el mensaje MIME. Como los mensajes no se pueden actualizar, el mensaje incluido en el borrador se destruye y se reemplaza por el nuevo mensaje MIME proporcionado en la solicitud de actualización.
Puedes recuperar el mensaje MIME actual que se incluye en el borrador llamando al método drafts.get con el parámetro de consulta format=raw.
Para obtener más información, consulta el método drafts.update.
Enviar borradores
Cuando envíes un borrador, puedes hacerlo tal como está o proporcionar actualizaciones en la solicitud de envío.
Para actualizar el borrador cuando lo envíes, proporciona un recurso drafts en el cuerpo de la solicitud del método drafts.send. En el recurso drafts, debes especificar el id borrador del borrador que se enviará y establecer el campo messages.raw en el nuevo mensaje MIME codificado como una cadena base64URL.
Para obtener información sobre cómo enviar un mensaje de Gmail, consulta Envía mensajes.