EMAIL - Revision history

Dgarratt: /* EMAIL Map Configuration */

2024-12-30T13:33:13Z

EMAIL Map Configuration

← Older revision		Revision as of 15:33, 30 December 2024
Line 3:		Line 3:
	'''config.xml'''		'''config.xml'''
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<map id~~="map02"~~ enabled~~="Y"~~ description="Email ~~Send PDF"~~>		<map>
	<input id="in1" description="Read File">		<id>Map05</id>
	<type>EMAIL</type>		<enabled>true</enabled>
	<~~mask>pdf</mask~~>		<description>Send File via Email</description>
	<path>./interface/input/~~421 (GEN Email Send)~~</path>		<enableEmailNotifications>true</enableEmailNotifications>
	<pollingInterval>~~2000~~</pollingInterval>		<connectors>
	</input>		<input>
	<output id="out1" enabled~~="Y"~~ description~~="Send~~ Email">		<id>in1</id>
	<path>./interface/output/~~421 (GEN Email Send)~~</path>		<description>Read File</description>
	<~~type~~>~~EMAIL~~</~~type~~>		<type>EMAIL</type>
	<subject>Test ~~email of PDF document~~</subject>		<url>
	<message>~~PDF~~ Attached.</message>		<path>./interface/input/Map05 File to EMAIL</path>
	<~~emailListID~~>~~PDF~~</~~emailListID~~>		<mask/>
	</~~output~~>		<prefix/>
	</map>		<pollingInterval>1000</pollingInterval>
			</url>
			</input>
			<output>
			<id>out1</id>
			<enabled>true</enabled>
			<description>Email File</description>
			<type>EMAIL</type>
			<url>
			<path>./interface/output/Map05 File to EMAIL</path>
			<prefix/>
			<fileExtension/>
			<use83GUID>false</use83GUID>
			</url>
			<email>
			<emailListID>Excel</emailListID>
			<subject>Test Email</subject>
			<message>See Attached File</message>
			</email>
			</output>
			</connectors>
			</map>
	</syntaxhighlight>		</syntaxhighlight>

Dgarratt at 09:26, 25 August 2024

2024-08-25T09:26:13Z

← Older revision		Revision as of 11:26, 25 August 2024
Line 1:		Line 1:
			[[Category: Middleware4j]]
	=EMAIL Map Configuration=		=EMAIL Map Configuration=
	'''config.xml'''		'''config.xml'''

Dgarratt at 19:03, 24 August 2024

2024-08-24T19:03:53Z

← Older revision		Revision as of 21:03, 24 August 2024
Line 28:		Line 28:

	Rather than putting email addresses in the middleware config directly the output map lets you specify a distribution list		Rather than putting email addresses in the middleware config directly the output map lets you specify a distribution list
			<syntaxhighlight lang="xml">
	<emailListID>PDF</emailListID>		<emailListID>PDF</emailListID>
			</syntaxhighlight>
	The email addressed associated with the emailListID are held in the email.xml configuration file. See [[Email Configuration]] for additional information on this file.		The email addressed associated with the emailListID are held in the email.xml configuration file. See [[Email Configuration]] for additional information on this file.

	=EMAIL Settings=		=EMAIL Settings=
	'''email.xml'''		'''email.xml'''
			<syntaxhighlight lang="xml">
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<emailSettings>		<emailSettings>
Line 60:		Line 63:
	</distributionList>		</distributionList>
	</emailSettings>		</emailSettings>
			</syntaxhighlight>

	You will see there are several '''distributionList''' entries above and you can create new ones if you want. Each section has the following attributes.		You will see there are several '''distributionList''' entries above and you can create new ones if you want. Each section has the following attributes.
Line 93:		Line 97:

	===SMTP No Authentication Example===		===SMTP No Authentication Example===
			<syntaxhighlight lang="xml">
	<configuration>		<configuration>
	<property name="mail.smtp.starttls.enable" value="false"/>		<property name="mail.smtp.starttls.enable" value="false"/>
Line 105:		Line 110:
	<property name="mail.debug" value="true"/>		<property name="mail.debug" value="true"/>
	</configuration>		</configuration>
			</syntaxhighlight>

	===Microsoft smtp.live.com Example===		===Microsoft smtp.live.com Example===
			<syntaxhighlight lang="xml">
	<configuration0>		<configuration0>
	<property name="mail.smtp.auth" value="true"/>		<property name="mail.smtp.auth" value="true"/>
