rvicemix.servicemix-mail.2013.01.source-code.servicemix-mail.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of servicemix-mail Show documentation
Show all versions of servicemix-mail Show documentation
Mail Binding Component used for polling and sending mails.
The newest version!
Specifies a java.util.Map which may contain additional
properties for the connection.
Example for disabling TOP for POP3 headers:
key: "mail.pop3.disabletop"
value: "true"
The default value is null
]]>
With this method you can specify a marshaler class which provides the
logic for converting a mail into a normalized message. This class has
to extend the abstract class AbstractMailMarshaler or an
extending class. If you don't specify a marshaler, the
DefaultMailMarshaler will be used.
]]>
Sets a custom scheduler implementation if you need more fine-grained control over the polling schedule.
]]>
Specifies a org.apache.servicemix.store.Store object which
will be used for storing the identifications of already processed messages.
This store is only used with the POP3 protocol and if unseen mails are
processed only.
The default value is null
]]>
Sets whether more than one poll can be active at a time (true means yes). Default value is false.
]]>
Specifies the connection URI used to connect to a mail server.
Templates:
<protocol>://<user>@<host>[:<port>][/<folder>]?password=<password>
OR
<protocol>://<host>[:<port>][/<folder>]?user=<user>;password=<password>
Details:
Name
Description
protocol
the protocol to use (example: pop3 or imap)
user
the user name used to log into an account
host
the name or ip address of the mail server
port
the port number to use (optional)
folder
the folder to poll from (optional)
password
the password for the login
Examples:
imap://lhein@imapserver:143/INBOX?password=mypass
pop3://pop3server/[email protected];password=mypass
The default value is null
]]>
Specifies a java.util.Map which may contain additional
properties for the connection.
Example for disabling TOP for POP3 headers:
key: "mail.pop3.disabletop"
value: "true"
The default value is null
]]>
Specifies one or more trust manager classes separated by a semicolon (;).
These classes have to implement the Trustmanager interface and need to provide
an empty default constructor to be valid.
If you want to accept all security certificates without a check you may
consider using the DummyTrustManager class. It is actually only
an empty stub without any checking logic.
But be aware that this will be
a security risk in production environments.
The default value is null
]]>
Specifies if the JavaMail is run in DEBUG mode. This means
that while connecting to server and processing mails a detailed log
is written to debug output.
This mode is very handy if you are experiencing problems with your
mail server connection and you want to find out what is going wrong
in communication with the server.
true - the debug mode is enabled
false - the debug mode is disabled
The default value is false
]]>
Sets the amount of time in milliseconds that the endpoint should wait before making the first poll.
]]>
This flag is used to indicate what happens to a processed mail polled
from a mail folder. If it is set to true the mail will
be deleted after it was sent into the bus successfully. If set to
false the mail will reside inside the mail folder but will
be marked as already seen.
If the sending of the mail results in an error, the mail will not be
deleted / marked and reprocessed on next run of the polling cycle.
The default value is false
]]>
Get the endpoint implementation.
]]>
Sets the date on which the first poll will be executed. If a delay is
also set using setDelay, the delay interval will be added
after the date specified.
]]>
Get the qualified name of the endpoint interface.
]]>
With this method you can specify a marshaler class which provides the
logic for converting a mail into a normalized message. This class has
to extend the abstract class AbstractMailMarshaler or an
extending class. If you don't specify a marshaler, the
DefaultMailMarshaler will be used.
]]>
This sets the maximum amount of mails to process within one polling cycle.
If the maximum amount is reached all other mails in "unseen" state will
be skipped.
The default value is -1 (unlimited)
]]>
Sets the number of milliseconds between polling attempts.
]]>
This flag is used to indicate whether all mails are polled from a
mail folder or only the unseen mails are processed.
If it is set to true only the unseen mails will be
processed.
If it is set to false all mails will be processed.
The default value is true
]]>
Sets a custom scheduler implementation if you need more fine-grained control over the polling schedule.
]]>
Get the service qualified name of the endpoint.
]]>
Specifies a org.apache.servicemix.store.Store object which
will be used for storing the identifications of already processed messages.
This store is only used with the POP3 protocol and if unseen mails are
processed only.
The default value is null
]]>
Gets the target URI of the consumer endpoint.
]]>
Specifies a java.util.Map which may contain additional
properties for the connection.
Example for disabling TOP for POP3 headers:
key: "mail.pop3.disabletop"
value: "true"
The default value is null
]]>
Specifies a java.util.List which may contain message
properties to skip.
Example for skipping all kind of addresses from the normalized message:
value: "org.apache.servicemix.mail.to"
value: "org.apache.servicemix.mail.cc"
value: "org.apache.servicemix.mail.bcc"
value: "org.apache.servicemix.mail.from"
value: "org.apache.servicemix.mail.replyto"
The default value is null
]]>
With this method you can specify a marshaler class which provides the
logic for converting a normalized message into a mail. This class has
to extend the abstract class AbstractMailMarshaler or an
extending class. If you don't specify a marshaler, the
DefaultMailMarshaler will be used.
]]>
Specifies the connection URI used to connect to a mail server.
Templates:
<protocol>://<user>@<host>[:<port>][/<folder>]?password=<password>
OR
<protocol>://<host>[:<port>][/<folder>]?user=<user>;password=<password>
Details:
Name
Description
protocol
the protocol to use (example: pop3 or imap)
user
the user name used to log into an account
host
the name or ip address of the mail server
port
the port number to use (optional)
folder
the folder to poll from (optional)
password
the password for the login
Example:
smtp://lhein@myserver?password=myPass
The default value is null
]]>
Specifies a java.util.Map which may contain additional
properties for the connection.
Example for disabling TOP for POP3 headers:
key: "mail.pop3.disabletop"
value: "true"
The default value is null
]]>
Specifies one or more trust manager classes separated by a semicolon (;).
These classes have to implement the Trustmanager interface and need to provide
an empty default constructor to be valid.
If you want to accept all security certificates without a check you may
consider using the DummyTrustManager class. It is actually only
an empty stub without any checking logic.
But be aware that this will be
a security risk in production environments.
The default value is null
]]>
Specifies if the JavaMail is run in DEBUG mode. This means
that while connecting to server and processing mails a detailed log
is written to debug output.
This mode is very handy if you are experiencing problems with your
mail server connection and you want to find out what is going wrong
in communication with the server.
true - the debug mode is enabled
false - the debug mode is disabled
The default value is false
]]>
Get the endpoint implementation.
]]>
Get the qualified name of the endpoint interface.
]]>
With this method you can specify a marshaler class which provides the
logic for converting a normalized message into a mail. This class has
to extend the abstract class AbstractMailMarshaler or an
extending class. If you don't specify a marshaler, the
DefaultMailMarshaler will be used.
]]>
Specifies the receiver address(es) of the mail which is being sent.
The default value is null
]]>
Specifies the sender address of the mail which is being sent.
The default value is no-reply@localhost
]]>
Get the service qualified name of the endpoint.
]]>
© 2015 - 2025 Weber Informatics LLC | Privacy Policy