As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá. # Exemplos do Amazon SES usando o AWS SDK para PHP versão 3 Amazon Simple Email Service (Amazon SES) é uma plataforma de e-mail que oferece uma forma fácil e econômica para você enviar e receber e-mail usando seus próprios endereços de e-mail e domínios. Para obter mais informações sobre o Amazon SES, consulte o [Guia do desenvolvedor do Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/). A AWS oferece duas versões do serviço Amazon SES e, correspondentemente, o SDK para PHP oferece duas versões do cliente: [SesClient](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.Ses.SesClient.html) e [SesV2Client](https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.SesV2.SesV2Client.html). A funcionalidade dos clientes se sobrepõe em muitos casos, embora a forma como os métodos são chamados ou os resultados possam ser diferentes. As duas APIs também oferecem recursos exclusivos, para que você possa usar os dois clientes para acessar todas as funcionalidades. Todos os exemplos desta seção usam a original, `SesClient`. Todo o código de exemplo do AWS SDK para PHP versão 3 está disponível [aqui no GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code). **Topics** + [Verificar endereços de e-mail](ses-verify.md) + [Lidar com modelos de e-mail](ses-template.md) + [Gerenciamento de filtros de e-mail](ses-filters.md) + [Utilizar regras de e-mail](ses-rules.md) + [Monitorar sua atividade de envio](ses-send-email.md) + [Autorizar remetentes](ses-sender-policy.md) # Verificar identidades de e-mail usando a API do Amazon SES e o AWS SDK para PHP versão 3 Quando você começar a usar sua conta do Amazon Simple Email Service (Amazon SES), todos os remetentes e destinatários devem ser verificados na mesma região da AWS para a qual seus e-mails são enviados. Para obter mais informações sobre o envio de e-mails, consulte [Envio de e-mail com o Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-email.html). Os exemplos a seguir mostram como: + Verifique um endereço de e-mail com o [VerifyEmailIdentity](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#verifyemailidentity). + Verifique um domínio de e-mail com o [VerifyDomainIdentity](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#verifydomainidentity). + Liste todos os endereços de e-mail com o [ListIdentities](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listidentities). + Liste todos os domínios de e-mail com o [ListIdentities](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listidentities). + Exclua um endereço de e-mail com o [DeleteIdentity](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deleteidentity). + Exclua um domínio de e-mail com o [DeleteIdentity](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deleteidentity). O código de exemplo completo do AWS SDK para PHP está disponível [aqui no GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code). ## Credenciais Antes de executar o código de exemplo, configure suas credenciais da AWS, conforme descrito em [Autenticando com o AWS uso da AWS SDK para PHP versão 3](credentials.md). Em seguida, importe o AWS SDK para PHP, conforme descrito em [Instalando a AWS SDK para PHP versão 3](getting-started_installation.md). Para obter mais informações sobre o uso do Amazon SES, consulte o [Guia do desenvolvedor do Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/). ## Verificar endereços de e-mail O Amazon SES somente pode enviar e-mails de endereços ou domínios de e-mail verificados. Ao verificar um endereço de e-mail, demonstre que é o proprietário desse endereço e deseja conceder permissão ao Amazon SES para enviar e-mails desse endereço. Ao executar o exemplo de código a seguir, o Amazon SES envia um e-mail para o endereço especificado. Quando você (ou o destinatário do e-mail) clicar no link do e-mail, o endereço será verificado. Para adicionar um endereço de e-mail à sua conta do Amazon SES, utilize a operação [VerifyEmailIdentity](https://docs.aws.amazon.com/ses/latest/APIReference/API_VerifyEmailIdentity.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $email = 'email_address'; try { $result = $SesClient->verifyEmailIdentity([ 'EmailAddress' => $email, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Verificar um domínio de e-mail O Amazon SES somente pode enviar e-mails de endereços ou domínios de e-mail verificados. Ao verificar um domínio, demonstre que é o proprietário desse domínio. Ao verificar um domínio, você permite que o Amazon SES envie e-mails de qualquer endereço nesse domínio. Ao executar o exemplo de código a seguir, o Amazon SES fornece um token de verificação. É necessário adicionar o token para configuração de DNS do seu domínio. Para obter mais informações, consulte [Verificar um domínio com o Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domain-procedure.html) no Guia do desenvolvedor do Amazon Simple Email Service. Para adicionar um domínio de envio à sua conta do Amazon SES, utilize a operação [VerifyDomainIdentity](https://docs.aws.amazon.com/ses/latest/APIReference/API_VerifyDomainIdentity.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $domain = 'domain.name'; try { $result = $SesClient->verifyDomainIdentity([ 'Domain' => $domain, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Listar endereços de e-mail Para recuperar uma lista de endereços de e-mail enviada à região atual da AWS, independentemente do status de verificação, utilize a operação [ListIdentities](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListIdentities.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); try { $result = $SesClient->listIdentities([ 'IdentityType' => 'EmailAddress', ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Listar domínios de e-mail Para recuperar uma lista de domínios de e-mail enviada à região atual da AWS, independentemente do status de verificação, utilize a operação [ListIdentities](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListIdentities.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); try { $result = $SesClient->listIdentities([ 'IdentityType' => 'Domain', ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Excluir um endereço de e-mail Para excluir um endereço de e-mail verificado na lista de identidades, utilize a operação [DeleteIdentity](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteIdentity.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $email = 'email_address'; try { $result = $SesClient->deleteIdentity([ 'Identity' => $email, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Excluir um domínio de e-mail Para excluir um domínio de e-mail verificado na lista de identidades verificadas, utilize a operação [DeleteIdentity](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteIdentity.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $domain = 'domain.name'; try { $result = $SesClient->deleteIdentity([ 'Identity' => $domain, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` # Criação de modelos personalizados de e-mail usando a API do Amazon SES e o AWS SDK para PHP versão 3 O Amazon Simple Email Service (Amazon SES) permite o envio de e-mails personalizados para cada destinatário por meio de modelos. Os modelos incluem uma linha de assunto e as partes em texto e HTML do corpo de e-mail. É possível que as seções de assunto e corpo também contenham valores exclusivos e personalizados para cada destinatário. Para obter mais informações, consulte [Enviar e-mail personalizado usando o Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html) no Guia do desenvolvedor do Amazon Simple Email Service. Os exemplos a seguir mostram como: + Crie um modelo de e-mail com o [CreateTemplate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createtemplate). + Liste todos os modelos de e-mail com o [ListTemplates](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listtemplates). + Recupere um modelo de e-mail com o [GetTemplate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#gettemplate). + Atualize um modelo de e-mail com o [UpdateTemplate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#updateTemplate). + Exclua um modelo de e-mail com o [DeleteTemplate](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletetemplate). + Envie um e-mail em modelo com o [SendTemplatedEmail](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#sendtemplatedemail). O código de exemplo completo do AWS SDK para PHP está disponível [aqui no GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code). ## Credenciais Antes de executar o código de exemplo, configure suas credenciais da AWS, conforme descrito em [Autenticando com o AWS uso da AWS SDK para PHP versão 3](credentials.md). Em seguida, importe o AWS SDK para PHP, conforme descrito em [Instalando a AWS SDK para PHP versão 3](getting-started_installation.md). Para obter mais informações sobre o uso do Amazon SES, consulte o [Guia do desenvolvedor do Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/). ## Criar um modelo de e-mail Para criar um modelo e enviar mensagens de e-mail personalizadas, utilize a operação [CreateTemplate](https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateTemplate.html). O modelo pode ser utilizado por qualquer conta autorizada a enviar mensagens na região da AWS para a qual o modelo será adicionado. **nota** O Amazon SES não valida HTML, portanto, certifique-se de que o *HtmlPart* é válido antes de enviar um e-mail. **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $name = 'Template_Name'; $html_body = '

