notify_signers

Notification mail, when a signature request is created for users who have signatures in the document.

If a signatureOrder is defined and the creator has signatures in the document and is not on position 1, he will receive the email when it’s his turn.

observer

Pendant to the nofity_signers mail for an observer.

signature_request_failed

Notification mail, when a signature request failed.

If a signatureOrder is defined, a user only receives a signature_request_failed email, when he is on or below the active signatureOrder position.

signature_request_upcoming_due

Reminder mail sent three days before the due date of a signature request.

If a signatureOrder is defined, a user only receives a signature_request_upcoming_due mail, when he is on or below the active signatureOrder position.

user_finished

Notification that a user has signed/rejected all his signature fields in a document.

If the config mail_sent_to_registered_users is true, also registered users who are not creators receive the notification.

signature_request_finished

This email i sent when a document is finished.

If the document is part of an envelope, no notification for single documents are sent, but an signature_request_envelope_completed mail is sent when all documents in the envelope are completed (see below).

notify_signers_envelope

If a signatureOrder is defined and the creator has signatures in the document and is not on position 1, he will receive the email when it’s his turn.

If an envelope is created via tyrservice, no notify_signers mails for the individual documents are sent.

observer_envelope

Pendant to notify_signers_envelope mail for an observer.

If the envelope was created via tyrservice, no document observer mail (“observer”) will be sent for the documents of the envelope.

signature_request_envelop_upcoming_due

Reminder mail sent three days before the due date of the signature requests in an envelope.

If a signatureOrder is defined, a user only receives a signature_request_envelop_upcoming_

due email, when he is on or below the active signatureOrder position.

signature_request_envelope_completed

Sent when all signature requests in an envelope are completed (failed or finished)

notify_signers

A notify_signers email is sent, when a signature request is created or when the tyrservice method resendNotifySigner is called. In that case signatureOrder will be ignored and the email will be sent even if it is excluded.

Information:

• sender: creator of document

• receiver: signer of document

• document

sent to:

• w/o signature order: all users with signatures in document except the creator

• with signature order: all users (including the document creator) receive the email when they are on the active signature order position.

please note: If an envelope is created via the UI, all users receive notify_signers emails and a notify_signers_envelope email. If an envelope is created via tyrservice, only notify_signers_envelope emails are sent.

please note: If the signature request was created via UI and a guest signer was invited, no notify_signers email will be send for that user. An invitation mail with a link to the registration page will be sent. The user can just sign the document, if he registers for websignatureoffice.

observer

Notification mail for an observer of a document. The observer can be set in UI signatureRequest creation or via tyrservice.

Information:

• sender: creator of document

• receiver: observer of document

• document

sent to:

• all user which are document observers

please note: If an envelope is created via the UI, all observer receive observer emails and a observer_envelope email. If an envelope is created via tyrservice, only observer emails are sent.

signature_request_failed

A signature_request_failed message is send to all users of a document if it failed because mandatory fields were rejected, the request was stopped or the due date passed.

Information:

• receiver

• document

• reason: rejected/stopped/overdue

• statusId

• statusDetailedId

sent to:

• all signatories: depending on signatureOrder

• all observer

• the creator

signature_request_finished

A signature_request_finished mail is when the signature request of a document is finished.

Information:

• receiver

• document

sent to:

• all signatories: depending on signatureorder

• observer

• creator

signature_request_upcoming_due

A signature_request_upcoming_due mail is send three days before the due date passes.

Information:

• receiver

• document

sent to:

• all signatories

• creator

user_finished

A user_finished mail is sent, if a user finished all signatures in the document

Information:

• receiver

• sender: the user who finished his/her request

• document

sent to:

• creator of the document

signature_field_signed

A signature_field_signed email is send to registered users if another user signed a signaturefield

Information:

• sender: signer of the signaturefield

• receiver

• document

sent to:

• the creator of the document

