An extension built to effortlessly send test HTML emails without leaving Visual Studio Code.
Kirim uses a YAML front matter block at the top of the HTML document to store and process send data. This block is referred to as a config in the extension and can be saved in different configurations to use across other emails.
name: Test Team
to:
- [email protected]
- [email protected]
from: Test Name <[email protected]>
subject: This is a test email
Note: It's compulsory to create a free SendGrid account and generate an API key for Kirim to connect and dispatch each test send.
- Open a
HTMLdocument in the editor and initiate the command paletteCtrl-Shift-P(Windows/Linux) orCmd-Shift-P(macOS) and search forKirim. Alternatively, launch a list of commands by clicking onKirimin the status bar of the editor. - Select
Kirim: Load Configto generate a default config block placed at the top of theHTMLdocument. - Enter the required data in the newly created config block. If the data contains any of these characters
:-{}[]!#|>&%@wrap it in quotes to avoid errors (example below).
subject: "Woo! This is a test email"
- Initiate the command palette again and select
Kirim: Save Keythen paste in your SendGrid API key which will be stored in extension settings. - Finally, run
Kirim: Send Emailto dispatch your first test send and watch the magic happen.
name - A name which identifies the config once saved
to - The list of email addresses being sent to
from - The from name and email address
subject - A subject line for the email being sent
| Command | Description |
|---|---|
| Send Email | Sends an email to the defined config details |
| Clear Config | Clears the config from the top of an email |
| Load Config | Loads the default or other saved configs |
| Save Config | Saves the config for use in other emails |
| Delete Config | Deletes a config from the saved list |
| Save Key | Saves the SendGrid API key in extension settings |