Salesforce

Email Resource (Magic xpi 4.14)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

Email Resource (Magic xpi 4.14)

Email resources contain the following parameters (parameters in bold are mandatory):

Parameter

Description

Server Type

The type of email server. The server type definition is only relevant for incoming mail. Select one of the following from the drop-down list:

  • POP3

  • IMAP

If this field is left blank, SMTP is used as the default.

Incoming Mail Server

Enter the relevant POP3 or IMAP server address. For example, localhost.

You can click to open the Environment Variables List. Here, you can select an environment variable to use as an address.

Incoming Port

The port that the mail server is listening to. Enter the relevant port number. If no value is selected, the defaults are as follows:

  • POP3: The default is 110. For secure connections, the default is 995.

  • IMAP: The default is 143. For secure connections, the default is 993.

You can click (ellipsis button) to open the Environment Variables List. Here, you can select an environment variable to use as the incoming port.

Incoming Secure Connection (SSL)

Specifies if the incoming connection is secured or not. Select one of the following from the drop-down list:

  • No (default)

  • Yes

Outgoing Mail Server

Enter the relevant SMTP server address. For example, localhost.

For sending emails, the only protocol that Magic xpi supports is SMTP, so the Server Type field should be left blank.

You can click to open the Environment Variables List. Here, you can select an environment variable to use as an address.

Outgoing Port

The port that the server is listening to. Enter the relevant port number. If no value is selected, the defaults are as follows:

  • SMTP: The default is 25.

  • SSL: The default is 465.

  • TLS: The default is 587.

You can click to open the Environment Variables List. Here, you can select an environment variable to use as the outgoing port.

Outgoing Secure Connection

Specifies if the outgoing connection is secured or not. Select one of the following from the drop-down list:

  • No (default)

  • SSL

  • TLS

From Address

Enter an email address where you can receive notification emails if the server starts, stops, or an error occurs. For example, postmaster@Magicxpi.com

You can click to open the Environment Variables List. Here, you can select an environment variable to use as an address.

Authentication Type

Select the Authentication Type to be configured that is exposed by Email server.

  • Basic (Default)

  • OAuth 2

    • IMAP (Since version: 4.13.1)

    • SMPT (Since version: 4.13.1)

    • POP3 (Since version: 4.13.6)

User

The user name of the person signed in to the email server.

You can either enter the user name, or click (ellipsis button) to open the Environment Variables List. Here, you can select an environment variable to use as a user name.

Password

The user's password in encrypted format.

You can either enter the password, or click (ellipsis button) to open the Environment Variables List. Here, you can select an environment variable to use as a password.

  • A password entered as an environment variable is masked by asterisks.

  • For Basic authentication, if you are using Gmail as Email provider, you need to generate the App Password and use it in the Password field. A regular email password is not supported. To generate the App Password, follow the steps in the link below:

https://support.google.com/accounts/answer/185833

OAuth Refresh Token Status

Indicates whether a refresh token was successfully obtained when the OAuth 2 authorization process was performed. The possible values are:

  • Missing (Default)

  • Available

Authorization URL

Provide the Authorization endpoint URL to interact with the resource owner to grant access to the protected resource.

Enter the Authorization URL or click (ellipsis button) to open the Environment Variable List. Here, you can select an environment variable to use as an Authorization URL.

Access Token URL

The Access Token endpoint is used by the application in order to get an Access Token or a Refresh Token.

Enter the Access Token URL or click ellipsis button to open the Environment Variable List. Here, you can select an environment variable to use as an Access Token URL.

Callback URL

When requesting Authorization code through Authorization URL, the Callback URL will be passed as value for parameter called redirect_uri. A successful response from Authorization endpoint results in a redirect to this URL.

Enter the Callback URL or click (ellipsis button) to open the Environment Variable List. Here, you can select an environment variable to use as a Callback URL.

Client ID

The ID of the application that asks for authorization. Client ID and Client secret are generated at the time of client registration process at the Authorization server.

Enter the Client ID or click (ellipsis button) to open the Environment Variable List. Here, you can select an environment variable to use as a Client ID.

Client Secret

The secret string provided for the Client ID during the Authorization process.

Enter the Client Secret or click (ellipsis button) to open the Environment Variable List. Here, you can select an environment Variable to use as a Client Secret.

Scope

Scope is an option, in case some Authorization server has defined scope and expecting Scope to be sent while retrieving the OAuth 2 Access/Refresh Token.

Enter the Scope or click (ellipsis button) to open the Environment Variable List. Here, you can select an environment variable to use as a Scope.

State

Some Email Endpoints may require the user to provide the State parameter during the OAuth 2 process. The parameter is usually required for a more secure authentication system. The OAuth 2 authentication may fail if the required state value is missing or incorrect. This is required to prevent Cross Site Request Forgery (CSRF).

Email resources also give you the following button:

Button

Description

Validate

Click this button to verify that the connection to the Email server is valid. You will receive a message indicating that the connection is established, or an error message if the connection failed.

In case of OAuth 2, it will launch the Authorization grant page in the browser window where the you can log in using the registered Email address and provide the access grant to allow the Email component to access the resource on the OAuth 2 Authorization window. As you click, the Allow button, a success message will be given on generating the Acess Token successfully.

The validation of an Email OAuth2 resource does not work using the External Environment Settings.

Reference
Attachment 
Attachment