please note: This email is sent for every signed signature field and may lead to allot of emails. It is advised to deactivate it. See Server configuration below.

signature_field_rejected

A signature_field_rejected email is sent to registered users if another user rejects a signature field in the document

Information:

• sender: the user who rejected the field

• receiver

• document

• reason: optional reason which the rejecting user can enter

• mandatory: 1/0 information if the signaturefield is mandatory or optional

sent to:

• the creator

notify_signers_envelope

A notify_signers_envelope mail is sent when an envelope is created or when the tyrservice method resendNotifySignerEnvelope is called. In that case signatureOrder will be ignored and the email will be sent even if it is excluded.

Information:

• sender: the creator of the envelope

• receiver: the users who have signatures in one or more documents of the envelope

• envelope

sent to:

• w/o signature order: all signers except the creator

• with signature order: all signers including the creator when they are on the active signature order position

please note: If an envelope is created via the UI, all users receive notify_signers emails and a notify_signers_envelope email. If an envelope is created via tyrservice, only notify_signers_envelope emails are sent.

observer_envelope

An observer_envelope mail is sent when an envelope is created.

Information:

• sender: the creator of the envelope

• receiver: the observer of the envelope

• envelope

sent to:

• all envelope observer

please note: If an envelope is created via the UI, all observer receive observer emails and a observer_envelope email. If an envelope is created via tyrservice, only observer emails are sent.

signature_request_envelop_upcoming_due

A signature_request_envelope_upcoming_due email is sent when one signature request of the envelope is due in three days.

Information:

• receiver: signer of the envelope

• envelope

sent to:

• all envelope users (even if they already signed)

signature_request_envelope_completed

A signature_request_envelope_completed email is sent, when all signature requests of an envelope are either failed or finished.

Information:

• receiver

• envelope

sent to:

• creator

• signatories

• envelope observer

invitation

An invitation mail is sent to a non registered user, when a registered user invites. This can be done when creating a signature request or by inviting the user as a contact.

Information:

• sender: The inviting user / signature request creator

• receiver: The invited user

• document (optional)

• invitationUrl: Link to the registration page

• message: message entered by inviting user

sent to:

• specified invited user

Please note: If the invitation is sent with a signature request no notify_signers mail will be sent to the user. The document information are contained in the invitation mail.

invitation_accepted

An invitation accepted mail is sent when a user accepts an invitation which was sent by another user.

Information:

• receiver: The user who invited

• sender: The user who accepted the invitation

sent to:

• the user who invited

friend

A friend mail is sent, when a user requests another registered user as a contact.

Information:

• receiver

• sender

• url: The Url to accept the friend request

sent to:

• user who was requested as friend

friend_accepted

A friend_accepted email is sent when a registered user accepts a friend request

Information:

• receiver: The user who requested the user user

• sender: The user who accepted the friend request

sent to:

• the user who sent the friend request

email_validation

An email validation mail is sent when a user registers at websignatureoffice. The user has to confirm the email adress by clicking the verification link and entering the token.

Information:

• receiver

• token: One time token to confirm the email change

• verificationUrl: The url to enter the token

• verificationUrlWithToken: Confirmation link with token attached

sent to:

• user who started the validation process

password_reset

A password_reset email is sent, when a user forgot his/her password and wants to set a new one.

Information:

• receiver

• token: password reset token

• urlWithToken: password reset url with token and locale (de/en)

• url: password reset url without token and locale (de/en)

sent to:

• user who changes his/her password

registration

A registration mail is send after a registered user registered a user via tyrservice or usermanagement. The email contains a link and token to verify the email address.

Information:

• sender: the user who registered the other user

• receiver: the registered user

• url: verification url

• token: verification token

sent to:

• registered user

notify_account_charge

Notification when a user account was charged by an admin user.

Information:

• sender: The admin user who charged the account

• receiver: admin_email_notifier

• account_user: The user whos account was charged

• amount: The credits that were charged

sent to:

• all email adresses / users defined in server config “admin_email_notifier”

