rmoriz/onlinebrief24

Physical delivery of your PDF files. (PDF-to-Snail-Mail)

Onlinebrief24

This gem is interesting for users of the German letter outbound service Onlinebrief24.de. This gem wraps the required workflow to upload a PDF to Onlinebrief24's servers. Onlinebrief24 then prints and mails the letters via snail mail. As this service is only available to German customers, the following documentation is available in German language only.

Voraussetzung

Ruby 1.9.2 oder neuer.

Installation

Über Bundler im Gemfile hinzufügen:

gem 'onlinebrief24'

…dann auf der Shell Bundler das Gem installieren lassen:

$ bundle

…oder global mit:

$ gem install onlinebrief24

Beispiele

require 'onlinebrief24'

c = Onlinebrief24::Client.new :login => 'email@example.com', :password => '123456'

c.upload! '/tmp/filename1.pdf', :duplex     => true,       :color        => false
c.upload! '/tmp/filename2.pdf', :registered => :insertion, :envelope     => :c4
c.upload! '/tmp/filename3.pdf', :registered => :standard,  :distribution => :international

c.disconnect

Block

require 'onlinebrief24'

Onlinebrief24::Client.new(:login => 'email@example.com', :password => '123456') do |client|
  client.upload! '/tmp/filename1.pdf', :duplex     => true,       :color        => false
  client.upload! '/tmp/filename2.pdf', :registered => :insertion, :envelope     => :c4
  client.upload! '/tmp/filename3.pdf', :registered => :standard,  :distribution => :international
end

Optionen für Brief

Option	Werte	Vorbelegung	Beschreibung
:color	true false	false	Farbdruck ja/nein
:duplex	true false	false	Duplexdruck ja/nein
:envelope	:din_lang :c4	:din_lang	Umschlagformat. DIN lang oder C4.
:distribution	:auto :national :international	:auto	Versandzone. Automatisch, National, International
:registered	:none :insertion :standard :personal	:none	Einschreiben: Nein, Einwurf-Einschreiben, Standard-Einschreiben, Einschreiben eigenhändig

Hinweis

• PDF-Dateien müssen unter Beachtung der Vorgaben von Onlinebrief24 erstellt und formatiert werden: http://www.onlinebrief24.de/software/infodokumente.htm
• Dieses gem benutzt die SFTP-Schnittstelle: http://www.onlinebrief24.de/software/sftp-schnittstelle.htm

Ausprobieren / Keine Funktionsgarantie!

Onlinebrief24 räumt aktuell (Stand Januar 2013) jedem Neukunden ein Guthaben von 5 EUR ein. Es wird empfohlen die Benutzung dieses rubygems damit zu testen. Die vorhandenen Tests (RSpec) im spec-Verzeichnis können dies nicht ersetzen!

Fehler? Probleme? Patches?

Bitte Fehler, Probeme und Patches über Github Issues bzw Pull-Requests einreichen.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Hinweis

Dies ist ein unabhängiges OpenSource-Projekt und kein offizielles Produkt von Onlinebrief24.de.

Copyright

Licensed under the MIT license.

Copyright © 2013 Roland Moriz, Moriz GmbH