Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added discussion of the inbound Mail support (INT-459)

Browse Source
This commit is contained in:
Mark Fisher
2008-11-14 01:03:07 +00:00
parent 42f21f3d6e
commit aded1d56df
1 changed files with 36 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
spring-integration-reference/src/mail.xml
View File

@@ -36,6 +36,26 @@
</para>
</section>
<section id="mail-inbound">
<title>Mail-Receiving Channel Adapter</title>
<para>
Spring Integration also provides support for inbound email with the
<classname>MailReceivingMessageSource</classname>. It delegates to a configured instance of Spring
Integration's own <interfacename>MailReceiver</interfacename> interface, and there are two implementations:
<classname>Pop3MailReceiver</classname> and <classname>ImapMailReceiver</classname>. The easiest way to
instantiate either of these is by passing the 'uri' for a Mail store to the receiver's constructor. For example:
<programlisting language="java"><![CDATA[ MailReceiver receiver = new Pop3MailReceiver("pop3://usr:pwd@localhost/INBOX");
]]></programlisting>
</para>
<para>
Another option for receiving mail is the IMAP "idle" command (if supported by the mail server you are using).
Spring Integration provides the <classname>ImapIdleChannelAdapter</classname> which is itself a Message-producing
endpoint. It delegates to an instance of the <classname>ImapMailReceiver</classname> but enables asynchronous
reception of Mail Messages. There are examples in the next section of configuring both types of inbound Channel
Adapter with Spring Integration's namespace support in the 'mail' schema.
</para>
</section>
<section id="mail-namespace">
<title>Mail Namespace Support</title>
<para>
@@ -61,6 +81,22 @@
&lt;poller&gt; sub-element should be provided with either an interval-trigger or cron-trigger.
</note>
</para>
<para>
To configure an inbound Channel Adapter, you have the choice between polling or event-driven (assuming your
mail server supports IMAP IDLE - if not, then polling is the only option). A polling Channel Adapter simply
requires the store URI and the channel to send inbound Messages to. The URI may begin with "pop3" or "imap":
<programlisting language="xml"><![CDATA[ <mail:inbound-channel-adapter channel="mailIn"
store-uri="imap://usr:pwd@imap.example.com/INBOX">
<poller max-messages-per-poll="3">
<interval-trigger interval="30" time-unit="SECONDS"/>
</poller>
</mail:inbound-channel-adapter>]]></programlisting>
If you do have IMAP idle support, then you may want to configure the "imap-idle-channel-adapter" element instead.
Since the "idle" command enables event-driven notifications, no poller is necessary for this adapter. It will
send a Message to the specified channel as soon as it receives the notification that new mail is available:
<programlisting language="xml"><![CDATA[ <mail:imap-idle-channel-adapter channel="mailIn"
store-uri="imaps://usr:pwd@imap.example.com:993/INBOX"/>]]></programlisting>
</para>
<para>
When using the namespace support, a <emphasis>header-enricher</emphasis> Message Transformer is also available.
This simplifies the application of the headers mentioned above to any Message prior to sending to the