Download the PHP package inovanti-bank/messaging without Composer
On this page you can find all versions of the php package inovanti-bank/messaging. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package messaging
Componente Messaging para Aplicações Laravel
O inovanti-messaging é um pacote desenvolvido para facilitar a troca de mensagens e a integração com serviços externos de envio (SMS, e-mail, notificações, etc.) em projetos Laravel 11. O objetivo é fornecer uma API simples para gerenciar provedores de envio, rastreamento de mensagens e logs, sem complicar o fluxo de desenvolvimento.
📌 Índice
- Instalação
- Configuração
- APIs Suportadas
- Uso
- Exemplo de Envio de SMS
- Exemplo de Envio de WhatsApp
- Exemplo de Envio de E-mail
- Testes
- Contribuindo
- Licença
🚀 Instalação
Para instalar este pacote via Composer, utilize o seguinte comando:
⚙️ Configuração
Service Provider
Se você estiver usando o Laravel 11, o próprio framework já pode descobrir automaticamente o provider e a facade.
Porém, caso queira registrar manualmente, adicione no array de providers do arquivo config/app.php:
Publicar Configurações (opcional)
Este pacote pode conter um arquivo de configuração que você pode publicar para customizar:
Após isso, edite o arquivo config/messaging.php conforme necessário.
Adicione as seguintes variáveis no .env:
🌐 APIs Suportadas
Atualmente, a versão 1.0.0 do inovanti-messaging suporta as seguintes plataformas de envio de mensagens:
| API | Tipo de Mensagem | Serviços Disponíveis |
|---|---|---|
| Twilio | SMS | TwilioSmsService |
| Twilio | TwilioWhatsAppService |
|
| SendGrid | SendGridEmailService |
Estamos constantemente adicionando novos provedores de envio ao pacote. Para obter a lista mais atualizada das APIs suportadas e instruções sobre como configurá-las, consulte o repositório no GitHub.
Se houver suporte a novos provedores, a documentação será atualizada para incluir instruções específicas sobre como utilizá-los.
📩 Uso
Agora o envio de mensagens é feito através de serviços específicos (TwilioSmsService, TwilioWhatsAppService, SendGridEmailService), que são gerenciados pelo MessageService.
Exemplo de Envio de SMS
Exemplo de Envio de WhatsApp
Exemplo de Envio de E-mail
O campo subject é opcional. Para compatibilidade, o assunto informado em
metadata['subject'] continua sendo aceito. Quando correlationId é informado,
ele também é enviado ao SendGrid como o custom arg correlation_id, facilitando
a correlação do envio com os eventos e a atividade da mensagem.
O retorno do envio preserva os campos existentes (status, message_id, to,
from, type, http_status, cc e bcc) e inclui o contexto rastreável usado
no payload, além de response_headers e response_body do SendGrid.
message_id e x_message_id representam o X-Message-ID retornado no aceite do
Mail Send. O sg_message_id definitivo é atribuído aos eventos individuais pelo
SendGrid e pode ser obtido na atividade da mensagem ou no Event Webhook.
Categorias devem representar agrupamentos gerais. Para identificadores por envio,
prefira customArgs ou correlationId. Não envie dados pessoais sensíveis nesses
campos, pois o SendGrid não os trata como PII e pode armazená-los por longo prazo.
Para consultar a atividade de uma mensagem pelo ID retornado no envio:
Essa consulta utiliza a Email Activity Feed API do SendGrid e exige que a conta tenha o histórico adicional contratado e que a API key possua permissão de acesso à atividade de e-mail.
🧪 Testes
O pacote vem com testes unitários simulada para garantir que tudo funcione conforme o esperado. Você pode executar os testes usando PHPUnit:
Para testes unit:
🤝 Contribuindo
Contribuições são bem-vindas! Se você deseja reportar um bug, solicitar um novo recurso ou contribuir com código, fique à vontade para abrir uma issue ou enviar um Pull Request.
- Faça um Fork do projeto
- Crie sua feature branch:
git checkout -b minha-nova-feature - Commit suas mudanças:
git commit -m 'Adiciona nova feature' - Faça o push para a branch:
git push origin minha-nova-feature - Crie um novo Pull Request
📜 Licença
Este projeto está licenciado sob a MIT license.
All versions of messaging with dependencies
laravel/framework Version ^11.0|^10.0
sendgrid/sendgrid Version ^8.1
twilio/sdk Version ^8.3
vlucas/phpdotenv Version ^5.6