En este documento, se describen las diferencias clave entre la API de Configuración de correo electrónico y la API de Gmail. Puedes usar esta guía para migrar tu app a la API de Gmail.
Autoriza solicitudes
Al igual que la API de Configuración de correo electrónico, la API de Gmail usa el protocolo OAuth 2.0 para autorizar las solicitudes. Una diferencia clave es que los permisos de la API de Gmail se limitan a un usuario individual, en lugar de a todo el dominio. Esto significa que autorizar una cuenta de administrador de dominio no te permite migrar el correo de otros usuarios del dominio. En su lugar, debes usar cuentas de servicio estándar con autoridad para todo el dominio que estén incluidas en la lista blanca de la Consola del administrador para generar el token de autenticación adecuado.
La API de Email Settings usó el siguiente permiso:
https://apps-apis.google.com/a/feeds/emailsettings/2.0/
Los permisos equivalentes en la API de Gmail son los siguientes:
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing
Cambios de protocolo
La API de Email Settings usa el protocolo GDATA basado en XML. La API de Gmail usa JSON. Dado que la configuración se compone principalmente de pares clave-valor, las cargas útiles son conceptualmente similares entre las versiones.
Ejemplo de cómo crear una etiqueta:
API de configuración de correo electrónico
POST https://apps-apis.google.com/a/feeds/emailsettings/2.0/{domain name}/{username}/label
<?xml version="1.0" encoding="utf-8"?>
<atom:entry xmlns:atom="http://www.w3.org/2005/Atom" xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name="label" value="status updates" />
</atom:entry>
API de Gmail
POST https://www.googleapis.com/gmail/v1/users/{username}/labels
{
"name": "status updates"
}
Usa las bibliotecas cliente proporcionadas en lugar de implementar el protocolo directamente.
Administra etiquetas
Para administrar etiquetas en la API de Gmail, usa el recurso Labels.
| Configuración anterior | Configuración nueva | Notas |
|---|---|---|
| labelId | id | |
| etiqueta | nombre | |
| unreadCount | messagesUnread | |
| visibilidad | labelListVisibility | SHOW ahora es labelShowHIDE ahora es labelHide |
Otros cambios:
- Cuando se actualizan o borran etiquetas, la API de Gmail hace referencia a las etiquetas por ID en lugar de por nombre.
Administrar filtros
Para administrar los filtros en la API de Gmail, usa el recurso Filters.
| Configuración anterior | Configuración nueva | Notas |
|---|---|---|
| de | criteria.from | |
| to | criteria.to | |
| asunto | criteria.subject | |
| hasTheWord | criteria.query | |
| doesNotHaveTheWord | criteria.negatedQuery | |
| hasAttachment | criteria.hasAttachment | |
| shouldArchive | action.removeLabelIds | Usa INBOX como el ID de la etiqueta |
| shouldMarkAsRead | action.removeLabelIds | Usa UNREAD como el ID de la etiqueta |
| shouldStar | action.addLabelIds | Usa STARRED como el ID de la etiqueta |
| etiqueta | action.addLabelIds | Usa el ID de la etiqueta para agregar |
| forwardTo | action.forward | |
| shouldTrash | action.addLabelIds | Usa TRASH como el ID de la etiqueta |
| neverSpam | action.removeLabelIds | Usa SPAM como el ID de la etiqueta |
Otros cambios:
- Si aún no existe una etiqueta de usuario, se debe crear de forma explícita con el método labels.create.
Administrar alias de reenvío
Para administrar los alias de envío en la API de Gmail, usa el recurso SendAs.
| Configuración anterior | Configuración nueva |
|---|---|
| nombre | displayName |
| dirección | sendAsEmail |
| replyTo | replyToAddress |
| makeDefault | isDefault |
Cómo administrar los clips web
La configuración de los clips web ya no está disponible a través de la API.
Cómo administrar la configuración de reenvío automático
Para administrar el reenvío automático en la API de Gmail, usa el recurso Settings.
| Configuración anterior | Configuración nueva | Notas |
|---|---|---|
| habilitar | habilitado | |
| forwardTo | emailAddress | |
| acción | disposition | KEEP ahora es leaveInInboxARCHIVE ahora es archiveDELETE ahora es trashMARK_READ ahora es markRead |
Otros cambios:
- Las direcciones de reenvío se deben crear y verificar antes de usarlas
- Las direcciones de reenvío se pueden administrar a través del recurso ForwardingAddresses.
Cómo administrar la configuración de POP
Para administrar el acceso de POP en la API de Gmail, usa el recurso Configuración.
| Configuración anterior | Configuración nueva | Notas |
|---|---|---|
| habilitar | accessWindow | Se inhabilita cuando se establece en disabled |
| enableFor | accessWindow | ALL_MAIL ahora es allMailMAIL_FROM_NOW_ON ahora es fromNowOn |
| acción | disposition | KEEP ahora es leaveInInboxARCHIVE ahora es archiveDELETE ahora es trashMARK_READ ahora es markRead |
Cómo administrar la configuración de IMAP
Para administrar el acceso a IMAP en la API de Gmail, usa el recurso Settings.
| Configuración anterior | Configuración nueva |
|---|---|
| habilitar | habilitado |
Cómo administrar la configuración de la respuesta automática de vacaciones
Para administrar la respuesta automática de vacaciones en la API de Gmail, usa el recurso Settings.
| Configuración anterior | Configuración nueva |
|---|---|
| contactsOnly | restrictToContacts |
| domainOnly | restrictToDomain |
| habilitar | enableAutoReply |
| endDate | endTime |
| mensaje | responseBodyHtml responseBodyPlainText |
| startDate | startTime |
| asunto | responseSubject |
Cómo administrar la configuración de la firma
Para administrar las firmas de correo electrónico en la API de Gmail, usa el recurso SendAs.
| Configuración anterior | Configuración nueva |
|---|---|
| firma | firma |
Otros cambios:
- Las firmas ahora se administran por alias.
Cómo administrar la configuración de idioma
Para administrar la configuración de idioma en la API de Gmail, usa el recurso Settings.
| Configuración anterior | Configuración nueva |
|---|---|
| idioma | displayLanguage |
Consulta la guía para administrar la configuración de idioma para obtener más información.
Administra la configuración de delegación
Para administrar la delegación en la API de Gmail, usa el recurso Delegates.
| Configuración anterior | Configuración nueva |
|---|---|
| dirección | delegateEmail |
| estado | verificationStatus |
Otros cambios:
- General
- Para usar cualquiera de los métodos de delegación (incluida la función delegates.create), el usuario del delegante debe estar habilitado para Gmail. Eso significa, por ejemplo, que el usuario del delegante no se puede suspender enGoogle Workspace.
- No se puede usar un alias de correo electrónico como entrada de correo electrónico del delegado para ninguno de los métodos nuevos. Se debe hacer referencia a un usuario delegado por su dirección de correo electrónico principal.
- delegates.create
- Este método ahora se puede usar para crear relaciones de delegación en varios dominios que pertenecen a la misma organización Google Workspace.
- Ahora, este método se puede usar para los usuarios que requieren un cambio de contraseña en su próximo acceso.
- Si la respuesta es correcta, este método muestra un recurso Users.settings.delegates en el cuerpo de la respuesta, en lugar de un cuerpo de respuesta vacío.
- Si alguno de los usuarios del delegante o del delegado está inhabilitado (por ejemplo, suspendido en Google Workspace), este método falla con un error HTTP 4XX en lugar de un error HTTP 500.
- delegates.delete
- Ahora, este método se puede usar para borrar delegados con cualquier verificationStatus, en lugar de solo delegados que sean
acceptedoexpired.
- Ahora, este método se puede usar para borrar delegados con cualquier verificationStatus, en lugar de solo delegados que sean
- delegates.get
- Este es un método nuevo que puede ser preferible al método delegates.list según sea necesario.
Cómo administrar la configuración general
La configuración general ya no está disponible a través de la API.