Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
View email server default settings for a mail driver to work within server mail apps.
The Send Email package must be installed.
Your user account or group membership must have the "Settings: View Settings" permission to view email server default settings unless your user account has the Make this user a Super Admin setting selected.
See the Settings permissions or ask your Administrator for assistance.
Follow these steps to view the email server default settings:
Ensure that you are logged on to ProcessMaker Platform.
Click the Admin option from the top menu. The Users page displays.
Click the Email Default Settings tab. The Email Default Settings tab displays all email server default settings.
The Email Default Settings tab displays the following information in tabular format about the email server default settings:
Setting: The Setting column displays the name of the default email server settings.
Configuration: The Configuration column displays the setting value and how it is configured.
Use the Search setting to filter email server settings that display.
Click the +Mail Server button. See Create a New Email Server Configuration.
Click the -Remove Server button. See Delete an Email Server Configuration.
Click the Settings iconfrom the left sidebar. The Settings page displays a tab for each setting.
Click the Edit icon. See Edit an Email Server Configuration.
Click the Copy to Clipboard icon. See Copy an Email Server Setting.
Click the Clear icon. See Clear an Email Server Setting.
Manage your email default settings.
Filter all email settings in an email server configuration to find that one you need.
Use the Search function to filter all email server settings from the Email Default Setting tab or any custom email server's configuration based on your entered text.
The Send Email package must be installed.
Your user account or group membership must have the "Settings: View Settings" permission to search email server settings unless your user account has the Make this user a Super Admin setting selected.
See the Settings permissions or ask your Administrator for assistance.
Follow these steps to search for an email server setting:
​View your Email Default Settings. The Email Default Settings tab displays.
Locate the custom email server setting's tab if not searching from the default email server settings.
In the Search setting, enter the Setting name to filter settings in that email server's configuration.
Edit an email server configuration.
The Send Email package must be installed.
Your user account or group membership must have the "Settings: Update Settings" permission to edit an email server's configuration unless your user account has the Make this user a Super Admin setting selected.
See the Settings permissions or ask your Administrator for assistance.
As part of creating a new email server configuration, the new email server settings display in one of the following locations in the Settings page:
A new tab displays adjacent to the Email Default Settings tab if no other custom email server configurations have been created. The new tab is labeled by default Email Server 1.
A new tab displays adjacent to the last custom email server configuration's tab. The new tab is labeled by default Email Server X, where X is the total number of custom email server configurations created.
Follow these steps to create or edit an email server configuration:
View your email server default settings. The Email Default Settings tab displays.
Do one of the following:
Create a new email server configuration: Click on the +Mail Server button at the top of the Email Default Settings tab or any custom email server configuration's tab. A new tab displays either adjacent to the Email Default Settings tab or the last custom email server configuration's tab.
Edit an email server configuration: Locate the email server configuration to edit.
Optionally, change the name of this email server's alias name. Follow these steps:
Change the name for this email server's alias, and then click on Save.
Optionally, change which mail driver this email server uses. Follow these steps:
Select one of the following options that represent supported mail drivers:
smtp: Click on the smtp option to use the SMTP mail driver.
sendmail: Click on the sendmail option to use the Sendmail mail driver.
mailgun: Click on the mailgun option to use the Mailgun mail driver.
postmark: Click on the postmark option to use the Postmark mail driver.
ses: Click on the ses option to use the Amazon SES mail driver.
Click Save. Subsequent settings for that email server change based on the selected mail driver. See the appropriate topic for your selected mail driver:
Configure Simple Email Service (SES) mail driver protocol settings for your email server.
See the following example containing an Amazon SES mailer driver.
To configure an Amazon SES email server, the following information is needed:
Amazon access key ID
Amazon secret access key
Amazon default region
Configure the following Amazon SES settings as necessary:
Select the ses option, and then click Save. The settings for Amazon SES email server display.
Enter your Amazon access key ID, and then click Save.
Enter your Amazon secret access key, and then click Save.
Enter your Amazon region, and then click Save.
Enter the email address that this server uses to send emails, and then click Save.
Enter the person or company name that sends the email, and then click Save.
Consider the following example that stores all settings for an Amazon SES mail server configuration:
Mailer driver: ses
Amazon Access Key ID: AmazonExampleID
Amazon Secret Access Key: ••••••••••••••••••
Amazon Default Region
: us-west-2
Sender Email: LouisCanera@BigCompany.com
Sender Name: LouisCanera
Configure Google Gmail driver protocol settings for your email server.
Google Gmail is one of the most widely use email services in the world. Configure an email server to authenticate with Gmail Simple Mail Transfer Protocol (SMTP) from which to send emails.
See the following example containing a Gmail mailer driver.
Refer to the following sections in this order to configure an email server for Gmail SMTP authentication:
Follow these steps to enable SMTP authentication for the Gmail email server settings:
Select the tls option if it is not currently selected. Click Save if you changed this setting.
Enter 587
, and then click Save.
Enter smtp.gmail.com
, and then click Save.
From the Gmail Redirect URI setting, copy the redirect URI for creating the Gmail SMTP OAuth integration. This redirect URI is automatically configured for this email server after selecting the SMTP Authentication Method setting. Google calls back to this URL after Google authenticates a valid Google app in ProcessMaker Platform.
Follow these steps to create Google credentials for the Gmail email server's OAuth client:
In the Name setting, enter a name for the credential. This name displays only in the Google Cloud console.
The URIs 1 setting displays to enter a valid URI from a Web server.
In the URIs 1 setting, enter the Gmail Redirect URI copied from your ProcessMaker Platform instance.
Click Create at the bottom of the page. Note that it may take between five (5) minutes to a few hours for Google Cloud to enable this OAuth client.
From the Your Client ID setting, copy the client ID, and then save it for later configuration in the Gmail email server.
From the Your Client Secret setting, copy the client secret, and then save it for later configuration in the Gmail email server.
Click OK to close the OAuth client created screen.
Follow these steps to authorize the Google account for the Gmail SMTP OAuth integration:
Ensure the following:
In the ProcessMaker settings, access the email server configured for the Gmail SMTP OAuth integration.
Enter the client ID copied from the Google Cloud OAuth client.
Enter the client secret copied from the Google Cloud OAuth client.
Select the Google account with which to allow the Google OAuth client to access your Gmail email server.
Configure Microsoft Office 365 driver protocol settings for your email server.
Microsoft Office 365 is one of the most widely use email services in the world. Configure an email server to authenticate with Office 365 Simple Mail Transfer Protocol (SMTP) from which to send emails.
See the following example containing a Office 365 mailer driver.
Refer to the following sections in this order to configure an email server for Office 365 SMTP authentication:
Follow these steps to enable SMTP authentication for the Office 365 email server settings:
Select the tls option if it is not currently selected. Click Save if you changed this setting.
Enter 587
, and then click Save.
Enter smtp.office365.com
, and then click Save.
From the Office 365 Redirect URI setting, copy the redirect URI for creating the Office 365 SMTP OAuth integration. This redirect URI is automatically configured for this email server after selecting the SMTP Authentication Method setting. Microsoft calls back to this URL after Microsoft authenticates a valid Azure Active Directory (Azure AD) application in ProcessMaker.
SMTP authentication must be enabled in Microsoft 365 Admin Center so the Microsoft email address configured in the email server can send emails. Otherwise, Microsoft 365 will block requests to the SMTP server.
Follow these steps to enable SMTP authentication in Microsoft 365 Admin Center:
The list of active users in your Microsoft 365 account displays.
Select the Mail tab for within that user's information.
Select the Authenticated SMTP option if it is not already selected. Click the Save changes button if you enabled this option.
Follow these steps to create a Microsoft Azure Active Directory (Azure AD) application:
Ensure the following:
The App registrations page displays.
In the Name setting, enter a name for this application. This is a required setting.
From the Supported account types setting, select which account type this application will support for your organization. If unsure, keep the default Accounts in this organizational directory only (FormShare only - Single tenant) option.
From the Redirect URI (optional) setting, do the following:
To the right of the Select a platform setting, enter the Office 365 redirect URI copied from your ProcessMaker instance.
From the Essentials section, click the Copy to Clipboard icon to copy beside the Application (Client) ID, and then save it for later configuration in the Office 365 email server.
From the Essentials section, click the Copy to Clipboard icon to copy beside the Directory (Tenant) ID, and then save it for later configuration in the Office 365 email server.
The Certificates & secrets page for this Azure AD application displays.
In the Description setting, enter a description for how this client secret will be used.
From the Expires setting, select at which date this client secret expires. After this date, a new client secret should be generated and updated in the PM4 instance 30 days before it is set to expire.
Click Add. A new client secret generates.
Follow these steps to authorize the Office 365 account for the Office 365 SMTP OAuth integration:
Ensure the following:
In the ProcessMaker settings, access the email server configured for the Office 365 SMTP OAuth integration.
Enter the Office 365 tenant ID copied from the Azure AD application.
Enter the Office 365 client ID copied from the Azure AD application.
Enter the Office 365 client secret copied from the Azure AD application.
Select the email address configured to send emails from the email server.
Click the Search iconor press enter. The email server settings display that match your entered text.
Click the Editicon for the Mailer alias name setting. The Mailer alias name screen displays.
Click the Editicon for the Mailer driver setting. The Mailer driver screen displays.
Simple Email Service (SES) is a cost-effective, flexible, and scalable email service that enables developers to send mail from any application. A widely used service in this category is .
The must be installed.
See the permissions or ask your Administrator for assistance.
To generate or locate your Amazon access key ID and secret access key, refer to . For details on Amazon regions, refer to .
. The settings for the new email server display. By default smtp is selected as the mailer driver.
Click the Edit icon for the Mailer driver setting. The Mailer driver screen displays.
Click the Edit icon for the Amazon Access Key ID setting. The Amazon Access Key ID screen displays.
Click the Edit icon for the Amazon Secret Access Key setting. The Amazon Secret Access Key screen displays.
Click the Edit icon for the Amazon Default Region setting. The Amazon Default Region screen displays.
Click the Edit icon for the Sender Email setting. The Sender Email screen displays.
Click the Edit icon for the Sender Name setting. The Sender Name screen displays.
.
The must be installed.
See the permissions or ask your Administrator for assistance.
.
.
.
. Email server settings display. The settings for the new email server display.
Click the SMTP Authentication Method setting. The SMTP Authentication Method screen displays.
Select the google option, and then click Save. The settings for the Gmail email server display. Until providing the Gmail client ID and Gmail client secret, the label Not Authorized displays in the SMTP Authentication Method setting.
Click the Edit icon for the Use Secure Connection setting. The Use secure connection screen displays.
Click the Edit icon for the Server Port setting. The Server Port screen displays.
Click the Edit icon for the Server Host setting. The Server Host screen displays.
.
.
Log on to .
From the Google Cloud menu, click APIs & Services, and then Credentials.
The Credentials page displays.
Click +Create Credentials, and then select the OAuth client ID option.
The Create OAuth client ID page displays.
Click the Application type drop-down menu, and then select the Web application option.
From the Authorized redirect URIs section, click the +Add URI button to allow requests from a Web browser.
The OAuth client created screen displays with the client ID and client secret for this Gmail SMTP OAuth integration with your ProcessMaker Platform instance.
.
.
.
Click the Edit icon for the Gmail Client ID setting. The Gmail Client ID screen displays.
Click the Edit icon for the Gmail Client Secret setting. The Gmail Client Secret screen displays.
Click the Authorize Account button at the top of the email server settings. The Sign in with Google screen displays.
Click the Allow button to grant authorization.
If the Google SMTP OAuth integration is configured correctly on your email server settings, then the email server settings display again, and the SMTP Authentication Method setting indicates that Google authorized this email server to use the Google Cloud Web application.
.
The must be installed.
See the permissions or ask your Administrator for assistance.
.
.
.
.
. Email server settings display. The settings for the new email server display.
Click the SMTP Authentication Method setting. The SMTP Authentication Method screen displays.
Select the office365 option, and then click Save. The settings for the Office 365 email server display. Until providing the Office 365 client ID and Office 365 client secret, the label Not Authorized displays in the SMTP Authentication Method setting.
Click the Edit icon for the Use Secure Connection setting. The Use secure connection screen displays.
Click the Edit icon for the Server Port setting. The Server Port screen displays.
Click the Edit icon for the Server Host setting. The Server Host screen displays.
.
.
Log on to .
From the menu icon in the upper-left, select Users, then the Active users option.
Select the active user from whom to send emails from the email server. Details about that user display in the right-side panel.
From the Email apps column, select the Manage email apps link.
The Manage email apps screen displays.
.
.
.
Log on the with the Microsoft email address configured on Microsoft Office 365 Admin Center.
Search for, and then select the App registrations service.
Below the App registrations page title, click the +New registration button.
The Register an application page displays.
From the Select a platform setting, select the Web option.
Click the Register button. The Azure platform creates the Azure AD application, and then displays information about the application.
From the Manage left-side menu, select the Certificates & secrets option.
Click the +New client secret button.
The Add a client secret screen displays.
Click the Copy to Clipboard icon to copy the client secret value, in the middle column, and then save it for later configuration in the Office 365 email server. Ensure to copy this client secret before refreshing or leaving this page.
.
.
.
.
Click the Edit icon for the Office 365 Tenant ID setting. The Office 365 Tenant ID screen displays.
Click the Edit icon for the Office 365 Client ID setting. The Office 365 Client ID screen displays.
Click the Edit icon for the Office 365 Client Secret setting. The Office 365 Client Secret screen displays.
Click the Authorize Account button at the top of the email server settings. The Pick an account screen displays.
Select the Consent on behalf of your organization checkbox if the Permissions requested screen displays, and then click the Accept button.
If the Office 365 SMTP OAuth integration is configured correctly on your email server settings, then the email server settings display again, and the SMTP Authentication Method setting indicates that Microsoft authorized this email server to use the Azure AD app.
.
Configure Postmark mail driver protocol settings for your email server.
A Postmark is a fast and reliable application email service and trusted provider for application email needs. Follow Postmark to know more about the process of sending an email with an API.
See the following example containing a Postmark mailer driver.
The Send Email package must be installed.
Your user account or group membership must have the "Settings: Update Settings" permission to edit email server settings unless your user account has the Make this user a Super Admin setting selected.
See the Settings permissions or ask your Administrator for assistance.
To configure a Postmark email server, the Postmark token is required.
To generate or locate this information, see What are the Account and Server API Tokens, and SMTP Tokens?
Configure the following Postmark settings as necessary:
Create a new email server configuration. The settings for the new email server display. By default smtp is selected as the mailer driver.
Select the postmark option, and then click Save. The settings for the Postmark email server display.
Enter your Postmark token, and then click Save.
Enter the email address that this server uses to send emails, and then click Save.
Enter the person or company name that sends the email, and then click Save.
Consider the following example that stores all settings for a Postmark mail server configuration:
Mailer driver: postmark
Postmark token
: •••••••••••••••••••••
Sender Email: LouisCanera@BigCompany.com
Sender Name: LouisCanera
Configure Sendmail mailer driver protocol settings for your email server.
Sendmail is an open source software that uses the Simple Mail Transfer Protocol (SMTP) protocol to send emails. The Sendmail application must be installed on your server before you can use it as a mailer driver in ProcessMaker Platform. For more information on Sendmail, refer to Sendmail Open Source.
See the following example containing a configured Sendmail mailer driver.
The Send Email package must be installed.
Your user account or group membership must have the "Settings: Update Settings" permission to edit email server settings unless your user account has the Make this user a Super Admin setting selected.
See the Settings permissions or ask your Administrator for assistance.
The Sendmail application must be installed before making these configurations.
Configure the following Sendmail settings as necessary:
Create a new email server configuration. The settings for the new email server display. By default smtp is selected as the mailer driver.
Select the sendmail option, and then click Save. The settings for the Sendmail email server display.
Enter the email address that this server uses to send emails, and then click Save.
Enter the person or company name that sends the email, and then click Save.
Consider the following example for a Sendmail mailer server configuration:
Mailer driver: sendmail
Sender Email: LouisCanera@BigCompany.com
Sender Name: LouisCanera
Configure Simple Mail Transfer Protocol (SMTP) mailer driver protocol settings for your email server.
Simple Mail Transfer Protocol (SMTP) is an internet standard communication protocol for electronic email transmission. Configure the SMTP email server to use a secure or insecure connection.
See the following example containing a configured SMTP email server.
The Send Email package must be installed.
Your user account or group membership must have the "Settings: Update Settings" permission to edit email server settings unless your user account has the Make this user a Super Admin setting selected.
See the Settings permissions or ask your Administrator for assistance.
If configuring SMTP with a Gmail service, as a best practice, configure the User Account setting with the same value as in the Sender Email setting.
To configure a Simple Mail Transfer Protocol (SMTP) mailer driver, the following information is needed:
SMTP server host name
SMTP server port
SMTP account username and password
Configure the following SMTP settings as necessary:
Create a new email server configuration. The settings for the new email server display. By default smtp is selected as the mailer driver and the settings for the SMTP email server display.
Enter the email address that this server uses to send emails, and then click Save.
Enter the person or company name that sends the email, and then click Save.
Enter the host SMTP application or service, and then click Save.
Enter the port number that this email server uses, and then click Save.
Select one of the following connection protocols options that this SMTP email server uses to send and receive emails:
no: Use no secure connection.
tls: Use Transport Layer Security (TLS). This is the default option.
ssl: Use Secure Sockets Layer (SSL) protocol.
Enter an active user account the SMTP email server uses, and then click Save.
Click Save.
Consider the following example for an SMTP mail server configuration:
Mailer driver: smtp
Sender Email: LouisCanera@BigCompany.com
Sender Name: LouisCanera
Server Host: smtp.mailtrap.io
Server Port: 25
Use secure connection: tls
User Account: c5ad636d522571
User Password
: •••••••••••••••••••••
Clear the value from an email server setting.
Clearing an email server setting cannot be undone.
Follow these steps to clear the value of an email server setting:
Locate the custom email server setting's tab if not clearing a value from the default email server settings.
Delete an email server configuration from the Settings page.
Only custom email server configurations may be deleted. The default email server configuration cannot be deleted.
Deleting an email server cannot be undone.
Follow these steps to delete an email server configuration:
Locate the custom email server setting's tab from which to remove its configuration.
Click Confirm. The email server configuration is deleted and does not display as a setting tab in the Settings page.
Copy to clipboard an email server setting.
Copy to clipboard an email server setting to have this information in another environment or for testing purposes.
Follow these steps to copy an email server setting:
Locate the custom email server setting's tab if not copying from the default email server settings.
Send a test email to ensure that your email server configuration sends emails correctly.
Send a test email using an email server configuration to ensure that your email server configuration sends emails correctly.
Follow these steps to send a test email using an email server configuration:
Locate the custom email server setting's tab if not testing the default email server settings.
In the Recipient's email address setting, enter the valid email address to send the test email. This is a required setting.
Click Test. Any errors that occur display below the Recipient's email address setting. If no errors display, review the Inbox for the email address to which the test email was sent.
Click the Edit icon for the Mailer driver setting. The Mailer driver screen displays.
Click the Edit icon for the Postmark token setting. The Postmark token screen displays.
Click the Edit icon for the Sender Email setting. The Sender Email screen displays.
Click the Edit icon for the Sender Name setting. The Sender Name screen displays.
Click the Edit icon for the Mailer driver setting. The Mailer driver screen displays.
Click the Edit icon for the Sender Email setting. The Sender Email screen displays.
Click the Edit icon for the Sender Name setting. The Sender Name screen displays.
Click the Edit icon for the Sender Email setting. The Sender Email screen displays.
Click the Edit icon for the Sender Name setting. The Sender Name screen displays.
Click the Edit icon for the Server Host setting. The Server Host screen displays.
Click the Edit icon for the Server Port setting. The Server Port screen displays.
Click the Edit icon for the Use secure connection setting. The Use secure connection screen displays.
Click the Edit icon for for the User Account setting. The User Account screen displays.
Click the Edit icon for the User Password setting. The User Password screen displays.
Enter the password corresponding with the user account that this SMTP email server uses. The password is masked by default. Optionally, click the View Password iconto view the entered password; thereafter, click the Hide Password iconto hide the entered password.
The must be installed.
See the permissions or ask your Administrator for assistance.
. The LDAP tab displays.
Click the Clear iconfor your email server setting. The following message displays: The setting was updated.
The must be installed.
See the permissions or ask your Administrator for assistance.
. The Email Server settings tab displays.
Click the -Remove Server button. The following message displays: Are you sure you want to delete this item?
The must be installed.
See the permissions or ask your Administrator for assistance.
​. The Email Default Settings tab displays.
Click the Copy to Clipboard iconfor your email server setting to copy. The following message displays: The setting was copied to your clipboard.
The must be installed.
See the permissions or ask your Administrator for assistance.
. The LDAP tab displays.
Click the Send Test Email button. The Testing Email Server screen displays.
Configure Mailgun mail driver protocol settings for your email server.
Mailgun requires that your email server be registered with their service. Therefore, prior to configuring your email server to use Mailgun, ensure that have registered with their service and you have received the Mailgun domain name and secret for your email server.
See the following example containing a Mailgun mailer driver.
To configure a Mailgun email server, the following information is needed:
Mailgun secret
Mailgun domain
Configure the following Mailgun settings as necessary:
Select the mailgun option, and then click Save. The settings for the Mailgun email server display.
Enter your Mailgun domain, and then click Save.
Enter your Mailgun secret, and then click Save.
Enter the email address that this server uses to send emails, and then click Save.
Enter the person or company name that sends the email, and then click Save.
Consider the following example for a Mailgun mail server configuration:
Mailer driver: mailgun
Mailgun Domain: BigCompany.mailgun.org
Mailgun Secret
: •••••••••••••••••••••
Sender Email: LouisCanera@BigCompany.com
Sender Name: LouisCanera
is a transactional email service used by developers and information technology professionals to send, receive, and track emails using its powerful Application Program Interface (API).
The must be installed.
See the permissions or ask your Administrator for assistance.
To generate or locate this information, refer to
. The settings for the new email server display. By default smtp is selected as the mailer driver.
Click the Edit icon for the Mailer driver setting. The Mailer driver screen displays.
Click the Edit icon for the Mailgun Domain setting. The Mailgun Domain screen displays.
Click the Edit icon for the Mailgun Secret setting. The Mailgun Secret screen displays.
Click the Edit icon for the Sender Email setting. The Sender Email screen displays.
Click the Edit icon for the Sender Name setting. The Sender Name screen displays.
.