Home Explore Help
Sign In
Banana
/
insipid
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: develop
Branches Tags
insipid
/
documentation
/
email-importer.txt

email-importer.txt 2.3 KB
Permalink History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 
  1. Insipid has a feature to fetch new links from E-Mails.
    2. 

  2. Those E-Mails are read from a configured IMAP mailbox.
    3. 

  3. 

  4. # Requirements
    5. 

  5. You need to enable the imap/ssl functions within PHP and
    6. 

  6. have a IMAP mailbox on a SSL/TLS email server.
    7. 

  7. 

  8. # Config
    9. 

  9. Set the config variables in the config file.
    10. 

  10. Make sure you an individual marker string!
    11. 

  11. There is no "security" within this method. Only the special string you can define.
    12. 

  12. The new links will be hidden at first. You need to verify them before they are
    13. 

  13. visible in your list.
    14. 

  14. 

  15. Here are the important configs:
    16. 

  16. 

  17. EMAIL_SERVER => Address of your E-Mail server
    18. 

  18. EMAIL_SERVER_PORT_IMAP => The SSL Imap port. Default: 993
    19. 

  19. EMAIL_SERVER_MAILBOX => The name of your Inbox. Default: INBOX
    20. 

  20. EMAIL_ARCHIVE_FOLDER => The name of the archive folder in which the processed emails will be moved
    21. 

  21. 

  22. EMAIL_REPORT_BACK => set this to true if you want to report to the sender. Default: false
    23. 

  23. EMAIL_SERVER_PORT_SMTP => The SSL SMTP port for using the report back function. Default: 465
    24. 

  24. EMAIL_REPLY_BACK_VALID => Multiple E-Mails addresses which can be reported back to. RFC822-style comma-separated email addresses
    25. 

  25. EMAIL_REPLY_BACK_ADDRESS => The E-Mail address which sends the report mail. Usually the address from which your read the mails
    26. 

  26. 

  27. # Moderation
    28. 

  28. Access the moderation with this link: index.php?p=stats
    29. 

  29. After authentication there will be more info and one called Moderation
    30. 

  30. 

  31. # Usage
    32. 

  32. Syntax of the E-Mail body:
    33. 

  33. 

  34. absolute-link|multiple,category,strings|multiple,tag,strings\n
    35. 

  35. new-absolute-link|multiple,category,strings|multiple,tag,strings\n
    36. 

  36. 

  37. Create a cronjob to execute the email-import.php file.
    38. 

  38. 

  39. # Access and "protection"
    40. 

  40. If the file needs to be in a web accessible folder you can either use the provided htaccess file
    41. 

  41. or active the "protection" with a secret given by URL / cli param.
    42. 

  42. If you activate EMAIL_JOB_PROTECT you NEED to set an individual string in EMAIL_JOB_PROTECT_SECRET
    43. 

  43. AND remove the provided .htaccess file in the job folder.
    44. 

  44. 

  45. cli: php email-import.php ----hiddenSouce=EMAIL_JOB_PROTECT_SECRET
    46. 

  46. webaccess: email-import.php?hiddenSouce=EMAIL_JOB_PROTECT_SECRET
    47. 

  47. 

  48. Use the following settings in the config file:
    49. 

  49. define('EMAIL_JOB_PROTECT', false); => Set to true if you want this kind of "protection"
    50. 

  50. define('EMAIL_JOB_PROTECT_SECRET', 'YOUR_SOME_SECRET_STRING'); => Change to your liking
    51.