Get Email

The retrieval of messages from a mail server in a Flow becomes possible through the combined use of the Get Email step and the Get Headers step. These messages can be conveniently displayed as a list on a Form or utilized for various purposes. The retrieval process is supported for both IMAP and POP servers, offering versatility in accessing email data within the Flow.

Properties

Gmail

Output Settings

Inputs

Outputs

Error connecting to IMAP server 'number' by port 'number'. SSL = False

The exception message indicates that there is an issue connecting to the IMAP/POP server with the given configuration. To resolve this, follow these steps:

• Double-check Server and Port Settings
• Enable SSL (Secure Socket Layer)
• Check Network and Firewall Settings
• Verify Credentials

Exception Message:

Exception Stack Trace: DecisionsFramework.Design.Flow.ErrorRunningFlowStep: Error running step Get Email 1[GetEmail] in flow [Display Steps]: Error connecting to imap server '123' by port '143'. SSL = False
 ---> DecisionsFramework.LoggedException: Error connecting to imap server '123' by port '143'. SSL = False
 ---> System.ArgumentException: Hostname is invalid. (Parameter 'serverName'
 at Rebex.Net.Imap.lcdhv(String p0, Int32 p1, TlsParameters p2, SslMode p3
 at Rebex.Net.Imap.Connect(String serverName, Int32 serverPort
 at DecisionsFramework.ServiceLayer.Services.Email.ImapPop3Utility.OpenImapConnection(ConnectionData conn)
   --- End of inner exception stack trace --- at DecisionsFramework.ServiceLayer.Services.Email.ImapPop3Utility.OpenImapConnection(ConnectionData conn
 at DecisionsFramework.Design.Flow.CoreSteps.EMail.Imap.BaseImapStep.Run(StepStartData data
 at DecisionsFramework.Design.Flow.FlowStep.RunStepInternal(String flowTrackingID, String stepTrackingID, KeyValuePairDataStructure[] stepRunDataValues, AbstractFlowTrackingData trackingData
 at DecisionsFramework.Design.Flow.FlowStep.Start(String flowTrackingID, String stepTrackingID, FlowStateData data, AbstractFlowTrackingData trackingData, RunningStepData currentStepData)
   --- End of inner exception stack trace ---

Example Use Case

Using the Get Email step alongside the Get Headers step, a Flow can retrieve messages from a mail server. Messages can be displayed as a list on a Form or used in other ways and be retrieved from either an IMAP or POP server.

The following example will retrieve a specific message from a Gmail account and display the list in a Form using IMAP. This example can also work for a POP mail server, replacing the IMAP steps with its POP equivalent.

1. In a Designer Folder, create a new Flow.
2. In the Toolbox, expand Communication > Email > IMAP and select the Get Headers step, and add it to the workspace.  
3. On the Properties tab for the Get Headers step, enter "10" for the Count field, the appropriate Username, and Password, enter "993" for Port, enter "imap.gmail.com" for Server, and select the checkbox for Secure Connection.
    
4. In the Toolbox, navigate to Communication > Email > IMAP.  and add the Get Email step to the workspace.
5. On the Properties tab for the Get Email step, map the same Gmail Server credentials to the inputs. For Unique Id, map Headers.All UniqueId.First.
   
   The Get Email step uses a Unique Id to retrieve the full message from an Email. This field works on the assumption that previous steps may output more than one Message Header to get a certain message category.
6. On the Found path. add a Show Form step. Connect the Not Found path to the End step.
7. Select the Show Form step and create a new Form.
8. Configure the Form with a Text Box Multi Line and Button control. Click Save and close the Form Designer.
   
9. With the Show Form step selected, on the Properties panel click Unknown and select Select From Flow. Select Message as the input. 
   

Debug

1. Click Debug from the top action bar. Click START DEBUGGING. A Form displays the details of a single Message downloaded from the Gmail Account.

   
   

Step Changes