Como configurar o e-mail

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

Por padrão, o portal de Serviços para Desenvolvedores envia e-mails em resposta a determinados eventos. Por exemplo, quando um novo desenvolvedor se registra no portal, ele envia automaticamente um e-mail de boas-vindas para ele. Ou, se o desenvolvedor perder a senha, poderá solicitar um e-mail com uma senha temporária.

Como provedor de API, você pode controlar todos os aspectos dos e-mails gerados pelo portal, incluindo:

  • Formatar os e-mails automáticos enviados pelo portal
  • Especificar o servidor SMTP usado pelo portal
  • Adicionar regras para gerar e-mails em resposta a eventos no portal

Como enviar e-mails de um portal baseado na nuvem

A configuração de e-mail padrão para um portal baseado na nuvem implantado no Pantheon ou no Acquia só deve ser usada em ambientes que não sejam de produção. Os e-mails enviados de um servidor de nuvem anônimo podem ser bloqueados ou marcados como spam.

Para portais de produção, use uma das seguintes opções de envio de e-mails:

Como enviar e-mails de um portal local

Por padrão, o e-mail é enviado usando a função PHP mail(). O PHP tenta enviar e-mails usando o sendmail no sistema local, que pode ser configurado no arquivo php.ini do PHP.

Em portais de produção, é possível usar o módulo SMTP descrito abaixo para enviar e-mails por meio de um servidor SMTP ou da empresa.

Como configurar um servidor SMTP

O portal do desenvolvedor exige que você configure um servidor SMTP para enviar mensagens de e-mail. Para configurar o servidor SMTP, primeiro ative o módulo de suporte de autenticação SMTP do Drupal no portal do desenvolvedor.

Depois que você configurar o servidor SMTP, todos os e-mails enviados pelo portal do desenvolvedor usarão o servidor SMTP. Esses e-mails incluem e-mails enviados para novos desenvolvedores, para desenvolvedores que perdem a senha e e-mails enviados para desenvolvedores com contas bloqueadas.

Para configurar o servidor SMTP:

  1. Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
  2. Selecione Modules no menu de administração do Drupal.
    A página "Módulos" é aberta.
  3. Ative o módulo Suporte a autenticação SMTP.
  4. Salve a configuração.
  5. Depois que o módulo for ativado, selecione Configure na entrada SMTP Authentication Support na página Módulos.
    A página de configuração do suporte a autenticação SMTP é exibida.
  6. Em Turn this module on or of, selecione On.
  7. Na área de configurações do servidor SMTP, digite as seguintes informações:
    • Endereço do servidor SMTP. Por exemplo, para o servidor SMTP de saída do Gmail, use smtp.gmail.com.
    • Também é possível digitar o endereço do servidor SMTP de backup. Esse valor não é obrigatório.
    • Digite a porta SMTP. O valor dessa porta pode ser diferente dependendo do protocolo de criptografia selecionado. Por exemplo, no Gmail, a porta é 465 quando o SSL é usado e 587 para TLS.
    • Selecione o protocolo de criptografia como Nenhum, SSL ou TLS.
  8. Na área Autenticação SMTP, especifique o nome de usuário e a senha usados para a autenticação SMTP. Use um nome de usuário e uma senha válidos no servidor SMTP.
  9. Em Opções de e-mail, insira o endereço de e-mail e o nome do usuário que está gerando a mensagem. Esses valores correspondem ao endereço no campo "De" do e-mail.
  10. Se preferir, em Enviar mensagem de e-mail de teste, insira um endereço de e-mail para onde o portal envia uma mensagem de teste.
  11. Salve a configuração.
    Salvar a configuração gera a mensagem de e-mail de teste e mostra os erros de configuração. Verifique a caixa de entrada do endereço de e-mail da mensagem de teste para garantir que ela chegou.
  12. Selecione Configuration > System > Site Information no menu de administração do Drupal.
  13. Em Site Details, defina o endereço de e-mail como o mesmo especificado na Etapa 9.
    Alguns módulos Drupal que geram e-mails usam esse campo para determinar o endereço "De" do e-mail, e não o valor na página de suporte a autenticação SMTP.
  14. Salve a configuração.

Como configurar e formatar notificações por e-mail