Line 120:		Line 127:
	<property name="mail.debug" value="true"/>		<property name="mail.debug" value="true"/>
	</configuration0>		</configuration0>
			</syntaxhighlight>

	===Google gmail Example===		===Google gmail Example===
			<syntaxhighlight lang="xml">
	<configuration1>		<configuration1>
	<property name="mail.smtp.auth" value="true"/>		<property name="mail.smtp.auth" value="true"/>
Line 135:		Line 144:
	<property name="mail.debug" value="true"/>		<property name="mail.debug" value="true"/>
	</configuration1>		</configuration1>
			</syntaxhighlight>

Dgarratt at 19:02, 24 August 2024

2024-08-24T19:02:08Z

← Older revision		Revision as of 21:02, 24 August 2024
Line 1:		Line 1:
	=EMAIL Map Configuration=		=EMAIL Map Configuration=
	'''config.xml'''		'''config.xml'''
			<syntaxhighlight lang="xml">
	<map id="map02" enabled="Y" description="Email Send PDF">		<map id="map02" enabled="Y" description="Email Send PDF">
	<input id="in1" description="Read File">		<input id="in1" description="Read File">
Line 16:		Line 17:
	</output>		</output>
	</map>		</map>
			</syntaxhighlight>

	The email connector provides an automated method of sending files via email. It's currently a "send only" connector so it does not have the ability to check for incomming emails.		The email connector provides an automated method of sending files via email. It's currently a "send only" connector so it does not have the ability to check for incomming emails.

	If we look at the example configuration above we can see that both the input and output types are defined as		If we look at the example configuration above we can see that both the input and output types are defined as
			<syntaxhighlight lang="xml">
	<type>EMAIL</type>		<type>EMAIL</type>
			</syntaxhighlight>
	The way the system works is that you specify a folder and file type (mask) that you want to detect on the input connector side and the destination / subject / message on the output side.		The way the system works is that you specify a folder and file type (mask) that you want to detect on the input connector side and the destination / subject / message on the output side.

Dgarratt at 17:53, 24 August 2024

2024-08-24T17:53:53Z

← Older revision		Revision as of 19:53, 24 August 2024
Line 88:		Line 88:
	=Example Email Settings=		=Example Email Settings=

	==SMTP No Authentication Example==		===SMTP No Authentication Example===
	<configuration>		<configuration>
	<property name="mail.smtp.starttls.enable" value="false"/>		<property name="mail.smtp.starttls.enable" value="false"/>
Line 102:		Line 102:
	</configuration>		</configuration>

	==Microsoft smtp.live.com Example==		===Microsoft smtp.live.com Example===
	<configuration0>		<configuration0>
	<property name="mail.smtp.auth" value="true"/>		<property name="mail.smtp.auth" value="true"/>
Line 117:		Line 117:
	</configuration0>		</configuration0>

	==Google gmail Example==		===Google gmail Example===
	<configuration1>		<configuration1>
	<property name="mail.smtp.auth" value="true"/>		<property name="mail.smtp.auth" value="true"/>

Dgarratt: /* Example Email Settings */

2024-08-24T17:53:23Z

Example Email Settings

← Older revision		Revision as of 19:53, 24 August 2024
Line 88:		Line 88:
	=Example Email Settings=		=Example Email Settings=

	SMTP No Authentication Example		==SMTP No Authentication Example==
	<configuration>		<configuration>
	<property name="mail.smtp.starttls.enable" value="false"/>		<property name="mail.smtp.starttls.enable" value="false"/>
Line 102:		Line 102:
	</configuration>		</configuration>

	Microsoft smtp.live.com Example		==Microsoft smtp.live.com Example==
	<configuration0>		<configuration0>
	<property name="mail.smtp.auth" value="true"/>		<property name="mail.smtp.auth" value="true"/>
Line 117:		Line 117:
	</configuration0>		</configuration0>

	Google gmail Example		==Google gmail Example==
	<configuration1>		<configuration1>
	<property name="mail.smtp.auth" value="true"/>		<property name="mail.smtp.auth" value="true"/>

Dgarratt: /* Example Email Settings */

2024-08-24T17:52:55Z

Example Email Settings

← Older revision		Revision as of 19:52, 24 August 2024
Line 87:		Line 87:

	=Example Email Settings=		=Example Email Settings=
	~~<!--~~ SMTP No Authentication Example ~~-->~~
			SMTP No Authentication Example
	<configuration>		<configuration>
	<property name="mail.smtp.starttls.enable" value="false"/>		<property name="mail.smtp.starttls.enable" value="false"/>
