.\" Man page generated from reStructuredText.
.
.TH "GAMMU-SMSBACKUP" "5" "Oct 03, 2020" "1.42.0" "Gammu"
.SH NAME
gammu-smsbackup \- gammu(1) SMS backup file format.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.sp
The SMS backup format is text file encoded in current encoding of platform
where Gammu is running.
.sp
This file use ini file syntax, see ini\&.
.SH SECTIONS
.sp
The file consists of sections, whose name starts with \fBSMSBackup\fP\&. When
creating the backup file, three digits are appended to this text defining
order. While reading the backup, any part after \fBSMSBackup\fP text is ignored
and everything which begins with this is processed. So you can as well give
the section name \fBSMSBackupFoo\fP and it will be processed.
.sp
The number of messages in backup file is currently limited by
\fBGSM_BACKUP_MAX_SMS\fP (100000 at time of writing this document).
.SS \fBSMSBackup\fP section
.sp
Each section interprets one physical SMS message (eg. one message part in case
of multipart messages).
.SS Decoded text
.sp
For SMS backups created by Gammu, there is a decoded text as a comment just
after the section name:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[SMSBackup001]
; This is message text
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The text can be split to more lines if it is too long or of original message
included new lines.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is easiest way to get message text, however also the least reliable
one, because it is stored in the comments in the file.
.UNINDENT
.UNINDENT
.SS Variables
.sp
The following variables can be defined for each SMS:
.INDENT 0.0
.TP
.B \fBSMSC\fP
Text representation of SMSC number, not used by Gammu if \fBSMSCUnicode\fP
exists.
.TP
.B \fBSMSCUnicode\fP
Hex encoded UCS\-2 string with SMSC number.
.TP
.B \fBClass\fP
Message class.
.TP
.B \fBSent\fP
Timestamp, when message has been sent.
.TP
.B \fBPDU\fP
Message type, one of:
.INDENT 7.0
.IP \(bu 2
\fBDeliver\fP \- received message
.IP \(bu 2
\fBSubmit\fP \- message to send
.IP \(bu 2
\fBStatus_Report\fP \- message to send with delivery report
.UNINDENT
.TP
.B \fBDateTime\fP
Timestamp of message (sent or received).
.TP
.B \fBRejectDuplicates\fP
Whether receiver should reject duplicates.
.TP
.B \fBReplaceMessage\fP
ID of message to replace.
.TP
.B \fBMessageReference\fP
Message reference number as generated by network.
.TP
.B \fBState\fP
State of the message:
.INDENT 7.0
.IP \(bu 2
\fBRead\fP
.IP \(bu 2
\fBUnRead\fP
.IP \(bu 2
\fBSent\fP
.IP \(bu 2
\fBUnSent\fP
.UNINDENT
.TP
.B \fBNumber\fP
Recipient number.
.TP
.B \fBName\fP
Name of the message.
.TP
.B \fBLength\fP
Length of message text.
.TP
.B \fBCoding\fP
Coding of the message:
.INDENT 7.0
.IP \(bu 2
\fB8bit\fP \- binary message
.IP \(bu 2
\fBDefault\fP \- GSM encoding, up to 160 chars in message
.IP \(bu 2
\fBUnicode\fP \- Unicode encoding, up to 70 chars in message
.UNINDENT
.TP
.B \fBText00\fP ... \fBTextNN\fP
Numbered parts of the message payload.
.TP
.B \fBFolder\fP
ID of folder where the message was saved.
.TP
.B \fBUDH\fP
User defined header of the message.
.UNINDENT
.SH EXAMPLE
.sp
The backup of message can look like following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[SMSBackup000]
#ABCDEFGHIJKLMNOPQRSTUVWXYZ
#
SMSC = "+4540590000"
SMSCUnicode = 002B0034003500340030003500390030003000300030
Sent = 20021201T025023
State = UnRead
Number = "+4522706947"
NumberUnicode = 002B0034003500320032003700300036003900340037
Name = ""
NameUnicode =
Text00 = 004100420043004400450046004700480049004A004B004C004D004E004F0050005100520053005400550056005700580059005A000A
Coding = Default
Folder = 1
Length = 27
Class = \-1
ReplySMSC = False
RejectDuplicates = True
ReplaceMessage = 0
MessageReference = 0
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHOR
Michal Čihař <michal@cihar.com>
.SH COPYRIGHT
2009-2015, Michal Čihař <michal@cihar.com>
.\" Generated by docutils manpage writer.
.