É possível configurar várias notificações por e-mail que são enviadas em resposta a atividades específicas, como registro, exclusão, bloqueio e desbloqueio de contas de desenvolvedor.

Você também pode controlar o endereço no campo "De" dos e-mails.

Para configurar as notificações por e-mail:

  1. Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
  2. Selecione Configuration > People > Account settings no menu de administração do Drupal. A página "Configurações da conta" é aberta.
  3. Selecione um tipo de notificação por e-mail na seção "E-mails" da página de configuração de contas. Por exemplo, você pode selecionar "Olá (nenhuma aprovação necessária)", que envia um e-mail quando a conta de desenvolvedor é automaticamente aprovada durante o processo de registro.

  4. Edite o Assunto e o Corpo da notificação por e-mail.
    Coloque o cursor em um campo, como Assunto, e selecione o link Procurar tokens disponíveis na parte de baixo do formulário para conferir a lista de tokens que podem ser usados no campo. É exibido um pop-up que permite selecionar um token para adicionar, como [user:name], que corresponde ao nome de usuário do desenvolvedor.
  5. Clique em Salvar configuração.

Você também pode alterar o nome e o endereço no campo "De" em uma notificação por e-mail.

Para mudar o nome e o endereço no campo "De":

  1. Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
  2. Selecione Configuration > System > SMTP Authentication Support no menu de administração do Drupal. Isso abre a página de suporte da autenticação SMTP.
  3. Especifique um endereço de e-mail "De" no campo Endereço de e-mail do remetente.
  4. Especifique um nome "De" no campo Nome do remetente do e-mail.
  5. Clique em Salvar configuração.
  6. Selecione Configuration > System > Site information no menu de administração do Drupal.
  7. Especifique o mesmo endereço de e-mail usado na Etapa 3 no campo "Endereço de e-mail".
  8. Clique em Salvar configuração.

Como gerar um e-mail quando ocorre um evento

As regras costumam ser usadas para gerar e-mails em resposta a um evento. O portal tem suporte integrado para gerar e-mails para eventos predefinidos, como quando um novo desenvolvedor registra uma conta. No entanto, você pode adicionar suas próprias regras para gerar e-mails. Por exemplo, você pode gerar um e-mail quando o desenvolvedor adiciona, remove ou modifica um app.

Esta seção contém um exemplo de como criar uma regra para gerar um e-mail quando um desenvolvedor registra um app. Modifique esse procedimento conforme necessário para gerar e-mails para outros eventos.

Para gerar um e-mail quando um desenvolvedor cria um app:

  1. Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
  2. Selecione Modules no menu de administração do Drupal.
  3. Verifique se o módulo IU de regras está ativado.
  4. Selecione Configuração > Fluxo de trabalho > Regras no menu de administração do Drupal. A página "Regras" será aberta.
  5. Selecione o botão Adicionar uma nova regra.
  6. Na nova página "Regras", especifique o seguinte:
    • O nome da regra, por exemplo, "Enviar regra de e-mail".
    • Se preferir, especifique as tags usadas para categorizar as regras de pesquisa.
    • No menu suspenso Reagir em caso de evento, selecione Devconnect > Após a criação de um app do desenvolvedor.
  7. Salve a regra.
    Salvar a regra abre o formulário de edição de regras com três painéis: Eventos (que você acabou de criar), Condições e Ações.
  8. Em Ações, selecione Adicionar ação.
  9. No menu suspenso Select the Action to Add, selecione System > send mail.
    Essa seleção abre uma página em que é possível formatar o e-mail. Use este formulário para especificar "Para", "Assunto", "Mensagem" e outros campos do e-mail.

    Expanda o link Substituição de cada campo para conferir a lista de padrões que podem ser usados no campo. Por exemplo, se você expandir "Padrões de substituição", no campo "Para", verá uma lista de padrões que inclui [app:developer]. Se você especificar esse padrão no campo "Para", o e-mail será enviado para o criador do app.
  10. Defina os campos como mostrado abaixo:
  11. Selecione Salvar para voltar à página de edição de regras.
  12. Selecione Salvar alterações.

Adicione um novo app ao portal para testar a regra. Você receberá uma notificação por e-mail como resposta a esta:

Subject: App test email app created

App: test email app
API products: PremiumWeatherAPI, weatherapikey-Product
Created at: Mon, 01/27/2014 - 10:16