{"_id":"542abdb354d88d140075fbf2","user":"542979b61215fe08007e0ee4","parentDoc":null,"githubsync":"","category":{"_id":"542979c51215fe08007e0ee9","project":"542979c51215fe08007e0ee5","version":"542979c51215fe08007e0ee8","__v":12,"pages":["542979c51215fe08007e0eeb","542ae00fcedcfc140004b81e","542abdb354d88d140075fbf2","542986467a6b690800767fb1","54298c241215fe08007e0ff4","54380adef1c23914006724b9","546287c18ba5620800710e4c","55e99381358d923700be988e","56328926df556c0d00cd0929","56421475b0dc090d00f8842c"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-09-29T15:24:53.471Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"is_link":false,"project":"542979c51215fe08007e0ee5","version":{"_id":"542979c51215fe08007e0ee8","project":"542979c51215fe08007e0ee5","__v":4,"createdAt":"2014-09-29T15:24:53.437Z","releaseDate":"2014-09-29T15:24:53.437Z","categories":["542979c51215fe08007e0ee9","542985897a6b690800767fab","5429898d1215fe08007e0fe6","542ac5aa54d88d140075fcaf"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":14,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-09-30T14:26:59.771Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","try":true,"basic_auth":false,"auth":"never","params":[],"url":""},"isReference":false,"order":5,"body":"When you’re ready to see what your email looks like in an actual email client, or when you're ready to show off your work to your client, Inkcite can send previews on demand.  Prior to sending, Inkcite will automatically upload your latest image assets to your CDN or other publicly accessible server.  It will then send individual emails to the configured distribution list of your choice. \n\nThere are several sections in the `config.yml` that will need your attention before you can send preview emails.  Be sure you have configured your [CDN or Image Host](doc:cdn-upload).\n\n# Configuring Inkcite to Send Emails\n\nInkcite supports sending emails either through your SMTP server or [Mailgun](http://mailgun.com).  It's important to send emails from your own server particularly when you use [Litmus](doc:compatibility-testing) for SPAM testing.\n\n## Sending via SMTP\n\nTo enable sending previews via your SMTP server, configure these fields in your project's `config.yml` file:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"# SMTP settings for sending email previews\\nsmtp:\\n  host: 'smtp.gmail.com'\\n  port: 587\\n  domain: 'yourdomain.com'\\n  username: '(YOUR SMTP USERNAME HERE)'\\n  password: '(YOUR SMTP PASSWORD HERE)'\\n  from: 'Your Name <email:::at:::domain.com>'\",\n      \"language\": \"yaml\",\n      \"name\": \"config.yml\"\n    }\n  ]\n}\n[/block]\n## Sending via Mailgun\n\nTo enable sending previews via Mailgun's API, you'll need to create a free account (if you haven't already) and then retrieve a couple of pieces of information from your Dashboard.  Enter that information into your project's `config.yml` file:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"mailgun:\\n  api-key: '(YOUR MAILGUN API KEY HERE)'\\n  domain: '(YOUR MAILGUN DOMAIN NAME)'\\n  from: 'Your Name <email@domain.com>'\",\n      \"language\": \"yaml\",\n      \"name\": \"config.yml\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note!\",\n  \"body\": \"Mailgun also provides SMTP access.  Use the `smtp` settings (above) if you'd rather send previews via SMTP.\"\n}\n[/block]\n# Sending a Preview to Yourself\n\nOnce you have configured both the SMTP and image host settings, you're ready to send a preview to yourself.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"inkcite preview\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nWith no other parameters, this will send the preview version of your email to the `from` email address you specified in `config.yml`.  The email will be tagged as a *Developer Preview* and uniquely identified for easy identification in your inbox.\n\n# Sending an Internal Preview\n\nWhen you're ready to send a preview of your email to a wider audience (e.g. a proofreader, creative director, project leader, etc.) you can use Inkcite's internal preview capability.  First you'll need to define a distribution list inside of your `config.yml` file:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"recipients:\\n  internal:\\n    - 'Creative Director <creative.director@your-company.com>'\\n    - 'Proofreader <proofreader@your-company.com>'\",\n      \"language\": \"yaml\",\n      \"name\": \"config.yml\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Distribution lists can include one or more email addresses, each specified on a separate line.\"\n}\n[/block]\nTo have Inkcite send an email to this distribution list, from a command prompt type:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"inkcite preview internal\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nInkcite will send a preview version of the email to each of the recipients specified in your internal distribution list.  The email subject line will be tagged *Internal Preview* and by uniquely identified.  This is extremely useful when revisions have been made and additional previews have been sent out:  \"Did you see the CTA improvements I made in preview #3?\"\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Inkcite will always BCC your `from` email address, configured in either the SMTP or Mailgun section of the config file when sending internal previews.\",\n  \"title\": \"Note!\"\n}\n[/block]\n# Sending an External Preview\n\nInkcite was designed for agencies.  It presumes (but does not require) that there is a list of clients, beyond your internal distribution list, that need to preview the work you are doing for them.  Typically, you'd send a preview to your clients once your email has been approved by the internal team.  \n\nInkcite allows you to define a separate distribution list for the specific clients:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"recipients:  \\n  client:\\n    - 'Awesome Client <awesome.client@domain.com>'\\n  internal:\",\n      \"language\": \"yaml\",\n      \"name\": \"config.yml\"\n    }\n  ]\n}\n[/block]\nTo send a preview version of your email to your clients, at a command prompt type:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"inkcite preview client\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nInkcite will uniquely identify these emails as *Preview* with a unique and separate counter from both developer and internal previews.  (No need for your clients to know it took 10 internal previews to get to the perfect, responsive preview you just sent them.)","excerpt":"Send a test version of your email to yourself, your team or your client","slug":"email-previews","type":"basic","title":"Email Previews"}

Email Previews

Send a test version of your email to yourself, your team or your client

When you’re ready to see what your email looks like in an actual email client, or when you're ready to show off your work to your client, Inkcite can send previews on demand. Prior to sending, Inkcite will automatically upload your latest image assets to your CDN or other publicly accessible server. It will then send individual emails to the configured distribution list of your choice. There are several sections in the `config.yml` that will need your attention before you can send preview emails. Be sure you have configured your [CDN or Image Host](doc:cdn-upload). # Configuring Inkcite to Send Emails Inkcite supports sending emails either through your SMTP server or [Mailgun](http://mailgun.com). It's important to send emails from your own server particularly when you use [Litmus](doc:compatibility-testing) for SPAM testing. ## Sending via SMTP To enable sending previews via your SMTP server, configure these fields in your project's `config.yml` file: [block:code] { "codes": [ { "code": "# SMTP settings for sending email previews\nsmtp:\n host: 'smtp.gmail.com'\n port: 587\n domain: 'yourdomain.com'\n username: '(YOUR SMTP USERNAME HERE)'\n password: '(YOUR SMTP PASSWORD HERE)'\n from: 'Your Name <email@domain.com>'", "language": "yaml", "name": "config.yml" } ] } [/block] ## Sending via Mailgun To enable sending previews via Mailgun's API, you'll need to create a free account (if you haven't already) and then retrieve a couple of pieces of information from your Dashboard. Enter that information into your project's `config.yml` file: [block:code] { "codes": [ { "code": "mailgun:\n api-key: '(YOUR MAILGUN API KEY HERE)'\n domain: '(YOUR MAILGUN DOMAIN NAME)'\n from: 'Your Name <email@domain.com>'", "language": "yaml", "name": "config.yml" } ] } [/block] [block:callout] { "type": "info", "title": "Note!", "body": "Mailgun also provides SMTP access. Use the `smtp` settings (above) if you'd rather send previews via SMTP." } [/block] # Sending a Preview to Yourself Once you have configured both the SMTP and image host settings, you're ready to send a preview to yourself. [block:code] { "codes": [ { "code": "inkcite preview", "language": "shell" } ] } [/block] With no other parameters, this will send the preview version of your email to the `from` email address you specified in `config.yml`. The email will be tagged as a *Developer Preview* and uniquely identified for easy identification in your inbox. # Sending an Internal Preview When you're ready to send a preview of your email to a wider audience (e.g. a proofreader, creative director, project leader, etc.) you can use Inkcite's internal preview capability. First you'll need to define a distribution list inside of your `config.yml` file: [block:code] { "codes": [ { "code": "recipients:\n internal:\n - 'Creative Director <creative.director@your-company.com>'\n - 'Proofreader <proofreader@your-company.com>'", "language": "yaml", "name": "config.yml" } ] } [/block] [block:callout] { "type": "info", "body": "Distribution lists can include one or more email addresses, each specified on a separate line." } [/block] To have Inkcite send an email to this distribution list, from a command prompt type: [block:code] { "codes": [ { "code": "inkcite preview internal", "language": "shell" } ] } [/block] Inkcite will send a preview version of the email to each of the recipients specified in your internal distribution list. The email subject line will be tagged *Internal Preview* and by uniquely identified. This is extremely useful when revisions have been made and additional previews have been sent out: "Did you see the CTA improvements I made in preview #3?" [block:callout] { "type": "warning", "body": "Inkcite will always BCC your `from` email address, configured in either the SMTP or Mailgun section of the config file when sending internal previews.", "title": "Note!" } [/block] # Sending an External Preview Inkcite was designed for agencies. It presumes (but does not require) that there is a list of clients, beyond your internal distribution list, that need to preview the work you are doing for them. Typically, you'd send a preview to your clients once your email has been approved by the internal team. Inkcite allows you to define a separate distribution list for the specific clients: [block:code] { "codes": [ { "code": "recipients: \n client:\n - 'Awesome Client <awesome.client@domain.com>'\n internal:", "language": "yaml", "name": "config.yml" } ] } [/block] To send a preview version of your email to your clients, at a command prompt type: [block:code] { "codes": [ { "code": "inkcite preview client", "language": "shell" } ] } [/block] Inkcite will uniquely identify these emails as *Preview* with a unique and separate counter from both developer and internal previews. (No need for your clients to know it took 10 internal previews to get to the perfect, responsive preview you just sent them.)