support

A support email is sent when a user writes a message int the support form. The support email contains the message the user entered and is a confirmation that the support request was received.

The support form is located at

• baseurl/kontakt.

• baseurl/en/contact

• baseurl/it/contatto

• baseurl/es/contacto

• baseurl/us/contact

Information:

• receiver: The user who used the support form

• message: The message entered

• message_type: the support type chosen in the support form

sent to:

• the user who requested support

message_type can be

• support technical

• support sales

• support invoice

• support other

Please note: As a person who requests support my not have an account, the receiver.id may not be present.

support_internal

A support email is sent when a user writes a message int the support form. It is send to the support of the company. The emails are defined in the server config “support_email”

Information:

• sender: The user who entered the support form

• receiver: support team

• message

• message_type (see above)

sent to:

• all emails defined in server config “support_email”

emailFrom

system@webSignatureOffice.com

the from mail header added to emails sent by the system

emailPort

25

the smtp port

emailRetries

5

how many times the mailer retries to sent an email. Default 3.

emailSmtp

hostname.domain or "false"

the smtp server used to sent mails. If set to "false", sending mails will be deactivated entirely.

emailSmtpPassword

password

the smtp server password

emailSmtpUser

smtpuser

the login for the smtp server

emailTls

false

true or false, enable or disable TLS (encryption)

support_email

support@websignatureoffice.com

the email address for support notifications / inquiries

as described in support emails above.

admin_email_notifier

foo@host.com;bar@host.com

a list of recipients who are informed when accounts are charged with help of the admin functions or when user bought credits

as described system emails above

mail_excluded_type

signature_field_signed;notify_signers

semicolon seperated list of email types which should be excluded. All mail types can be excluded.

mail_html_only

true/false

If true only html mails are send

If false also text mails are send.

Default is false.

mail_sent_to_registered_users

signature_field_signed;user_finished

semicolin seperated list of mailtypes.

Possible mailtypes:

• signature_field_signed

• signature_field_rejected

• user_finished

By default the mails are only sent to the creator of the document/envelope.

Mail types defined in mail_sent_to_registered_users will be sent to every registered/active user associated with the document/envelope.

This setting may be used, if all documents are uploaded via tyrservice with one user but the employees have registered users.

sms_auth

A onetime token to open a SMS protected envelope or document

Fields

• time: The time the SMS was sent

• token: Token that must be entered to open the document / envelope

• locale: The locale of the user (e.g. “de”)

Your token for the webSignatureOffice process from ${time} is: ${token}

mail_type_id: 101

sms_document_link

A shortened URL to a standalone document viewer (TimeLimitedDocumentViewer). The SMS when signing synchrone remote with SMS link.

Fields

• time: The time the SMS was sent

• adhocurl: The URL to the document

• locale: The locale of the user (e.g. “de”)

Your document link is: ${adhocurl}

mail_type_id: 103

sms_verification

Used to verify the mobile number of registered users.

Fields

• time: The time the SMS was sent

• token: Token to verify the mobile number

• verificationUrl: URL for number verification

• locale: The locale of the user (e.g. “de”)

webSignatureOffice token: ${token} please confirm at ${verificationUrl}?locale=${locale}&t=${token}

mail_type_id: 102

sms_token_characters

alphanumerical_casesensitive

Defines which characters are used in an sms_auth SMS. Possible values

• alphanumerical_casesensitive: numbers, upper case and lower case letters

• numerical: only numbers

• alphanumerical: numbers and upper case letters. The validation of the token is not case sensitive.

Default is alphanumerical_casesensitive

sms_token_length

6

The length of the sms token. Default is 6.

smsUserId

UserId for the SMS Provider.

smsSender

Stepover

Name of the SMS sender shown on the mobile device.

authToken

Authentification token for the SMS provider.

smsPassword

Password for the SMS provider.

credit_sms_identification

1

Cost of user SMS identification in credits.