Github user mattyb149 commented on a diff in the pull request:
https://github.com/apache/nifi/pull/710#discussion_r73769714
--- Diff:
nifi-nar-bundles/nifi-email-bundle/nifi-email-processors/src/main/resources/docs/org.apache.nifi.processors.email.ConsumeIMAP/additionalDetails.html
---
@@ -0,0 +1,60 @@
+<!DOCTYPE html>
+<html lang="en">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version
2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+<head>
+<meta charset="utf-8" />
+<title>ConsumeIMAP</title>
+<link rel="stylesheet" href="../../css/component-usage.css"
+ type="text/css" />
+</head>
+
+<body>
+ <!-- Processor Documentation
================================================== -->
+ <h2>Description:</h2>
+ <p>This Processors consumes email messages via IMAP protocol and
+ sends the content of an email message as content of the
FlowFile.
+ Content of the incoming email message is written as raw bytes
to the
+ content of the outgoing Flow File.
+ </p>
+
+ <p>Since different serves may require different Java Mail
+ properties such properties could be provided via dynamic
properties.
+ For example, below is a sample configuration for GMail:
+ </p>
+ <p>
+ <b>Processor's static properties:</b>
+ <ul>
+ <li><b>Host Name</b> - imap.gmail.com</li>
+ <li><b>Port</b> - 993</li>
+ <li><b>User Name</b> - <i>[your user name]</i></li>
+ <li><b>Password</b> - <i>[your password]</i></li>
+ <li><b>Folder</b> - INBOX</li>
+ </ul>
+ <b>Processor's dynamic properties:</b>
+ <ul>
+ <li><b>mail.imap.socketFactory.class</b> -
javax.net.ssl.SSLSocketFactory</li>
+ <li><b>mail.imap.socketFactory.fallback</b> - false</li>
+ <li><b>mail.store.protocol</b> - imaps</li>
--- End diff --
I get that the properties are often different for different services,
servers, etc. But is there something we can do with setting property defaults,
such as socket factory or protocol, for example if "Use secure" is true? If
dynamic properties are provided we'd use those, but if they were inadvertantly
left out then the defaults would be populated.
The idea here is that there's a "Use Secure" property, but then you have to
set the socket factory class to a secure factory, set the protocol to the
secure version, etc. If there aren't widely used services that *require* these
properties to be un-set, then I would think a better user experience would be
for the "Use Secure" to take care of as much of the Java Mail property config
as possible. Thoughts?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
