Git Product home page Git Product logo

api-envio-automatizado-mensagem-email's Introduction

r4kqNp.md.png

Yara - Message in a Bottle

Deploy no heroku

link úteis da api no heroku:

  • Cadastro usuário:

https://api-yara-sendingemail.herokuapp.com/users

  • Cadastro mensagem:

https://api-yara-sendingemail.herokuapp.com/message

Como usar ?

  • Descrição no ReadMe

Sobre API Yara - Message in a Bottle

  • Yara é uma aplicação que permite o envio de e-mails automatizados com mensagens pré-formatadas (ou não) a usuários cadastrados em um banco de dados;

  • Com o programa é possível criar, buscar, deletar e fazer update do cadastro de usuários, associando-os a endereços eletrônicos e um id;

  • Há também um repositório de mensagens que recebe temas e textos pré-definidos, onde também é possível gerenciar de forma constante, fazendo busca por assuntos e registro;

  • Utilizando uma ferramenta auxiliar (Postman), é possível confirmar o envio, retornando data e horário.

Criado por

  • Anuar Samir Mamede
  • Allan Arruda
  • Fábio Clericuzi
  • Túlio Albuquerque

Mentoria:

  • Rui Arthur Nunes
  • Samuel França

Trabalho de conclusão do curso NExT - Nova Experiência de Trabalho; Sem fins comerciais;

O que você vai precisar

CRUD de Usuários

Primeiro, você terá que ir em Aplication Properties e atualizar os dados de username e senha, considerando seu banco de dados local e o endereço que enviará as mensagens pré-formatadas;

Depois de rodar a aplicação e com o banco de dados sincronizado na sua máquina, você precisará de uma ferramenta para fazer REST Requests. Todos os testes de funcionalidade do CRUD e do envio de e-mail deste projeto foram feitos usando o Postman.

O banco de dados recebe informações sobre usuários, com os parâmetros "nameUser" e "emailUser".

http://localhost:8080/users Usando essa URL request no Postman, você pode utilizar os seguintes métodos: POST, para cadastrar usuários (recomendamos não colocar espaços em branco); GET, para listar todos usuários cadastrados;

http://localhost:8080/users/id Colocando o número do ID do usuário no lugar do "id", você pode usar os seguintes métodos: GET, para buscar o usuário por ID; DELETE, para apagar o usuário identificado pelo ID; PUT, para atualizar dados do usuário identificado pelo ID.

exemplo: http://localhost:8080/users/12

CRUD de Mensagens

Há também uma forma de adicionar mensagens pré-formatadas na tabela, com os parâmetros "messageSubject" e "messageText".

http://localhost:8080/message Usando essa URL request no Postman, você pode utilizar os seguintes métodos: POST, para cadastrar mensagens; GET, para listar todas mensagens cadastradas;

http://localhost:8080/message/id Colocando o número do ID do usuário depois do "id", você pode usar os seguintes métodos: GET, para buscar a mensagem por ID; DELETE, para apagar a mensagem identificado pelo ID; PUT, para atualizar dados da mensagem identificado pelo ID.

Enviando e-mails

Para enviar e-mails utilizando a tabela de usuários, você deve seguir o seguintes modelos:

http://localhost:8080/sending-email/nameUser Para mandar o e-mail para um usuário cadastrado no banco de dados, troque "nameUser" pelo nome do usuário que você quer enviar.

Exemplo: sending-email/AllanArruda

No corpo do email, você deve preencher os seguintes campos:

  • ownerRef;

  • emailFrom;

  • subject;

  • text;

Para enviar e-mail usando mensagens pré-cadastradas para usuários cadastrados, utilize a seguinte URL: http://localhost:8080/sending-email/nameUser/messageSubject

No campo "nameUser" será passado o nome conforme foi cadastrado, sem espaço, e no "messageSubject" será passado o assunto da mensagem de e-mail também conforme cadastrado no banco de dados:

exemplo: http://localhost:8080/sending-email/TulioAlbu/Aniversario

Nossos contatos:

Anuar Samir Mamede:

Github
Linkedin

Allan Arruda:

api-envio-automatizado-mensagem-email's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.