Line 101:		Line 102:
	</configuration>		</configuration>

			Microsoft smtp.live.com Example
	~~<!--~~ Microsoft smtp.live.com Example ~~-->~~
	<configuration0>		<configuration0>
	<property name="mail.smtp.auth" value="true"/>		<property name="mail.smtp.auth" value="true"/>
Line 117:		Line 117:
	</configuration0>		</configuration0>

	~~<!--~~ Google gmail Example ~~-->~~		Google gmail Example
	<configuration1>		<configuration1>
	<property name="mail.smtp.auth" value="true"/>		<property name="mail.smtp.auth" value="true"/>

Dgarratt: /* Distribution List Settings */

2024-08-24T17:51:16Z

Distribution List Settings

← Older revision		Revision as of 19:51, 24 August 2024
Line 66:		Line 66:

	=Distribution List Settings=		=Distribution List Settings=
	\| Element \| Value \| Description \|
	\| - \|- \| :~~- \|~~
	\| id \| id \| A identification which can be used in a mapping file. The email.xml can have multiple distribution lists but each one must have a unique id.\|		{\| class="wikitable" style="margin:auto"
	\| description \| string \| ~~Meaningfull~~ description of what the distribution list is for. \|		\|+ System Keys
	\| enabled \| Y or N \| A simple way to disable or enable a list. \|		\|-
	\| maxFrequencyMins \| nnn \| Number of minutes between identical emails. This can prevent or limit the number of emails which can be sent due to a persistent error condition. \|		! Element !! Value !! Description
	\| toAddressList \| email \| Email addresses separated with a comma \|		\|-


			\| style="width: 150px"\|id \|\| style="width: 90px"\|id \|\| A identification which can be used in a mapping file. The email.xml can have multiple distribution lists but each one must have a unique id.
			\|-
			\| description \|\| string \|\| Meaningful description of what the distribution list is for.
			\|-
			\| enabled \|\| Y or N \|\| A simple way to disable or enable a list.
			\|-
			\| maxFrequencyMins \|\| nnn \|\| Number of minutes between identical emails. This can prevent or limit the number of emails which can be sent due to a persistent error condition.
			\|-
			\| toAddressList \|\| email \|\| Email addresses separated with a comma
			\|}

	=Example Email Settings=		=Example Email Settings=

Dgarratt: Created page with "=EMAIL Map Configuration= '''config.xml''' EMAIL pdf ./interface/input/421 (GEN Email Send) 2000 ./interface/output/421 (GEN Email Send)..."

2024-08-24T17:47:50Z

Created page with "=EMAIL Map Configuration= '''config.xml''' <map id="map02" enabled="Y" description="Email Send PDF"> <input id="in1" description="Read File"> <type>EMAIL</type> <mask>pdf</mask> <path>./interface/input/421 (GEN Email Send)</path> <pollingInterval>2000</pollingInterval> </input> <output id="out1" enabled="Y" description="Send Email"> <path>./interface/output/421 (GEN Email Send)</path>..."

New page

=EMAIL Map Configuration=
'''config.xml'''
<map id="map02" enabled="Y" description="Email Send PDF">
<input id="in1" description="Read File">
<type>EMAIL</type>
<mask>pdf</mask>
<path>./interface/input/421 (GEN Email Send)</path>
<pollingInterval>2000</pollingInterval>
</input>
<output id="out1" enabled="Y" description="Send Email">
<path>./interface/output/421 (GEN Email Send)</path>
<type>EMAIL</type>
<subject>Test email of PDF document</subject>
<message>PDF Attached.</message>
<emailListID>PDF</emailListID>
</output>
</map>

The email connector provides an automated method of sending files via email. It's currently a "send only" connector so it does not have the ability to check for incomming emails.

If we look at the example configuration above we can see that both the input and output types are defined as
<type>EMAIL</type>
The way the system works is that you specify a folder and file type (mask) that you want to detect on the input connector side and the destination / subject / message on the output side.

Rather than putting email addresses in the middleware config directly the output map lets you specify a distribution list
<emailListID>PDF</emailListID>
The email addressed associated with the emailListID are held in the email.xml configuration file. See [[Email Configuration]] for additional information on this file.

