/n software Connectors for MuleSoft

Questions / Feedback?

Email Connector

Properties   Configuration Settings  

The Email Component adds SSL-protected email capability to the MuleSoft.

Remarks

The Email Connector provides an all-encompassing email client implementation to your Mule Project. The connector supports both send and receive functionality over multiple protocols.

Email Receive Connector

The Email Receive Connector implements the IMAP and POP3 internet mail protocols. In order to use the Email Receiver connector, you must first select a ServerType. You must also enter a MailServer and User. For servers that require authentication, you will also have to enter a Password.

To activate SSL, you must also select an SSLCert, and set the SSLAcceptServerCert and SSLStartMode. The connector will attempt to determine the correct port to connect to based on the server type and SSL settings. However, you may override the default by directly setting the MailPort in the property pages.

Once you have your port set up, the connector will connect to the server once every PollingInterval and download messages. To control how the messages are downloaded, or to prevent duplicate messages from being fetched from the mail server, you may set the DeleteMode to an appropriate value. For IMAP connections, you may also set a Filter.

The connector will write as much information as it has regarding the emails to various properties in the message context that can be polled at runtime. These include MessageFrom, MessageTo, MessageSubject and MessageHeaders. The message headers may also be included with the message body by setting the IncludeHeaders property to True.

Receive Example

Drag and drop the Email Receive Connector into the source position of a flow. All that is necessary to get started is to configure the connection settings. You can control which messages are downloaded using DeleteMode and Filter.

The connector will handle connecting to the server and downloading a group of emails. One Mule event is generated for each downloaded email. Behind the Email Receive connector additional properties about each message are available in the attributes collection.

Email Send Connector

The Email Send Connector is a complete SMTP client. To send emails from the connector you must set at a minimum your SMTPServer, as well as your From and SendTo email addresses. Should you need to guarantee a secure transmission, you may set the SSLCert and SSLStartMode properties, as well as a specific SSLAcceptServerCert.

You may also add carbon copy and blind carbon copy recipients via the Cc and BCc properties. If you wish to receive delivery or read notifications, you can set the DeliveryReceipt and ReadReceipt properties. You may set the Subject of your message. The contents of the outbound message will be sent as the body of the email.

Send Example

To get started, simply drag the Email Send Connector into your application. All that is necessary to get started is to configure the connection settings. Set the MessageHTML or MessageText property to a string value containing the message to send. That is all that is required to send an email.

Receiver Property List


The following is the full list of the properties of the receiver connector with short descriptions. Click on the links for further details.

AttachmentDirectorySpecifies the directory to which attachments are saved.
AuthModeThe authentication mode to be used when connecting to the MailServer .
DeleteModeControls if and when the email is deleted after download.
FilterA filter to be applied to the inbox when selecting messages.
FirewallA set of properties related to firewall access.
IncludeHeadersInstructs the component to include or ignore message headers.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during component execution.
LogTypeHow information gets logged during component execution.
MailFolderName of the mailbox selected on the server.
MailPortThe port of the mail server (IMAP or POP3).
MailServerThe name or address of the mail server (IMAP or POP3).
MessageCcA comma separated list of addresses for carbon copies.
MessageDateThe date a message was sent.
MessageFromThe email address of the author of the message.
MessageHeadersMessage headers associated with the current email message.
MessageIdThe id of the current message.
MessageNetIdThe globally unique identifier of the message.
MessageSenderThe email address of the sender.
MessageSizeThe size of the current message.
MessageSubjectThe subject of the mail message.
MessageToA comma separated list of addresses for destinations.
OAuthAuthorizationOAuth Authorization Information.
OtherDefines a set of configuration settings to be used by the component.
PasswordA password for login.
PersistentConnectionInstructs the component whether to keep the connection to the server open.
RuntimeLicenseSpecifies the component runtime license key.
ServerTypeThe type of server for your email account.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the component starts the SSL negotiation.
TimeoutA timeout for the component.
UserA user id for login.

Sender Property List


The following is the full list of the properties of the sender connector with short descriptions. Click on the links for further details.

AttachmentsSpecifies which files the component should include as attachments in the outgoing message.
AuthModeThe authentication mode to be used when connecting to the MailServer .
BCcA comma separated list of addresses for blind carbon copies (optional).
CcA comma separated list of addresses for carbon copies (optional).
DeliveryReceiptWhether or not a delivery receipt should be returned to the sender.
FirewallA set of properties related to firewall access.
FromThe email address of the sender (required).
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during component execution.
LogTypeHow information gets logged during component execution.
MessageHTMLThe HTML text of the message.
MessageTextThe text of the mail message (optional).
OAuthAuthorizationOAuth Authorization Information.
OtherDefines a set of configuration settings to be used by the component.
PasswordA password for login.
PersistentConnectionInstructs the component whether to keep the connection to the server open.
ReadReceiptWhether or not a receipt should be sent when the email has been read.
ReplyToA mail address to reply to (optional).
RuntimeLicenseSpecifies the component runtime license key.
SendToA comma separated list of addresses for destinations (required).
SMTPMessageIdThe id of the mail message (optional).
SMTPPortThe server port for SMTP (default 25).
SMTPServerThe name or address of a mail server (mail relay).
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the component starts the SSL negotiation.
SubjectThe subject of the mail message (optional).
TimeoutA timeout for the component.
UserA user id for login.

Configuration Settings


The following is a list of configuration settings for the connector with short descriptions. Click on the links for further details.

AddAttachmentsAsMessagePartsIncludes attachments as additional parts on the message.
AttachmentEncoding[index]Content-Transfer-Encoding for attached file (at index).
AttachmentName[index]Filename for the attached file (at index).
AttachmentNameSourceSpecifies the source location in the MIME entity from which the filename is retrieved.
AutoDecodeHeadersWhether to decode headers.
AutoDecodeMessageTextWhether to decode non-MIME message text.
DuplicateAttachmentActionSpecifies what action to take when a duplicate filename is encountered.
FoldHeadersWhether incoming message headers should be folded.
MaskSensitiveWhether sensitive properties should be masked when logging.
MaxPartsThe maximum number of parts to be parsed from a mime message.
MessageHTMLFileSpecifies a file that will be included as the email's HTML content.
MoveToSpecifies the IMAP folder on the server to which messages will be moved.
ReturnOnlyPlainTextPartSpecifies if the component should return the first plain text part or the entire message.
ReturnPathSets the Return-Path to be used for sending email.
UIDModeIf True, permanent message identifiers will be used instead of temporary identifiers.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
/n software Connectors for MuleSoft - Version 20.0 [Build 8318]