AWS Amazon Simple Email Service Test Email

' . '

This email was sent with ' . 'Amazon SES using the ' . 'AWS SDK for PHP.

'; $subject = 'Amazon SES test (AWS SDK for PHP)'; $plaintext_body = 'This email was send with Amazon SES using the AWS SDK for PHP.'; try { $result = $SesClient->createTemplate([ 'Template' => [ 'HtmlPart' => $html_body, 'SubjectPart' => $subject, 'TemplateName' => $name, 'TextPart' => $plaintext_body, ], ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Obter um modelo de e-mail Para visualizar o conteúdo de um modelo de e-mail existente, incluindo a linha de assunto, o corpo HTML e o texto sem formatação, utilize a operação [GetTemplate](https://docs.aws.amazon.com/ses/latest/APIReference/API_GetTemplate.html). Somente o TemplateName é obrigatório. **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $name = 'Template_Name'; try { $result = $SesClient->getTemplate([ 'TemplateName' => $name, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Listar todos os modelos de e-mail Para recuperar uma lista de todos os modelos de e-mail associados à Conta da AWS na região atual da AWS, utilize a operação [ListTemplates](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListTemplates.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); try { $result = $SesClient->listTemplates([ 'MaxItems' => 10, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Atualizar um modelo de e-mail Para alterar o conteúdo de um modelo de e-mail específico, incluindo a linha de assunto, o corpo HTML e o texto sem formatação, utilize a operação [UpdateTemplate](https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdadteTemplate.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $name = 'Template_Name'; $html_body = '