=EMAIL Settings=
'''email.xml'''
<?xml version="1.0" encoding="UTF-8"?>
<emailSettings>
<configuration>
<property name="mail.smtp.auth" value="true"/>
<property name="mail.smtp.starttls.enable" value="true"/>
<property name="mail.smtp.host" value="smtp.gmail.com"/>
<property name="mail.smtp.socketFactory.port" value="465"/>
<property name="mail.smtp.user" value="dummy@gmail.com"/>
<property name="mail.smtp.password" value="mycomplexpassword"/>
<property name="mail.smtp.socketFactory.class" value="javax.net.ssl.SSLSocketFactory"/>
<property name="mail.smtp.auth" value="true"/>
<property name="mail.smtp.port" value="465"/>
<property name="mail.smtp.from" value="dummy@gmail.com"/>
</configuration>
<distributionList id="Monitor" enabled="Y" maxFrequencyMins="0">
<toAddressList>dummy@gmail.com</toAddressList>
</distributionList>
<distributionList id="Error" enabled="Y" maxFrequencyMins="5">
<toAddressList>dummy@gmail.com</toAddressList>
</distributionList>
<distributionList id="Excel" enabled="Y" maxFrequencyMins="5">
<toAddressList>dummy@gmail.com</toAddressList>
</distributionList>
<distributionList id="PDF" enabled="Y" maxFrequencyMins="5">
<toAddressList>dummy@gmail.com</toAddressList>
</distributionList>
</emailSettings>

You will see there are several '''distributionList''' entries above and you can create new ones if you want. Each section has the following attributes.

Some of these lists have a "standard" purpose and should not be deleted or renamed.

'''Monitor''' is used to send daily statistics on the number of messages processed. It will also email you to say if the Middleware service stops or starts.

'''Error''' - as it's name suggests will inform you of any errors encountered, such as a network share becoming unavailable.

=Distribution List Settings=
| Element | Value | Description |
| - |- | :- |
| id | id | A identification which can be used in a mapping file. The email.xml can have multiple distribution lists but each one must have a unique id.|
| description | string | Meaningfull description of what the distribution list is for. |
| enabled | Y or N | A simple way to disable or enable a list. |
| maxFrequencyMins | nnn | Number of minutes between identical emails. This can prevent or limit the number of emails which can be sent due to a persistent error condition. |
| toAddressList | email | Email addresses separated with a comma |

=Example Email Settings=

<configuration>
<property name="mail.smtp.starttls.enable" value="false"/>
<property name="mail.smtp.host" value="smtp.demo.com"/>
<property name="mail.smtp.socketFactory.port" value="25"/>
<property name="mail.smtp.user" value="demo@email.com"/>
<property name="mail.smtp.password" value=""/>
<property name="mail.smtp.socketFactory.class" value="javax.net.ssl.SSLSocketFactory"/>
<property name="mail.smtp.auth" value="false"/>
<property name="mail.smtp.port" value="25"/>
<property name="mail.smtp.from" value="demo@email.com"/>
<property name="mail.debug" value="true"/>
</configuration>


<configuration0>
<property name="mail.smtp.auth" value="true"/>
<property name="mail.smtp.starttls.enable" value="true"/>
<property name="mail.smtp.host" value="smtp.live.com"/>
<property name="mail.smtp.socketFactory.port" value="25"/>
<property name="mail.smtp.user" value="email@outlook.com"/>
<property name="mail.smtp.password" value="mycomplexpassword"/>
<property name="mail.smtp.socketFactory.class" value="javax.net.ssl.SSLSocketFactory"/>
<property name="mail.smtp.auth" value="true"/>
<property name="mail.smtp.port" value="25"/>
<property name="mail.smtp.from" value="email@outlook.com"/>
<property name="mail.debug" value="true"/>
</configuration0>


<configuration1>
<property name="mail.smtp.auth" value="true"/>
<property name="mail.smtp.starttls.enable" value="true"/>
<property name="mail.smtp.host" value="smtp.gmail.com"/>
<property name="mail.smtp.socketFactory.port" value="465"/>
<property name="mail.smtp.user" value="email@gmail.com"/>
<property name="mail.smtp.password" value="mycomplexpassword"/>
<property name="mail.smtp.socketFactory.class" value="javax.net.ssl.SSLSocketFactory"/>
<property name="mail.smtp.auth" value="true"/>
<property name="mail.smtp.port" value="465"/>
<property name="mail.smtp.from" value="email@gmail.com"/>
<property name="mail.debug" value="true"/>
</configuration1>