Connecting to Email Services

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsConnecting to Email Services

AWS SES

To create a service for connecting to Amazon SES (Simple Email Service), follow these steps.

  • Go to the Services tab in the admin console.
  • Click Create.
  • Set the Service Type to AWS SES.
  • Enter a name and label for the service. Name will be part of the URL for accessing the service via the REST API.
  • Go to the Config tab for the new service.
  • Enter your AWS access key, secret key, and region.
  • Click Create Service to save your new service.
  • Go to the API Docs tab in the admin console to test your new service.

Local Email Service

To create a service for connecting to local email, follow these steps.

  • Go to the Services tab in the admin console.
  • Click Create.
  • Set the Service Type to Local Email Service.
  • Enter a name and label for the service. Name will be part of the URL for accessing the service via the REST API.
  • Click Create Service to save your new service.
  • Go to the API Docs tab in the admin console to test your new service.

Note: By default DreamFactory uses 'sendmail' for Local Email Service. You can change this in the .env file by changing the 'MAIL_DRIVER' option. Valid options for 'MAIL_DRIVER' are 'smtp', 'mail', 'sendmail', 'ses', 'mailgun', 'mandrill'. If you choose 'smtp' as Local Email Service driver then see config/mail.php for SMTP configuration. If you choose 'ses', 'mailgun', or 'mandrill' as the driver then see config/services.php for configuration options.

Mailgun Email Service

To create a service for connecting to Mailgun email, follow these steps.

  • Go to the Services tab in the admin console.
  • Click Create.
  • Set the Service Type to Mailgun Email Service.
  • Enter a name and label for the service. Name will be part of the URL for accessing the service via the REST API.
  • Go to the Config tab for the new service.
  • Enter your Mailgun Domain and API Key.
  • Click Create Service to save your new service.
  • Go to the API Docs tab in the admin console to test your new service.

Mandrill Email Service

To create a service for connecting to Mandrill Email Service, follow these steps.

  • Go to the Services tab in the admin console.
  • Click Create.
  • Set the Service Type to 'Mandrill Email Service'.
  • Enter a name and label for the service. Name will be part of the URL for accessing the service via the REST API.
  • Go to the Config tab for the new service.
  • Enter your Mandrill API Key.
  • Click Create Service to save your new service.
  • Go to the API Docs tab in the admin console to test your new service.

SMTP Email Service

To create a service for connecting to a SMTP Email Service, follow these steps.

  • Go to the Services tab in the admin console.
  • Click Create.
  • Set the Service Type to 'SMTP Email Service'.
  • Enter a name and label for the service. Name will be part of the URL for accessing the service via the REST API.
  • Go to the Config tab for the new service.
  • Enter your Host, Port (default: 587), Encryption (default: tls), Username, Password.
  • Click Create Service to save your new service.
  • Go to the API Docs tab in the admin console to test your new service.