AWS Amazon Simple Email Service Test Email

' . '

This email was sent with ' . 'Amazon SES using the ' . 'AWS SDK for PHP.

'; $subject = 'Amazon SES test (AWS SDK for PHP)'; $plaintext_body = 'This email was send with Amazon SES using the AWS SDK for PHP.'; try { $result = $SesClient->updateTemplate([ 'Template' => [ 'HtmlPart' => $html_body, 'SubjectPart' => $subject, 'TemplateName' => $name, 'TextPart' => $plaintext_body, ], ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Excluir um modelo de e-mail Para excluir um modelo de e-mail específico, utilize a operação [DeleteTemplate](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteTemplate.html). Somente o TemplateName é necessário. **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $name = 'Template_Name'; try { $result = $SesClient->deleteTemplate([ 'TemplateName' => $name, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Enviar um e-mail com modelo Para usar um modelo e enviar e-mails aos destinatários, utilize a operação [SendTemplatedEmail](https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $template_name = 'Template_Name'; $sender_email = 'email_address'; $recipient_emails = ['email_address']; try { $result = $SesClient->sendTemplatedEmail([ 'Destination' => [ 'ToAddresses' => $recipient_emails, ], 'ReplyToAddresses' => [$sender_email], 'Source' => $sender_email, 'Template' => $template_name, 'TemplateData' => '{ }' ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` # Gerenciamento de filtros de e-mail usando a API do Amazon SES e o AWS SDK para PHP versão 3 Além de enviar e-mails, você também pode receber e-mails com o Amazon Simple Email Service (Amazon SES). Um filtro de endereço IP permite que você especifique se deseja aceitar ou recusar e-mails provenientes de um endereço IP ou de um intervalo de endereços IP. Para obter mais informações, consulte [Gerenciamento de filtros de endereço IP para o recebimento de e-mails do Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html). Os exemplos a seguir mostram como: + Crie um filtro de e-mail com o [CreateReceiptFilter](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createreceiptfilter). + Liste todos os filtros de e-mail com o [ListReceiptFilters](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listreceiptfilters). + Exclua um filtro de e-mail com o [DeleteReceiptFilter](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletereceiptfilter). O código de exemplo completo do AWS SDK para PHP está disponível [aqui no GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code). ## Credenciais Antes de executar o código de exemplo, configure suas credenciais da AWS, conforme descrito em [Autenticando com o AWS uso da AWS SDK para PHP versão 3](credentials.md). Em seguida, importe o AWS SDK para PHP, conforme descrito em [Instalando a AWS SDK para PHP versão 3](getting-started_installation.md). Para obter mais informações sobre o uso do Amazon SES, consulte o [Guia do desenvolvedor do Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/). ## Criar um filtro de e-mail Para autorizar ou bloquear e-mails de um endereço IP específico, utilize a operação [CreateReceiptFilter](https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptFilter.html). Forneça o endereço IP ou intervalo de endereços e um nome exclusivo para identificar esse filtro. **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $filter_name = 'FilterName'; $ip_address_range = '10.0.0.1/24'; try { $result = $SesClient->createReceiptFilter([ 'Filter' => [ 'IpFilter' => [ 'Cidr' => $ip_address_range, 'Policy' => 'Block|Allow', ], 'Name' => $filter_name, ], ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Listar todos os filtros de e-mail Para listar os filtros de endereço IP associados à sua Conta da AWS na região da AWS atual, utilize a operação [ListReceiptFilters](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListReceiptFilters.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); try { $result = $SesClient->listReceiptFilters(); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Excluir um filtro de e-mail Para excluir um filtro existente para um endereço IP específico, utilize a operação [DeleteReceiptFilter](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteReceiptFilter.html). Informe o nome do filtro exclusivo para identificar o filtro de recebimento a ser excluído. Caso seja necessário alterar o intervalo de endereços filtrados, é possível excluir um filtro de recebimento e criar um novo. **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $filter_name = 'FilterName'; try { $result = $SesClient->deleteReceiptFilter([ 'FilterName' => $filter_name, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` # Criação e gerenciamento de regras de e-mail usando a API do Amazon SES e o AWS SDK para PHP versão 3 Além de enviar e-mails, você também pode receber e-mails com o Amazon Simple Email Service (Amazon SES). Com as regras de recebimento, é possível especificar o que o Amazon SES faz com o e-mail que recebe para os endereços de e-mail ou domínios que você possui. Uma regra pode habilitar o envio de e-mail para outros serviços da AWS, incluindo Amazon S3, Amazon SNS ou AWS Lambda, entre outros. Para obter mais informações, consulte [Gerenciamento de conjuntos de regras de recepção para o recebimento de e-mails do Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html) e [Gerenciamento de regras de recepção para o recebimento de e-mails do Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html). Os exemplos a seguir mostram como: + Crie um conjunto de regras de recebimento com o [CreateReceiptRuleSet](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createreceiptruleset). + Crie uma regra de recebimento com o [CreateReceiptRule](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createreceiptrule). + Descreva um conjunto de regras de recebimento com o [DescribeReceiptRuleSet](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#describereceiptruleset). + Descreva uma regra de recebimento com o [DescribeReceiptRule](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#describereceiptrule). + Liste todos os conjuntos de regras de recebimento com o [ListReceiptRuleSets](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listreceiptrulesets). + Atualize uma regra de recebimento com o [UpdateReceiptRule](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#updatereceiptrule). + Exclua uma regra de recebimento com o [DeleteReceiptRule](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletereceiptrule). + Exclua um conjunto de regras de recebimento com o [DeleteReceiptRuleSet](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deletereceiptruleset). O código de exemplo completo do AWS SDK para PHP está disponível [aqui no GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code). ## Credenciais Antes de executar o código de exemplo, configure suas credenciais da AWS, conforme descrito em [Autenticando com o AWS uso da AWS SDK para PHP versão 3](credentials.md). Em seguida, importe o AWS SDK para PHP, conforme descrito em [Instalando a AWS SDK para PHP versão 3](getting-started_installation.md). Para obter mais informações sobre o uso do Amazon SES, consulte o [Guia do desenvolvedor do Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/). ## Criar um conjunto de regras de recebimento Um conjunto de regras de recebimento é composto por um grupo de regras de recepção. É necessário que ao menos um conjunto de regras de recebimento esteja associado à sua conta para que você possa criar uma regra de recebimento. Para criar um conjunto de regras de recebimento, forneça um RuleSetName exclusivo e utilize a operação [CreateReceiptRuleSet](https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRuleSet.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $name = 'Rule_Set_Name'; try { $result = $SesClient->createReceiptRuleSet([ 'RuleSetName' => $name, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Criar uma regra de recebimento Adicione uma regra de recebimento a um conjunto de regras existente para controlar os e-mails recebidos. Esse exemplo mostra como criar uma regra de recebimento que envia mensagens recebidas a um bucket do Amazon S3, mas também é possível enviar mensagens para o Amazon SNS e o AWS Lambda. Para criar um conjunto de regras de recebimento, informe uma regra e o RuleSetName exclusivo à operação [CreateReceiptRule](https://docs.aws.amazon.com/ses/latest/APIReference/API_CreateReceiptRule.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $rule_name = 'Rule_Name'; $rule_set_name = 'Rule_Set_Name'; $s3_bucket = 'Bucket_Name'; try { $result = $SesClient->createReceiptRule([ 'Rule' => [ 'Actions' => [ [ 'S3Action' => [ 'BucketName' => $s3_bucket, ], ], ], 'Name' => $rule_name, 'ScanEnabled' => true, 'TlsPolicy' => 'Optional', 'Recipients' => [''] ], 'RuleSetName' => $rule_set_name, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Descrever um conjunto de regras de recebimento Retorne os detalhes do conjunto de regras de recebimento especificado a cada segundo. Para utilizar a operação [DescribeReceiptRuleSet](https://docs.aws.amazon.com/ses/latest/APIReference/API_DescribeReceiptRuleSet.html), informe o RuleSetName. **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $name = 'Rule_Set_Name'; try { $result = $SesClient->describeReceiptRuleSet([ 'RuleSetName' => $name, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Descrever uma regra de recebimento Retorne os detalhes de uma regra de recebimento especificada. Para utilizar a operação [DescribeReceiptRule](https://docs.aws.amazon.com/ses/latest/APIReference/API_DescribeReceiptRule.html), informe a RuleName e o RuleSetName. **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $rule_name = 'Rule_Name'; $rule_set_name = 'Rule_Set_Name'; try { $result = $SesClient->describeReceiptRule([ 'RuleName' => $rule_name, 'RuleSetName' => $rule_set_name, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Listar todos os conjuntos de regras de recebimento Para listar os conjuntos de regras de recebimento existentes em sua Conta da AWS na região da AWS atual, utilize a operação [ListReceiptRuleSets](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListReceiptRuleSets.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); try { $result = $SesClient->listReceiptRuleSets(); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Atualizar uma regra de recebimento Esse exemplo mostra como atualizar uma regra de recebimento que envia mensagens recebidas a uma função do AWS Lambda, mas também é possível enviar mensagens para o Amazon SNS e o Amazon S3. Para utilizar a operação [UpdateReceiptRule](https://docs.aws.amazon.com/ses/latest/APIReference/API_UpdateReceiptRule.html), informe a nova regra de recebimento e o RuleSetName. **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $rule_name = 'Rule_Name'; $rule_set_name = 'Rule_Set_Name'; $lambda_arn = 'Amazon Resource Name (ARN) of the AWS Lambda function'; $sns_topic_arn = 'Amazon Resource Name (ARN) of the Amazon SNS topic'; try { $result = $SesClient->updateReceiptRule([ 'Rule' => [ 'Actions' => [ 'LambdaAction' => [ 'FunctionArn' => $lambda_arn, 'TopicArn' => $sns_topic_arn, ], ], 'Enabled' => true, 'Name' => $rule_name, 'ScanEnabled' => false, 'TlsPolicy' => 'Require', ], 'RuleSetName' => $rule_set_name, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Excluir um conjunto de regras de recebimento Remover um conjunto de regras de recebimento específico que não está desabilitado no momento. Essa ação também exclui todas as regras de recebimento incluídas no conjunto. Para excluir um conjunto de regras de recebimento, informe o RuleSetName à operação [DeleteReceiptRuleSet](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteReceiptRuleSet.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $name = 'Rule_Set_Name'; try { $result = $SesClient->deleteReceiptRuleSet([ 'RuleSetName' => $name, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Excluir uma regra de recebimento Para excluir uma regra de recebimento especificada, informe a RuleName e o RuleSetName à operação [DeleteReceiptRule](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteReceiptRule.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; ``` **Código de exemplo** ``` $SesClient = new Aws\Ses\SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-2' ]); $rule_name = 'Rule_Name'; $rule_set_name = 'Rule_Set_Name'; try { $result = $SesClient->deleteReceiptRule([ 'RuleName' => $rule_name, 'RuleSetName' => $rule_set_name, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` # Monitorar a atividade de envio usando a API do Amazon SES e o AWS SDK para PHP versão 3 O Amazon Simple Email Service (Amazon SES) oferece métodos para monitorar a atividade de envio. Recomendamos que você implemente esses métodos para que possa manter o controle de medidas importantes, como as taxas de devolução, reclamação e rejeição da sua conta. Taxas de devolução e reclamação muito altas podem prejudicar sua capacidade de enviar e-mails usando o Amazon SES. Os exemplos a seguir mostram como: + Verifique sua cota de envio com o [GetSendQuota](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#getsendquota). + Monitore sua atividade de envio com o [GetSendStatistics](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#getsendstatistics). O código de exemplo completo do AWS SDK para PHP está disponível [aqui no GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code). ## Credenciais Antes de executar o código de exemplo, configure suas credenciais da AWS, conforme descrito em [Autenticando com o AWS uso da AWS SDK para PHP versão 3](credentials.md). Em seguida, importe o AWS SDK para PHP, conforme descrito em [Instalando a AWS SDK para PHP versão 3](getting-started_installation.md). Para obter mais informações sobre o uso do Amazon SES, consulte o [Guia do desenvolvedor do Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/). ## Verificar sua cota de envio O limite de envio é de somente uma determinada quantidade de mensagens em um período de 24 horas. Para verificar quantas mensagens ainda podem ser enviadas, utilize a operação [GetSendQuota](https://docs.aws.amazon.com/ses/latest/APIReference/API_GetSendQuota.html). Para obter mais informações, consulte [Gerenciamento de limites de envio do Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; use Aws\Ses\SesClient; ``` **Código de exemplo** ``` $SesClient = new SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-1' ]); try { $result = $SesClient->getSendQuota(); $send_limit = $result["Max24HourSend"]; $sent = $result["SentLast24Hours"]; $available = $send_limit - $sent; print("

You can send " . $available . " more messages in the next 24 hours.

"); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Monitorar sua atividade de envio Para recuperar métricas referentes às mensagens enviadas nas últimas duas semanas, utilize a operação [GetSendStatistics](https://docs.aws.amazon.com/ses/latest/APIReference/API_GetSendStatistics.html). Esse exemplo retorna o número de tentativas de entrega, devoluções, reclamações e mensagens recusadas em incrementos de 15 minutos. **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; use Aws\Ses\SesClient; ``` **Código de exemplo** ``` $SesClient = new SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-1' ]); try { $result = $SesClient->getSendStatistics(); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` # Autorização de remetentes usando a API do Amazon SES e o AWS SDK para PHP versão 3 Para habilitar outra Conta da AWS, usuário do AWS Identity and Access Management ou serviço da AWS a enviar e-mails por meio do Amazon Simple Email Service (Amazon SES) em seu nome, crie uma política de autorização de envio. Este é um documento JSON que você deve anexar a uma identidade que possui. A política lista expressamente quem você permite que envie para essa identidade e em que condições. Com exceção de você e das entidades às quais concedeu permissões explicitamente na política, todos os demais remetentes não estão autorizados a enviar e-mails. Uma identidade pode ter nenhuma política, uma política ou várias políticas anexadas a ela. Você também pode ter uma política com várias instruções para alcançar o efeito de várias políticas. Para obter mais informações, consulte [Como usar a autorização de envio com o Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). Os exemplos a seguir mostram como: + Crie um remetente autorizado com o [PutIdentityPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#createidentitypolicy). + Recupere políticas para um remetente autorizado com o [GetIdentityPolicies](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#getidentitypolicies). + Liste os remetentes autorizados com o [ListIdentityPolicies](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#listidentitypolicies). + Revogue permissão para um remetente autorizado com o [DeleteIdentityPolicy](https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-email-2010-12-01.html#deleteidentitypolicy). O código de exemplo completo do AWS SDK para PHP está disponível [aqui no GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php/example_code). ## Credenciais Antes de executar o código de exemplo, configure suas credenciais da AWS, conforme descrito em [Autenticando com o AWS uso da AWS SDK para PHP versão 3](credentials.md). Em seguida, importe o AWS SDK para PHP, conforme descrito em [Instalando a AWS SDK para PHP versão 3](getting-started_installation.md). Para obter mais informações sobre o uso do Amazon SES, consulte o [Guia do desenvolvedor do Amazon SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/). ## Criar um remetente autorizado Para autorizar outra Conta da AWS a enviar e-mails em seu nome, utilize uma política de identidade para adicionar ou atualizar a autorização referente ao envio de e-mails de seus endereços de e-mail ou domínios verificados. Para criar uma política de identidades, utilize a operação [PutIdentityPolicy](https://docs.aws.amazon.com/ses/latest/APIReference/API_PutIdentityPolicy.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; use Aws\Ses\SesClient; ``` **Código de exemplo** ``` $SesClient = new SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-1' ]); $identity = "arn:aws:ses:us-east-1:123456789012:identity/example.com"; $other_aws_account = "0123456789"; $policy = <<putIdentityPolicy([ 'Identity' => $identity, 'Policy' => $policy, 'PolicyName' => $name, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Recuperar políticas para um remetente autorizado Retorne as políticas de autorização de envio que são associadas a uma identidade de e-mail ou identidade de domínio específica. Para obter a autorização de envio para um determinado endereço de e-mail ou domínio, utilize a operação [GetIdentityPolicy](https://docs.aws.amazon.com/ses/latest/APIReference/API_GetIdentityPolicy.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; use Aws\Ses\SesClient; ``` **Código de exemplo** ``` $SesClient = new SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-1' ]); $identity = "arn:aws:ses:us-east-1:123456789012:identity/example.com"; $policies = ["policyName"]; try { $result = $SesClient->getIdentityPolicies([ 'Identity' => $identity, 'PolicyNames' => $policies, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Listar remetentes autorizados Para listar as políticas de autorização de envio que são associadas a uma identidade de e-mail ou identidade de domínio específica na região atual da AWS, utilize a operação [ListIdentityPolicies](https://docs.aws.amazon.com/ses/latest/APIReference/API_ListIdentityPolicies.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; use Aws\Ses\SesClient; ``` **Código de exemplo** ``` $SesClient = new SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-1' ]); $identity = "arn:aws:ses:us-east-1:123456789012:identity/example.com"; try { $result = $SesClient->listIdentityPolicies([ 'Identity' => $identity, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ``` ## Revogar permissão para um remetente autorizado Exclua a autorização de envio concedida a outra Conta da AWS para o envio de e-mails com uma identidade de e-mail ou identidade de domínio ao remover a política de identidade associada por meio da operação [DeleteIdentityPolicy](https://docs.aws.amazon.com/ses/latest/APIReference/API_DeleteIdentityPolicy.html). **Importações** ``` require 'vendor/autoload.php'; use Aws\Exception\AwsException; use Aws\Ses\SesClient; ``` **Código de exemplo** ``` $SesClient = new SesClient([ 'profile' => 'default', 'version' => '2010-12-01', 'region' => 'us-east-1' ]); $identity = "arn:aws:ses:us-east-1:123456789012:identity/example.com"; $name = "policyName"; try { $result = $SesClient->deleteIdentityPolicy([ 'Identity' => $identity, 'PolicyName' => $name, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; } ```